de.aristaflow.adept2.model.processmodel.systemdata

Class Dependency

java.lang.Object

de.aristaflow.adept2.model.processmodel.systemdata.Dependency

public class Dependency
extends java.lang.Object

A Dependency object represents a concrete dependency of a SystemDataConsumer to a SystemDataProducer (a method of the process model providing system data) or a Dependency.SystemDataProvider (a normal data source providing system data). It encapsulates the dependency type (either an element of SystemDataProducer or an element of SystemDataProvider) and information on the object (the "argument" of the dependency) providing the the system data. The latter consists of an ID, a name, a data type and an identifier ID and usually represents a node and one of its (system) output parameters (the system data producer) or a data element (a system data provider).

Author:

Patrick Schmidt, Ulrich Kreher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dependency.SystemDataProvider This enumeration provides system data provider that "extend" SystemDataProducer, that is, both provide system data (for instance process relevant timestamps, agent IDs,...) but while system data producer represent methods from the process model, system data provider represent other data sources, for instance arbitrary data elements.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	argUdtName The name of the UDT of the argument of this dependency or null in case it is not a UDT.

Constructor Summary

Constructors

Constructor and Description
Dependency(DataElement dataElement) Constructs a new Dependency object for the designated data element being a Dependency.SystemDataProvider.
Dependency(SystemDataProducer type, int id, java.lang.String name) Creates a new dependency for the designated system data producer (type), the system data producer having the designated ID (usually a node ID) and the designated name (usually a node name).

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
ProcessConstants.AdeptDataType	getArgumentDataType() Gets the data type of the argument of this dependency.
int	getArgumentID() Gets the ID of the argument (the producer or provider) of this dependency.
java.util.UUID	getArgumentIdentifierID() Gets the identifer providing additional information on the data type of the argument of this dependency.
java.lang.String	getArgumentName() Gets the name of the argument which is the name of a node or a data element.
java.lang.String	getArgumentUdtName() The name of the user-defined type of the argument of this dependency or null in case the argument is not of user-defined type ore the name is not defined.
java.lang.Object	getType() Returns an object representing the type of this dependency.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

argUdtName

protected final java.lang.String argUdtName

The name of the UDT of the argument of this dependency or null in case it is not a UDT.

Constructor Detail

Dependency

public Dependency(DataElement dataElement)

Constructs a new Dependency object for the designated data element being a Dependency.SystemDataProvider.

Parameters:

dataElement - The data element for which to create a dependency as system data provider. This must not be null.

Dependency

public Dependency(SystemDataProducer type,
                  int id,
                  java.lang.String name)

Creates a new dependency for the designated system data producer (type), the system data producer having the designated ID (usually a node ID) and the designated name (usually a node name).

Parameters:

type - The system data producer type of the dependency to be created. This must not be null.

id - The ID of the system data producer entity (usually a node ID) of the dependency to be created.

name - The name of the system data producer entity (usually a node ID) of the dependency to be created. This must not be null but may be the empty string.

Method Detail

getType

public java.lang.Object getType()

Returns an object representing the type of this dependency. This is either an instance of SystemDataProducer or Dependency.SystemDataProvider. Depending on this type, the information on the argument of this dependency need to be interpreted accordingly, for instance as node or as data element.

Returns:

An object representing the type of this dependency which is either an instance of SystemDataProducer or Dependency.SystemDataProvider.

getArgumentID

public int getArgumentID()

Gets the ID of the argument (the producer or provider) of this dependency. This is either the ID of a node or of a data element depending on the type.

Returns:

The ID of the argument (the producer or provider) of this dependency. This is either the ID of a node or of a data element depending on the type.

getArgumentName

public java.lang.String getArgumentName()

Gets the name of the argument which is the name of a node or a data element.

Returns:

The name of the argument which is the name of a node or a data element. This can be the empty string.

getArgumentDataType

public ProcessConstants.AdeptDataType getArgumentDataType()

Gets the data type of the argument of this dependency.

Returns:

The data type of the argument of this dependency.

getArgumentUdtName

public java.lang.String getArgumentUdtName()

The name of the user-defined type of the argument of this dependency or null in case the argument is not of user-defined type ore the name is not defined.

Returns:

The name of the user-defined type of the argument of this dependency or null.

getArgumentIdentifierID

public java.util.UUID getArgumentIdentifierID()

Gets the identifer providing additional information on the data type of the argument of this dependency.

Returns:

The identifer providing additional information on the data type of the argument of this dependency.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object