de.aristaflow.adept2.core.changeoperations

Class NodeDependencyProvider

java.lang.Object

de.aristaflow.adept2.core.changeoperations.NodeDependencyProvider

All Implemented Interfaces:

DependencyProvider

Direct Known Subclasses:

VolatileNodeDependencyProvider

public class NodeDependencyProvider
extends java.lang.Object
implements DependencyProvider

A default implementation of DependencyProvider that should be sufficient for most cases.

Author:

Patrick Schmidt

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,Dependency>	injectedDependencies injected parameters and their dependencies
protected Node	node node determining the context for the dependency provider
protected Template	template template determining the context for the dependency provider

Constructor Summary

Constructors

Constructor and Description
NodeDependencyProvider(Template template, int nodeID) Constructs a new NodeDependencyProvider for the specified process template and node.

Method Summary

Modifier and Type	Method and Description
Pair<ProcessConstants.AdeptDataType,java.lang.String>	getCompleteDataTypeOf(java.lang.String parameterName) Returns the data type (including the UDT name if appropriate) of the parameter with the specified name or null if the parameter does not exist.
Dependency	getDependencyOf(java.lang.String parameterName) Returns dependency-related information about the parameter with the specified name or null if the parameter has currently no dependency bound to it or the parameter does not exist.
java.util.Map<Dependency,java.lang.String>	getDependencyTypeArguments(java.lang.Object dependencyType, ProcessConstants.AdeptDataType dataType, java.lang.String udtName) The same as #getDependencyTypeArguments(Object, AdeptDataType, UUID) but restricting based on the designated UDT name instead of the identifier ID.
java.util.Map<Dependency,java.lang.String>	getDependencyTypeArguments(java.lang.Object dependencyType, ProcessConstants.AdeptDataType dataType, java.util.UUID identifierID) Returns all available dependencies for the specified dependency type in a map.
java.util.Map<java.lang.Object,java.lang.String>	getDependencyTypes(ProcessConstants.AdeptDataType dataType, java.util.UUID identifierID) Returns all available dependency types in a map.
java.lang.String	getLabelForArgument(Dependency dependency) Returns a label text for argument of the designated dependency.
java.lang.String	getLabelForType(java.lang.Object dependencyType) Returns a label text for the given dependency type.
java.lang.String	getLabelForTypeAndArgument(Dependency dependency) Returns a label text for the designated dependency.
java.util.Map<java.lang.String,Dependency>	getParameterBindings() Returns the parameter bindings, i.e. the dependency of each parameter in a map.
ParameterRef[]	getParameters() Returns all already existing parameters.
ParameterRef	getPreferredParameter(Dependency dependency) Returns the preferred parameter name and type for the specified dependency.
void	injectDependency(java.lang.String parameterName, Dependency dependency) Injects an additional parameter into this dependency provider.
boolean	parameterExists(java.lang.String parameterName) Returns whether a parameter with the specified name already exists.
void	removeInjectedDependency(java.lang.String parameterName) Removes an injected parameter with the specified name from this dependency provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

template

protected Template template

template determining the context for the dependency provider

node

protected final Node node

node determining the context for the dependency provider

injectedDependencies

protected final java.util.Map<java.lang.String,Dependency> injectedDependencies

injected parameters and their dependencies

Constructor Detail

NodeDependencyProvider

public NodeDependencyProvider(Template template,
                              int nodeID)

Constructs a new NodeDependencyProvider for the specified process template and node.

Parameters:

template - template determining the context for the dependency provider

nodeID - node determining the context for the dependency provider

Method Detail

getParameters

public ParameterRef[] getParameters()

Description copied from interface: DependencyProvider

Returns all already existing parameters. Use DependencyProvider.getDependencyOf(String) to retrieve dependency information about each parameter.

Specified by:

getParameters in interface DependencyProvider

Returns:

all already existing parameters

getParameterBindings

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

Returns the parameter bindings, i.e. the dependency of each parameter in a map. This is equivalent to calling getDependencyOf(String) for each parameter returned by getParameters().

Returns:

the parameter bindings, i.e. the dependency of each parameter in a map

parameterExists

public boolean parameterExists(java.lang.String parameterName)

Description copied from interface: DependencyProvider

Returns whether a parameter with the specified name already exists.

Specified by:

parameterExists in interface DependencyProvider

Parameters:

parameterName - name of the parameter to be looked for

Returns:

whether a parameter with the specified name already exists

getDependencyOf

public Dependency getDependencyOf(java.lang.String parameterName)

Description copied from interface: DependencyProvider

Returns dependency-related information about the parameter with the specified name or null if the parameter has currently no dependency bound to it or the parameter does not exist.

Specified by:

getDependencyOf in interface DependencyProvider

Parameters:

parameterName - the name of the parameter for which to return dependency-related information

Returns:

dependency-related information for the specified parameter

getCompleteDataTypeOf

public Pair<ProcessConstants.AdeptDataType,java.lang.String> getCompleteDataTypeOf(java.lang.String parameterName)

Description copied from interface: DependencyProvider

Returns the data type (including the UDT name if appropriate) of the parameter with the specified name or null if the parameter does not exist.

Specified by:

getCompleteDataTypeOf in interface DependencyProvider

