wt.iba.definition.litedefinition
Class UnitDefView

java.lang.Object
  extended bywt.lite.AbstractLiteObject
      extended bywt.iba.definition.litedefinition.AbstractAttributeDefinizerView
          extended bywt.iba.definition.litedefinition.AbstractAttributeDefinizerDefaultView
              extended bywt.iba.definition.litedefinition.AttributeDefDefaultView
                  extended bywt.iba.definition.litedefinition.UnitDefView
All Implemented Interfaces:
Cloneable, Externalizable, Liteable, LiteDisplayUnitsHolder, LocalizedStringDisplayable, Serializable

public final class UnitDefView
extends AttributeDefDefaultView
implements LiteDisplayUnitsHolder, Externalizable

Liteweight Unit type definition.

Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
private static String constraintClassname
          A static string which represents a constraint class of the approriate data type.
static long EXTERNALIZATION_VERSION_UID
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
private  DefaultDisplayUnitsHolder theDefaultDisplayUnitsHolder
           
private  QuantityOfMeasureDefaultView theQuantityOfMeasureDefaultView
           
 
Fields inherited from class wt.iba.definition.litedefinition.AttributeDefDefaultView
 
Fields inherited from class wt.iba.definition.litedefinition.AbstractAttributeDefinizerView
 
Fields inherited from class wt.lite.AbstractLiteObject
ILLEGAL_ACCESS, SERVER
 
Fields inherited from interface wt.lite.Liteable
UPDATE_COUNT
 
Constructor Summary
UnitDefView()
          Default Constructor

Supported API: false
UnitDefView(int updateCount, String name, ObjectIdentifier objectID, ObjectIdentifier parentObjectID, String description, String displayName, QuantityOfMeasureDefaultView quantOfMeasure, String className, String hierarchyID)
          Serverside constructor of this class.
UnitDefView(int updateCount, String name, String hierarchyDisplayName, ObjectIdentifier objectID, ObjectIdentifier parentObjectID, String description, String displayName, QuantityOfMeasureDefaultView quantOfMeasure, String className, String hierarchyID)
          

Supported API: false
UnitDefView(int updateCount, String name, String hierarchyDisplayName, ObjectIdentifier objectID, ObjectIdentifier parentObjectID, String description, String displayName, QuantityOfMeasureDefaultView quantOfMeasure, String className, String hierarchyID, String counterpartID)
          Added to manage the counterpartID field which is used by the R7 CounterPartService.
UnitDefView(String name, String description, AbstractAttributeDefinizerView parent, QuantityOfMeasureDefaultView quantityOfMeasure)
          Client side constructor of this class.
UnitDefView(String name, String hierarchyDisplayName, String description, AbstractAttributeDefinizerView parent, QuantityOfMeasureDefaultView quantityOfMeasure)
          

Supported API: false
 
Method Summary
 Object clone()
          

Supported API: false
 Enumeration defaultDisplayUnitsKeys()
          Returns the keys to the default measurement system display units hashtable keys.
 Enumeration displayUnitsKeys()
          Returns an enumeration of the keys to the internal hashtable.
 String getConstraintClassname()
          

