com.metamatrix.modeler.core.metadata.runtime
Interface DatatypeRecord

All Superinterfaces:
MetadataRecord, java.io.Serializable
All Known Implementing Classes:
DatatypeRecordImpl

public interface DatatypeRecord
extends MetadataRecord

ColumnRecord


Nested Class Summary
static interface DatatypeRecord.MetadataFieldNames
          Constants for names of accessor methods that map to fields stored on the DatatypeRecords.
 
Nested classes/interfaces inherited from interface com.metamatrix.modeler.core.metadata.runtime.MetadataRecord
MetadataRecord.MetadataRecordProperties
 
Method Summary
 java.lang.String getBasetypeID()
          Return a string that uniquely identifies the datatype for which this datatype is an extension/restriction.
 java.lang.String getBasetypeName()
          Return the name of the datatype for which this datatype is an extension/restriction.
 java.lang.String getDatatypeID()
          Return a string that uniquely identifies the datatype.
 java.lang.String getJavaClassName()
          Returns the name of the Java class that represents this datatype
 int getLength()
          If the data type is numeric, the length is the total number of significant digits used to express the number.
 short getNullType()
          Returns a short indicating if the element can be set to null.
 int getPrecisionLength()
          Returns an int indicating the precision length.
 java.lang.String getPrimitiveTypeID()
          Return a string that uniquely identifies the built-in primitive datatype for which this datatype is an extension/restriction.
 int getRadix()
          Returns an int indicating the radix.
 java.lang.String getRuntimeTypeName()
          Returns the name of the runtime type that this datatype is mapped to.
 int getScale()
          Returns the scale, which is the number of significant digits to the right of the decimal point.
 short getSearchType()
          Returns a short indicating the serach typr.
 short getType()
          Return short indicating the type.
 java.util.List getVarietyProps()
          Depending on the value of the variety type additional properties may be defined.
 short getVarietyType()
          Returns the variety used to characterize the
 boolean isAutoIncrement()
          Returns a boolean indicating if the element is auto incremented by the database.
 boolean isBuiltin()
          Return whether this type represents a built-in.
 boolean isCaseSensitive()
          Returns a boolean indicating if the element data is case sensitive.
 boolean isSigned()
          Returns a boolean indicating if the element data is signed.
 
Methods inherited from interface com.metamatrix.modeler.core.metadata.runtime.MetadataRecord
getEObject, getFullName, getModelName, getName, getNameInSource, getParentFullName, getParentPathString, getParentUUID, getPath, getPathString, getPropertyValue, getRecordType, getResourcePath, getUUID, setPropertyValue
 

Method Detail

getLength

int getLength()
If the data type is numeric, the length is the total number of significant digits used to express the number. If it is a string, character array, or bit array it represents the maximum length of the value. For time and timestamp data types, the length is the number of positions that make up the fractional seconds. The value of length is a non-negative integer.

Returns:
int

getPrecisionLength

int getPrecisionLength()
Returns an int indicating the precision length. Default to MetadataConstants.NOT_DEFINED_INT if not set.

Returns:
int

getScale

int getScale()
Returns the scale, which is the number of significant digits to the right of the decimal point. The scale cannot exceed the length, and the scale defaults to 0 (meaning it is an integer number and the decimal point is dropped).

Returns:
int

getRadix

int getRadix()
Returns an int indicating the radix. Default to MetadataConstants.NOT_DEFINED_INT if not set.

Returns:
int

isSigned

boolean isSigned()
Returns a boolean indicating if the element data is signed.

Returns:
boolean

isAutoIncrement

boolean isAutoIncrement()
Returns a boolean indicating if the element is auto incremented by the database. Therefore, this element value should not be provided on an insert statement.

Returns:
boolean

isCaseSensitive

boolean isCaseSensitive()
Returns a boolean indicating if the element data is case sensitive. This value shall be false if the data type is not a character, character array or string type.

Returns:
boolean

getType

short getType()
Return short indicating the type.

Returns:
short
See Also:
MetadataConstants.DATATYPE_TYPES

isBuiltin

boolean isBuiltin()
Return whether this type represents a built-in.

See Also:
getType()

getSearchType

short getSearchType()
Returns a short indicating the serach typr.

Returns:
short
See Also:
MetadataConstants.SEARCH_TYPES

getNullType

short getNullType()
Returns a short indicating if the element can be set to null.

Returns:
short
See Also:
MetadataConstants.NULL_TYPES

getJavaClassName

java.lang.String getJavaClassName()
Returns the name of the Java class that represents this datatype

Returns:
String is the name of the Java class

getRuntimeTypeName

java.lang.String getRuntimeTypeName()
Returns the name of the runtime type that this datatype is mapped to.

Returns:
runtime type name

getDatatypeID

java.lang.String getDatatypeID()
Return a string that uniquely identifies the datatype. The string typically defines a URI reference constructed as follows:

1. the base URI of the XML Schema namespace 2. the fragment identifier defining the name of the datatype

Returns:
String the identifier

getBasetypeID

java.lang.String getBasetypeID()
Return a string that uniquely identifies the datatype for which this datatype is an extension/restriction. If this datatype has no base or supertype then null is returned. The string typically defines a URI reference constructed as follows:

1. the base URI of the XML Schema namespace 2. the fragment identifier defining the name of the datatype

Returns:
String the identifier

getPrimitiveTypeID

java.lang.String getPrimitiveTypeID()
Return a string that uniquely identifies the built-in primitive datatype for which this datatype is an extension/restriction. If this datatype has no base or supertype then null is returned. The string typically defines a URI reference constructed as follows:

1. the base URI of the XML Schema namespace 2. the fragment identifier defining the name of the datatype

Returns:
String the identifier

getBasetypeName

java.lang.String getBasetypeName()
Return the name of the datatype for which this datatype is an extension/restriction. If this datatype has no base or supertype then null is returned.

The implementation simply computes the fragment from the getBasetypeID().

Returns:
String the name

getVarietyType

short getVarietyType()
Returns the variety used to characterize the

Parameters:
eObject - The EObject to check
Returns:
short
See Also:
com.metamatrix.modeler.core.metadata.runtime.MetadataConstants.DATATYPES_VARIETIES

getVarietyProps

java.util.List getVarietyProps()
Depending on the value of the variety type additional properties may be defined.

Parameters:
eObject - The EObject to check
Returns:
List


Copyright © 2009. All Rights Reserved.