wt.dataops.objectcol
Class InputValue

java.lang.Object
  wt.dataops.objectcol.InputValue

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class InputValue

extends Object

implements Persistable, Externalizable

Use the newInputValue static factory method(s), not the InputValue constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static String	CRITERION Label for the attribute.
static String	CRITERION_REFERENCE Label for the attribute.
private ObjectReference	criterionReference
static long	EXTERNALIZATION_VERSION_UID
static String	INPUT_TYPE Label for the attribute.
private static int	INPUT_TYPE_UPPER_LIMIT
private InputType	inputType
private String	name
static String	NAME Label for the attribute.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private String	operator
static String	OPERATOR Label for the attribute.
private static int	OPERATOR_UPPER_LIMIT
static String	RELATIONSHIP_MAP Label for the attribute.
static String	RELATIONSHIP_MAP_REFERENCE Label for the attribute.
private ObjectReference	relationshipMapReference
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo
private String	value
static String	VALUE Label for the attribute.
private static int	VALUE_UPPER_LIMIT

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

InputValue()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	criterionReferenceValidate(ObjectReference a_CriterionReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
CriterionObject	getCriterion() Gets the object for the association that plays role: CRITERION.
ObjectReference	getCriterionReference() Gets the value of the attribute: CRITERION_REFERENCE.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().
InputType	getInputType() Gets the value of the attribute: INPUT_TYPE.
String	getName() Gets the value of the attribute: NAME.
String	getOperator() Gets the value of the attribute: OPERATOR.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
RelationshipMap	getRelationshipMap() Gets the object for the association that plays role: RELATIONSHIP_MAP.
ObjectReference	getRelationshipMapReference() Gets the value of the attribute: RELATIONSHIP_MAP_REFERENCE.
String	getType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
String	getValue() Gets the value of the attribute: VALUE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Supports initialization, following construction of an instance.
private void	nameValidate(String a_Name)
static InputValue	newInputValue() Default factory for the class.
private void	operatorValidate(String a_Operator)
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(InputValue thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	relationshipMapReferenceValidate(ObjectReference a_RelationshipMapReference)
void	setCriterion(CriterionObject a_Criterion) Sets the object for the association that plays role: CRITERION.
void	setCriterionReference(ObjectReference a_CriterionReference) Sets the value of the attribute: CRITERION_REFERENCE.
void	setInputType(InputType a_InputType) Sets the value of the attribute: INPUT_TYPE.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOperator(String a_Operator) Sets the value of the attribute: OPERATOR.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
void	setRelationshipMap(RelationshipMap a_RelationshipMap) Sets the object for the association that plays role: RELATIONSHIP_MAP.
void	setRelationshipMapReference(ObjectReference a_RelationshipMapReference) Sets the value of the attribute: RELATIONSHIP_MAP_REFERENCE.
void	setValue(String a_Value) Sets the value of the attribute: VALUE.
String	toString() Returns the conceptual (modeled) name for the class.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

NAME

public static final String NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

VALUE

public static final String VALUE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

VALUE_UPPER_LIMIT

private static int VALUE_UPPER_LIMIT

value

private String value

INPUT_TYPE

public static final String INPUT_TYPE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

INPUT_TYPE_UPPER_LIMIT

private static int INPUT_TYPE_UPPER_LIMIT

inputType

private InputType inputType

OPERATOR

public static final String OPERATOR

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

OPERATOR_UPPER_LIMIT

private static int OPERATOR_UPPER_LIMIT

operator

private String operator

CRITERION

public static final String CRITERION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CRITERION_REFERENCE

public static final String CRITERION_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

criterionReference

private ObjectReference criterionReference

RELATIONSHIP_MAP

public static final String RELATIONSHIP_MAP

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

RELATIONSHIP_MAP_REFERENCE

public static final String RELATIONSHIP_MAP_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

relationshipMapReference

private ObjectReference relationshipMapReference

thePersistInfo

private PersistInfo thePersistInfo

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

InputValue

public InputValue()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(InputValue thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getValue

public String getValue()

Gets the value of the attribute: VALUE.

Supported API: false

Returns:

String

setValue

public void setValue(String a_Value)

Sets the value of the attribute: VALUE.

Supported API: false

Parameters:

a_Value -

getInputType

public InputType getInputType()

Gets the value of the attribute: INPUT_TYPE.

Supported API: false

Returns:

InputType

setInputType

public void setInputType(InputType a_InputType)
                  throws WTPropertyVetoException

Sets the value of the attribute: INPUT_TYPE.

Supported API: false

Parameters:

a_InputType -

Throws:

WTPropertyVetoException

getOperator

public String getOperator()

Gets the value of the attribute: OPERATOR.

Supported API: false

Returns:

String

setOperator

public void setOperator(String a_Operator)
                 throws WTPropertyVetoException

Sets the value of the attribute: OPERATOR.

Supported API: false

Parameters:

a_Operator -

Throws:

WTPropertyVetoException

operatorValidate

private void operatorValidate(String a_Operator)
                       throws WTPropertyVetoException

Parameters:

a_Operator -

Throws:

WTPropertyVetoException

getCriterion

public CriterionObject getCriterion()

Gets the object for the association that plays role: CRITERION.

Supported API: false

Returns:

CriterionObject

setCriterion

public void setCriterion(CriterionObject a_Criterion)
                  throws WTPropertyVetoException,
                         WTException

Sets the object for the association that plays role: CRITERION.

Supported API: false

Parameters:

a_Criterion -

Throws:

WTPropertyVetoException

WTException

getCriterionReference

public ObjectReference getCriterionReference()

Gets the value of the attribute: CRITERION_REFERENCE.

Supported API: false

Returns:

ObjectReference

setCriterionReference

public void setCriterionReference(ObjectReference a_CriterionReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CRITERION_REFERENCE.

Supported API: false

Parameters:

a_CriterionReference -

Throws:

WTPropertyVetoException

criterionReferenceValidate

private void criterionReferenceValidate(ObjectReference a_CriterionReference)
                                 throws WTPropertyVetoException

Parameters:

a_CriterionReference -

Throws:

WTPropertyVetoException

getRelationshipMap

public RelationshipMap getRelationshipMap()

Gets the object for the association that plays role: RELATIONSHIP_MAP.

Supported API: false

Returns:

RelationshipMap

setRelationshipMap

public void setRelationshipMap(RelationshipMap a_RelationshipMap)
                        throws WTPropertyVetoException,
                               WTException

Sets the object for the association that plays role: RELATIONSHIP_MAP.

Supported API: false

Parameters:

a_RelationshipMap -

Throws:

WTPropertyVetoException

WTException

getRelationshipMapReference

public ObjectReference getRelationshipMapReference()

Gets the value of the attribute: RELATIONSHIP_MAP_REFERENCE.

Supported API: false

Returns:

ObjectReference

setRelationshipMapReference

public void setRelationshipMapReference(ObjectReference a_RelationshipMapReference)
                                 throws WTPropertyVetoException

Sets the value of the attribute: RELATIONSHIP_MAP_REFERENCE.

Supported API: false

Parameters:

a_RelationshipMapReference -

Throws:

WTPropertyVetoException

relationshipMapReferenceValidate

private void relationshipMapReferenceValidate(ObjectReference a_RelationshipMapReference)
                                       throws WTPropertyVetoException

Parameters:

a_RelationshipMapReference -

Throws:

WTPropertyVetoException

newInputValue

public static InputValue newInputValue()
                                throws WTException

Default factory for the class.

Supported API: false

Returns:

InputValue

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Throws:

WTException

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface Persistable

Returns:

String

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

Gets the object for the association that plays role: PERSIST_INFO.

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

Sets the object for the association that plays role: PERSIST_INFO.

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Returns:

int