Supported API: false
 String getDefaultDisplayUnitString(String measurementSystemName)
          Gets the default unit display string given the MeasurementSystem name .
 String getDisplayUnitString(String measurementSystemName)
          Given a MeasurementSystem name as key, return the displayUnitString as return value.
 QuantityOfMeasureDefaultView getQuantityOfMeasureDefaultView()
          Gets the object for the association that plays role: theQuantityOfMeasureDefaultView.
 void readExternal(ObjectInput input)
          Reads the non-transient fields of this class from an external source.
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(UnitDefView thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setDefaultDisplayUnitString(String measurementSystemName, String defaultDisplayUnit)
          Sets the default display unit string given the MeasurementSystem name as key.
 void setDisplayUnitString(String measurementSystemName, String unitDisplayInfoString)
          Sets a MeasurementSystem name as key, and an unitDisplayInfo String as value.
 void setQuantityOfMeasureDefaultView(QuantityOfMeasureDefaultView a_QuantityOfMeasureDefaultView)
          Sets the object for the association that plays role: theQuantityOfMeasureDefaultView.
private  void theQuantityOfMeasureDefaultViewValidate(QuantityOfMeasureDefaultView a_QuantityOfMeasureDefaultView)
           
 void writeExternal(ObjectOutput output)
          Writes the non-transient fields of this class to an external source.
 
Methods inherited from class wt.iba.definition.litedefinition.AttributeDefDefaultView
getAttributeDefinitionClassName, getCounterpartID, getDisplayName, getHierarchyID, getLocalizedDisplayString, getLogicalIdentifier, readVersion, setCounterpartID, setDisplayName, setHierarchyID, setLogicalIdentifier, toAbstractAttributeDefinizerNodeView
 
Methods inherited from class wt.iba.definition.litedefinition.AbstractAttributeDefinizerDefaultView
readVersion
 
Methods inherited from class wt.iba.definition.litedefinition.AbstractAttributeDefinizerView
getDescription, getHierarchyDisplayName, getName, getParentObjectID, isParentOf, isRoot, readVersion, setDescription, setHierarchyDisplayName, setName, setParentObjectID
 
Methods inherited from class wt.lite.AbstractLiteObject
compareUpdateCount, getHeavyObjectClassname, getObjectID, getUpdateCount, isPersistedObjectEqual, readVersion, setLocalizedDisplayString, setObjectID, setUpdateCount
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

constraintClassname

private static final String constraintClassname
A static string which represents a constraint class of the approriate data type. One of the purposes of this reference is to search the approtriate constraint subclass when a query kicks off from the attribute definition.

See Also:
Constant Field Values

theQuantityOfMeasureDefaultView

private QuantityOfMeasureDefaultView theQuantityOfMeasureDefaultView

theDefaultDisplayUnitsHolder

private DefaultDisplayUnitsHolder theDefaultDisplayUnitsHolder

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

UnitDefView

public UnitDefView()
Default Constructor

Supported API: false


UnitDefView

public UnitDefView(String name,
                   String description,
                   AbstractAttributeDefinizerView parent,
                   QuantityOfMeasureDefaultView quantityOfMeasure)
            throws IBAException
Client side constructor of this class.

Supported API: false

Parameters:
name -
description -
parent -
quantityOfMeasure -
Throws:
IBAException

UnitDefView

public UnitDefView(int updateCount,
                   String name,
                   ObjectIdentifier objectID,
                   ObjectIdentifier parentObjectID,
                   String description,
                   String displayName,
                   QuantityOfMeasureDefaultView quantOfMeasure,
                   String className,
                   String hierarchyID)
            throws IBAException
Serverside constructor of this class. Contains all required attributes.

Supported API: false

Parameters:
updateCount -
name -
objectID -
parentObjectID -
description -
displayName -
quantOfMeasure -
className -
hierarchyID -
Throws:
IBAException

UnitDefView

public UnitDefView(String name,
                   String hierarchyDisplayName,
                   String description,
                   AbstractAttributeDefinizerView parent,
                   QuantityOfMeasureDefaultView quantityOfMeasure)
            throws IBAException


Supported API: false

Parameters:
name -
hierarchyDisplayName -
description -
parent -
quantityOfMeasure -
Throws:
IBAException

UnitDefView

public UnitDefView(int updateCount,
                   String name,
                   String hierarchyDisplayName,
                   ObjectIdentifier objectID,
                   ObjectIdentifier parentObjectID,
                   String description,
                   String displayName,
                   QuantityOfMeasureDefaultView quantOfMeasure,
                   String className,
                   String hierarchyID)
            throws IBAException


Supported API: false

Parameters:
updateCount -
name -
hierarchyDisplayName -
objectID -
parentObjectID -
description -
displayName -
quantOfMeasure -
className -
hierarchyID -
Throws:
IBAException

UnitDefView

public UnitDefView(int updateCount,
                   String name,
                   String hierarchyDisplayName,
                   ObjectIdentifier objectID,
                   ObjectIdentifier parentObjectID,
                   String description,
                   String displayName,
                   QuantityOfMeasureDefaultView quantOfMeasure,
                   String className,
                   String hierarchyID,
                   String counterpartID)
            throws IBAException
Added to manage the counterpartID field which is used by the R7 CounterPartService.

Supported API: false

Parameters:
updateCount -
name -
hierarchyDisplayName -
objectID -
parentObjectID -
description -
displayName -
quantOfMeasure -
className -
hierarchyID -
counterpartID -
Throws:
IBAException
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
Overrides:
writeExternal in class AttributeDefDefaultView
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
Overrides:
readExternal in class AttributeDefDefaultView
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(UnitDefView 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

getQuantityOfMeasureDefaultView

public QuantityOfMeasureDefaultView getQuantityOfMeasureDefaultView()
Gets the object for the association that plays role: theQuantityOfMeasureDefaultView.

Supported API: false

Returns:
QuantityOfMeasureDefaultView

setQuantityOfMeasureDefaultView

public void setQuantityOfMeasureDefaultView(QuantityOfMeasureDefaultView a_QuantityOfMeasureDefaultView)
                                     throws WTPropertyVetoException
Sets the object for the association that plays role: theQuantityOfMeasureDefaultView.

Supported API: false

Parameters:
a_QuantityOfMeasureDefaultView -
Throws:
WTPropertyVetoException

theQuantityOfMeasureDefaultViewValidate

private void theQuantityOfMeasureDefaultViewValidate(QuantityOfMeasureDefaultView a_QuantityOfMeasureDefaultView)
                                              throws WTPropertyVetoException
Parameters:
a_QuantityOfMeasureDefaultView -
Throws:
WTPropertyVetoException

getConstraintClassname

public String getConstraintClassname()


Supported API: false

Specified by:
getConstraintClassname in class AttributeDefDefaultView
Returns:
String

getDisplayUnitString

public String getDisplayUnitString(String measurementSystemName)
Given a MeasurementSystem name as key, return the displayUnitString as return value.

Supported API: false

Specified by:
getDisplayUnitString in interface LiteDisplayUnitsHolder
Parameters:
measurementSystemName -
Returns:
String

setDisplayUnitString

public void setDisplayUnitString(String measurementSystemName,
                                 String unitDisplayInfoString)
Sets a MeasurementSystem name as key, and an unitDisplayInfo String as value. Stores internally in Hashtable.

Supported API: false

Specified by:
setDisplayUnitString in interface LiteDisplayUnitsHolder
Parameters:
measurementSystemName -
unitDisplayInfoString -

displayUnitsKeys

public Enumeration displayUnitsKeys()
Returns an enumeration of the keys to the internal hashtable.

Supported API: false

Specified by:
displayUnitsKeys in interface LiteDisplayUnitsHolder
Returns:
Enumeration

getDefaultDisplayUnitString

public String getDefaultDisplayUnitString(String measurementSystemName)
Gets the default unit display string given the MeasurementSystem name .

Supported API: false

Specified by:
getDefaultDisplayUnitString in interface LiteDisplayUnitsHolder
Parameters:
measurementSystemName -
Returns:
String

setDefaultDisplayUnitString

public void setDefaultDisplayUnitString(String measurementSystemName,
                                        String defaultDisplayUnit)
Sets the default display unit string given the MeasurementSystem name as key.

Supported API: false

Specified by:
setDefaultDisplayUnitString in interface LiteDisplayUnitsHolder
Parameters:
measurementSystemName -
defaultDisplayUnit -

defaultDisplayUnitsKeys

public Enumeration defaultDisplayUnitsKeys()
Returns the keys to the default measurement system display units hashtable keys.

Supported API: false

Specified by:
defaultDisplayUnitsKeys in interface LiteDisplayUnitsHolder
Returns:
Enumeration

clone

public Object clone()


Supported API: false

Specified by:
clone in interface LiteDisplayUnitsHolder
Overrides:
clone in class AttributeDefDefaultView
Returns:
Object