Parameters:

parameterName - the name of the parameter for which to return dependency-related information

Returns:

The data type including the UDT name of the specified parameter. If the designated parameter does not exist, null will be returned. If the designated parameter is not ProcessConstants.AdeptDataType.USERDEFINED, the second element of the pair will be null.

getDependencyTypes

public java.util.Map<java.lang.Object,java.lang.String> getDependencyTypes(ProcessConstants.AdeptDataType dataType,
                                                                           java.util.UUID identifierID)

Description copied from interface: DependencyProvider

Returns all available dependency types in a map. This number of dependency types can optionally be limited by specifying a data type and (also optionally} an identifier ID.

The dependency types are represented by objects and used as keys in the maps. The value is a label text created by DependencyProvider.getLabelForType(Object).

The map should have a specific, consistent order (-> e.g. LinkedHashMap).

Specified by:

getDependencyTypes in interface DependencyProvider

Parameters:

dataType - data type to limit the number of returned dependency types; may be null for no restriction

identifierID - identifier ID to further limit the number of returned dependency types; may be null for no restriction

Returns:

all available dependency types in a map (matching the optionally specified data type and identifier ID)

getDependencyTypeArguments

public java.util.Map<Dependency,java.lang.String> getDependencyTypeArguments(java.lang.Object dependencyType,
                                                                             ProcessConstants.AdeptDataType dataType,
                                                                             java.util.UUID identifierID)

Description copied from interface: DependencyProvider

Returns all available dependencies for the specified dependency type in a map. The arguments are the dependencies while the value is a label text created by DependencyProvider.getLabelForType(Object).

If the dependency type does not need any arguments a singleton map with null as key is returned. If the returned map is empty this means that there are no valid arguments which basically renders the dependency type unusable in the current context.

The map should have a specific, consistent order (-> e.g. LinkedHashMap).

Specified by:

getDependencyTypeArguments in interface DependencyProvider

Parameters:

dependencyType - the dependency type for which to return available arguments

dataType - data type to limit the number of returned dependency type arguments

identifierID - identifier ID to further limit the number of returned dependency type arguments; may be null for no restriction

Returns:

all arguments for the specified dependency type in a map (matching the optionally specified data type and identifier ID)

getDependencyTypeArguments

public java.util.Map<Dependency,java.lang.String> getDependencyTypeArguments(java.lang.Object dependencyType,
                                                                             ProcessConstants.AdeptDataType dataType,
                                                                             java.lang.String udtName)

Description copied from interface: DependencyProvider

The same as #getDependencyTypeArguments(Object, AdeptDataType, UUID) but restricting based on the designated UDT name instead of the identifier ID.

Specified by:

getDependencyTypeArguments in interface DependencyProvider

Parameters:

dependencyType - The dependency type for which to return available arguments.

dataType - The data type to limit the number of returned dependency type arguments.

udtName - The name of the UDT (in case of a UDT) to limit the number of returned dependency type arguments. This may be null.

Returns:

All arguments for the specified dependency type in a map (matching the data type and UDT name).

getLabelForType

public java.lang.String getLabelForType(java.lang.Object dependencyType)

Description copied from interface: DependencyProvider

Returns a label text for the given dependency type.

Specified by:

getLabelForType in interface DependencyProvider

Parameters:

dependencyType - dependency type for which to return a label

Returns:

a label text for the given dependency type

getLabelForArgument

public java.lang.String getLabelForArgument(Dependency dependency)

Description copied from interface: DependencyProvider

Returns a label text for argument of the designated dependency.

Specified by:

getLabelForArgument in interface DependencyProvider

Parameters:

dependency - The dependency of which to receive a label of the argument.

Returns:

A label text for the argument of the designated dependency.

getLabelForTypeAndArgument

public java.lang.String getLabelForTypeAndArgument(Dependency dependency)

Description copied from interface: DependencyProvider

Returns a label text for the designated dependency.

Specified by:

getLabelForTypeAndArgument in interface DependencyProvider

Parameters:

dependency - the dependency for which to return a label

Returns:

a label text for the given dependency

getPreferredParameter

public ParameterRef getPreferredParameter(Dependency dependency)

Description copied from interface: DependencyProvider

Returns the preferred parameter name and type for the specified dependency. Each combination of dependency type and argument should have its own unique name. If a parameter for the dependency already exists, that parameter's name is returned instead, even if it doesn't have the preferred name. If the preferred name is already occupied by a parameter which is associated to a different dependency, a different parameter name is generated in a deterministic way.

Specified by:

getPreferredParameter in interface DependencyProvider

Parameters:

dependency - the dependency for which to return the preferred parameter name

Returns:

the preferred parameter name for the specified dependency

injectDependency

public void injectDependency(java.lang.String parameterName,
                             Dependency dependency)

Injects an additional parameter into this dependency provider. Usually existing parameters are queried from the template. Temporary parameters (like in the PnP/Node Wizard) that don't exist yet in the template can be added with this method.

Parameters:

parameterName - the name of the injected parameter

dependency - the dependency of the injected parameter

removeInjectedDependency

public void removeInjectedDependency(java.lang.String parameterName)

Removes an injected parameter with the specified name from this dependency provider.

Parameters:

parameterName - the name of the injected parameter