org.ipdr.common
Class OpenType

java.lang.Object
  extended by org.ipdr.common.OpenType
Direct Known Subclasses:
ArrayType, CompositeType, SimpleType

public abstract class OpenType
extends java.lang.Object

This is the superclass for the specialized open type classes which describe each category of basic data types.


Field Summary
static char BOOLEAN_TYPE_CODE
          Type code for a Boolean object, 'Z'
static char BYTE_TYPE_CODE
          Type code for a Byte object, 'B'
protected  java.lang.String derivedType_
          String containing the derived type of the Open Type.
protected  java.lang.String description_
          String containing the description of the Open Type.
static char DOUBLE_TYPE_CODE
          Type code for a Double object, 'D'
static char FLOAT_TYPE_CODE
          Type code for a Float object, 'F'
static char HEX_BINARY_TYPE_CODE
          Type code assignments are described in the javadoc for java.lang.Class method getName().
static char INTEGER_TYPE_CODE
          Type code for a Integer object, 'I'
static char LONG_TYPE_CODE
          Type code for a Long object, 'J'
protected  java.lang.String name_
          String containing the name of the Open Type.
static char OBJECT_TYPE_CODE
          Type code for a Object object, 'L'
static char SHORT_TYPE_CODE
          Type code for a Short object, 'S'
static char STRING_TYPE_CODE
          Type code assignments are described in the javadoc for java.lang.Class method getName().
static char UNSIGNEDBYTE_TYPE_CODE
          Type code for a Unsigned Byte object, 'E'
static char UNSIGNEDINT_TYPE_CODE
          Type code for a unsigned Integer object, 'U'
static char UNSIGNEDLONG_TYPE_CODE
          Type code for a Unsigned Long object, 'K'
static char UNSIGNEDSHORT_TYPE_CODE
          Type code for a Unsigned Short object, 'T'
 
Constructor Summary
OpenType()
           
 
Method Summary
 java.lang.String getDerivedType()
          Method to get the Derived Type of this data item.
 java.lang.String getDescription()
          Returns descriptive information regarding this data item.
 java.lang.String getName()
          Returns the name of this data item.
abstract  OpenType getType()
          Retreives the details about this type.
abstract  char getTypeCode()
          Retreives simple character Type Code for this type used to indicate if it is a known simple type or other.
 void setDerivedType(java.lang.String derivedType)
          Method to set the Derived Type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name_

protected java.lang.String name_
String containing the name of the Open Type.


description_

protected java.lang.String description_
String containing the description of the Open Type.


derivedType_

protected java.lang.String derivedType_
String containing the derived type of the Open Type.


INTEGER_TYPE_CODE

public static final char INTEGER_TYPE_CODE
Type code for a Integer object, 'I'

See Also:
Constant Field Values

UNSIGNEDINT_TYPE_CODE

public static final char UNSIGNEDINT_TYPE_CODE
Type code for a unsigned Integer object, 'U'

See Also:
Constant Field Values

LONG_TYPE_CODE

public static final char LONG_TYPE_CODE
Type code for a Long object, 'J'

See Also:
Constant Field Values

UNSIGNEDLONG_TYPE_CODE

public static final char UNSIGNEDLONG_TYPE_CODE
Type code for a Unsigned Long object, 'K'

See Also:
Constant Field Values

FLOAT_TYPE_CODE

public static final char FLOAT_TYPE_CODE
Type code for a Float object, 'F'

See Also:
Constant Field Values

DOUBLE_TYPE_CODE

public static final char DOUBLE_TYPE_CODE
Type code for a Double object, 'D'

See Also:
Constant Field Values

HEX_BINARY_TYPE_CODE

public static final char HEX_BINARY_TYPE_CODE
Type code assignments are described in the javadoc for java.lang.Class method getName(). Note that the "A" designation is an addition of this implementation. "A" is for arrays of primitive bytes (byte []) it is also considered a primitive type due to its utility as a general purpose binary container.

See Also:
Constant Field Values

STRING_TYPE_CODE

public static final char STRING_TYPE_CODE
Type code assignments are described in the javadoc for java.lang.Class method getName(). Note that the "X" designation is an addition of this implementation.

See Also:
Constant Field Values

BOOLEAN_TYPE_CODE

public static final char BOOLEAN_TYPE_CODE
Type code for a Boolean object, 'Z'

See Also:
Constant Field Values

BYTE_TYPE_CODE

public static final char BYTE_TYPE_CODE
Type code for a Byte object, 'B'

See Also:
Constant Field Values

UNSIGNEDBYTE_TYPE_CODE

public static final char UNSIGNEDBYTE_TYPE_CODE
Type code for a Unsigned Byte object, 'E'

See Also:
Constant Field Values

SHORT_TYPE_CODE

public static final char SHORT_TYPE_CODE
Type code for a Short object, 'S'

See Also:
Constant Field Values

UNSIGNEDSHORT_TYPE_CODE

public static final char UNSIGNEDSHORT_TYPE_CODE
Type code for a Unsigned Short object, 'T'

See Also:
Constant Field Values

OBJECT_TYPE_CODE

public static final char OBJECT_TYPE_CODE
Type code for a Object object, 'L'

See Also:
Constant Field Values
Constructor Detail

OpenType

public OpenType()
Method Detail

getType

public abstract OpenType getType()
Retreives the details about this type. Note that for 'SimpleType' base objects (such as Integer, Byte, etc), this function simply returns a copy of itself.

Returns:
The OpenType

getName

public java.lang.String getName()
Returns the name of this data item. If this is a complex type then this is the name of a field within that complex type. If this is a base object, then the name is simply the object name (e.g. java.lang.Integer).

Returns:
The Name

getDescription

public java.lang.String getDescription()
Returns descriptive information regarding this data item. If this is a complex type then this describes the meaning of a field within that complex type. If this is a base object, then the description is the simply "a value of type XXX" where XXX is the type name. *

Returns:
The description value

getDerivedType

public java.lang.String getDerivedType()
Method to get the Derived Type of this data item.

Returns:
The Derived Type

setDerivedType

public void setDerivedType(java.lang.String derivedType)
Method to set the Derived Type.


getTypeCode

public abstract char getTypeCode()
Retreives simple character Type Code for this type used to indicate if it is a known simple type or other.

Returns:
The Type Code