Package ai.libs.jaicore.components.model

Class ComponentInstance

java.lang.Object

ai.libs.jaicore.components.model.ComponentInstance

All Implemented Interfaces:

ai.libs.jaicore.basic.IAnnotatable, IComponentInstance, java.io.Serializable

public class ComponentInstance
extends java.lang.Object
implements IComponentInstance, java.io.Serializable

For a given Component, a Component Instance defines all parameter values and the required interfaces (recursively) and thus provides a grounding of the respective Component.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ComponentInstance(IComponent component, java.util.Map<java.lang.String,java.lang.String> parameterValues, java.util.Map<java.lang.String,java.util.List<IComponentInstance>> satisfactionOfRequiredInterfaces)	Constructor for creating a ComponentInstance for a particular Component.
ComponentInstance(ComponentInstance other)

Method Summary

Modifier and Type	Method	Description
void	appendAnnotation(java.lang.String key, java.lang.String annotation)
boolean	equals(java.lang.Object obj)
java.lang.String	getAnnotation(java.lang.String key)
IComponent	getComponent()
java.lang.String	getNestedComponentDescription()
java.util.Collection<IParameter>	getParametersThatHaveBeenSetExplicitly()
java.util.Collection<IParameter>	getParametersThatHaveNotBeenSetExplicitly()
java.lang.String	getParameterValue(IParameter param)
java.lang.String	getParameterValue(java.lang.String paramName)
java.util.Map<java.lang.String,java.lang.String>	getParameterValues()
java.lang.String	getPrettyPrint()	Returns the description of a ComponentInstance as a pretty print with indentation.
java.util.List<IComponentInstance>	getSatisfactionOfRequiredInterface(java.lang.String idOfRequiredInterface)
java.util.Map<java.lang.String,java.util.List<IComponentInstance>>	getSatisfactionOfRequiredInterfaces()
int	hashCode()
void	putAnnotation(java.lang.String key, java.lang.String annotation)
java.lang.String	toComponentNameString()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ComponentInstance

public ComponentInstance(ComponentInstance other)

ComponentInstance

public ComponentInstance(IComponent component,
                         java.util.Map<java.lang.String,java.lang.String> parameterValues,
                         java.util.Map<java.lang.String,java.util.List<IComponentInstance>> satisfactionOfRequiredInterfaces)

Constructor for creating a ComponentInstance for a particular Component.

Parameters:

component - The component that is grounded.

parameterValues - A map containing the parameter values of this grounding.

satisfactionOfRequiredInterfaces - The refinement of the required interfaces.

Method Detail

getComponent

public IComponent getComponent()

Specified by:

getComponent in interface IComponentInstance

Returns:

The Component to this ComponentInstance.

getParameterValues

public java.util.Map<java.lang.String,java.lang.String> getParameterValues()

Specified by:

getParameterValues in interface IComponentInstance

Returns:

The parameters and how their values were set.

getParametersThatHaveBeenSetExplicitly

public java.util.Collection<IParameter> getParametersThatHaveBeenSetExplicitly()

Specified by:

getParametersThatHaveBeenSetExplicitly in interface IComponentInstance

Returns:

The set of parameters of which the values have been set explicitly.

getParametersThatHaveNotBeenSetExplicitly

public java.util.Collection<IParameter> getParametersThatHaveNotBeenSetExplicitly()

Specified by:

getParametersThatHaveNotBeenSetExplicitly in interface IComponentInstance

Returns:

The set of parameters of which the values have not been set explicitly.

getParameterValue

public java.lang.String getParameterValue(IParameter param)

Specified by:

getParameterValue in interface IComponentInstance

Parameters:

param - The parameter for which the value shall be returned.

Returns:

The value of the parameter.

getParameterValue

public java.lang.String getParameterValue(java.lang.String paramName)

Specified by:

getParameterValue in interface IComponentInstance

Parameters:

paramName - The name of the parameter for which the value is requested.

Returns:

The value of the parameter with the given name.

getSatisfactionOfRequiredInterfaces

public java.util.Map<java.lang.String,java.util.List<IComponentInstance>> getSatisfactionOfRequiredInterfaces()

Specified by:

getSatisfactionOfRequiredInterfaces in interface IComponentInstance

Returns:

This method returns a mapping of interface IDs to component instances.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toComponentNameString

public java.lang.String toComponentNameString()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPrettyPrint

public java.lang.String getPrettyPrint()
                                throws java.io.IOException

Returns the description of a ComponentInstance as a pretty print with indentation.

Returns:

A string representing this object in JSON format.

Throws:

java.io.IOException - An IOException is thrown if the object cannot be serialized to a String.

getNestedComponentDescription

public java.lang.String getNestedComponentDescription()

putAnnotation

public void putAnnotation(java.lang.String key,
                          java.lang.String annotation)

Specified by:

putAnnotation in interface ai.libs.jaicore.basic.IAnnotatable

getAnnotation

public java.lang.String getAnnotation(java.lang.String key)

Specified by:

getAnnotation in interface ai.libs.jaicore.basic.IAnnotatable

appendAnnotation

public void appendAnnotation(java.lang.String key,
                             java.lang.String annotation)

Specified by:

appendAnnotation in interface ai.libs.jaicore.basic.IAnnotatable

getSatisfactionOfRequiredInterface

public java.util.List<IComponentInstance> getSatisfactionOfRequiredInterface(java.lang.String idOfRequiredInterface)

Specified by:

getSatisfactionOfRequiredInterface in interface IComponentInstance