de.aristaflow.adept2.model.common.paramref

Class ParameterRef

java.lang.Object

de.aristaflow.adept2.model.common.paramref.ParameterRef

All Implemented Interfaces:

LocalisedString, java.io.Serializable

Direct Known Subclasses:

IOParameterRef

public class ParameterRef
extends java.lang.Object
implements java.io.Serializable, LocalisedString

Represents a reference to a parameter in the strings returned by SystemDataConsumers. These parameters are usually node parameters, but parameter references may be used in other contexts as well.

Instances of this class are usually created by one of the utility methods provided by SystemDataTools.

Author:

Patrick Schmidt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ProcessConstants.AdeptDataType	dataType The data type of the referenced parameter.
protected java.lang.String	name The name of the referenced parameter.
protected java.lang.String	udtName The name of the UDT or null in case it is not a UDT.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ParameterRef(ProcessConstants.AdeptDataType dataType, java.lang.String name) Creates a new parameter reference for a parameter of arbitrary data type except ProcessConstants.AdeptDataType.USERDEFINED.
	ParameterRef(java.lang.String name, ProcessConstants.AdeptDataType dataType, java.lang.String udtName) Constructs a new ParameterRef with the specified name, data type and name of UDT.
protected	ParameterRef(java.lang.String name, ProcessConstants.AdeptDataType dataType, java.lang.String udtName, boolean discriminator) Constructs a new ParameterRef with the specified name, data type and name of UDT.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
ProcessConstants.AdeptDataType	getDataType() Returns the data type of the referenced parameter.
java.lang.String	getName() Returns the name of the referenced parameter.
java.lang.String	getUdtName() The name of the user-defined type or null in case the parameter is not of user-defined type ore the name is not defined.
int	hashCode()
java.lang.String	toLocalisedString(LocalisationFactory locFac, java.util.Locale loc) Gets the localised representation of the implementing object.
java.lang.String	toString() Returns a string of the form %<typeId>:<parameterName>% as specified in SystemDataConsumer.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final java.lang.String name

The name of the referenced parameter.

dataType

protected final ProcessConstants.AdeptDataType dataType

The data type of the referenced parameter.

udtName

protected final java.lang.String udtName

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

Constructor Detail

ParameterRef

public ParameterRef(ProcessConstants.AdeptDataType dataType,
                    java.lang.String name)

Creates a new parameter reference for a parameter of arbitrary data type except ProcessConstants.AdeptDataType.USERDEFINED.

Parameters:

dataType - The type of the parameter of this reference.

name - The name of the parameter of this reference. This must not be null.

ParameterRef

public ParameterRef(java.lang.String name,
                    ProcessConstants.AdeptDataType dataType,
                    java.lang.String udtName)

Constructs a new ParameterRef with the specified name, data type and name of UDT.

Parameters:

name - The name of the referenced parameter. This must not be null or an empty or blank string.

dataType - The data type of the referenced parameter.

udtName - The name of the UDT in case it is a UDT and the name is known, null otherwise.

ParameterRef

protected ParameterRef(java.lang.String name,
                       ProcessConstants.AdeptDataType dataType,
                       java.lang.String udtName,
                       boolean discriminator)

Constructs a new ParameterRef with the specified name, data type and name of UDT.

Parameters:

name - The name of the referenced parameter. Subclasses can provide null.

dataType - The data type of the referenced parameter.

udtName - The name of the UDT in case it is a UDT and the name is known, null otherwise.

discriminator - An unused parameter to discriminate #ParameterRef(String, AdeptDataType, String).

Method Detail

getName

public java.lang.String getName()

Returns the name of the referenced parameter.

Returns:

the name of the referenced parameter

getDataType

public ProcessConstants.AdeptDataType getDataType()

Returns the data type of the referenced parameter.

Returns:

the data type of the referenced parameter

getUdtName

public java.lang.String getUdtName()

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

Returns:

The name of the user-defined type or null.

toString

public java.lang.String toString()

Returns a string of the form %<typeId>:<parameterName>% as specified in SystemDataConsumer.

Overrides:

toString in class java.lang.Object

toLocalisedString

public java.lang.String toLocalisedString(LocalisationFactory locFac,
                                          java.util.Locale loc)

Description copied from interface: LocalisedString

Gets the localised representation of the implementing object. The localisation should be for the designated locale, model objects being Localised should use the designated localisation factory for automatic localisation.

Specified by:

toLocalisedString in interface LocalisedString

Parameters:

locFac - The localisation factory to be used by Localised model objects. If this is null, do not localise the used Localised attributes.

loc - The locale for which to get the localised string. If this is null, treat it like Locale.ROOT has been requested.

Returns:

The localised (string) representation of the implementing object for the designated locale using the designated localisation factory if appropriate.

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