EclipseLink 1.2.0, build 'v20091016-r5565' API Reference

org.eclipse.persistence.sdo.types
Class SDODataType

java.lang.Object
  extended by org.eclipse.persistence.sdo.SDOType
      extended by org.eclipse.persistence.sdo.types.SDODataType
All Implemented Interfaces:
Type, java.io.Serializable

public class SDODataType
extends SDOType
implements Type

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.persistence.sdo.SDOType
SDOType.TypeInstantiationPolicy
 
Field Summary
 
Fields inherited from class org.eclipse.persistence.sdo.SDOType
aHelperContext, isDataType, xmlDescriptor
 
Constructor Summary
SDODataType(java.lang.String aUri, java.lang.String aName, java.lang.Class aClass, SDOTypeHelper sdoTypeHelper)
           
SDODataType(java.lang.String aUri, java.lang.String aName, java.lang.Class aClass, SDOTypeHelper sdoTypeHelper, java.lang.Object aPseudoDefault)
           
SDODataType(java.lang.String aUri, java.lang.String aName, SDOTypeHelper sdoTypeHelper)
           
 
Method Summary
protected  void addOpenMappings()
           
 java.lang.Object getPseudoDefault()
          INTERNAL: Return the wrapped initial value for the primitive numeric (when not defined) See p.45 of Java Spec 4th edition.
 boolean isAbstract()
          Indicates if this Type is abstract.
 boolean isDataType()
          Indicates if this Type specifies DataTypes (true) or DataObjects (false).
 boolean isInstance(java.lang.Object object)
          Returns whether the specified object is an instance of this type.
 boolean isOpen()
          Indicates if this Type allows any form of open content.
 boolean isSequenced()
          Indicates if this Type specifies Sequenced DataObjects.
 void setOpen(boolean bOpen)
          INTERNAL: Make this Type an opened Type to allow open content by assigning true value or a Type not to accept any additional properties by assigning false value, SDOType.isOpen().
 
Methods inherited from class org.eclipse.persistence.sdo.SDOType
addAliasName, addBaseType, addDeclaredProperty, addDeclaredProperty, addDeclaredProperty, addDeclaredProperty, equals, get, getAliasNames, getAppInfoElements, getAppInfoMap, getBaseTypes, getChangeSummaryProperty, getDeclaredProperties, getDeclaredPropertiesMap, getHelperContext, getImplClass, getImplClassName, getInstanceClass, getInstanceClassName, getInstanceProperties, getName, getNonFinalizedMappingURIs, getNonFinalizedReferencingProps, getProperties, getPropertiesArray, getProperty, getPropertyValues, getQName, getSubTypes, getURI, getXmlDescriptor, getXsdLocalName, getXsdType, initializeNamespaces, isChangeSummaryType, isDataObjectType, isFinalized, isOpenSequencedType, isSubType, isTypeType, isWrapperType, isXsd, isXsdList, postInitialize, preInitialize, removeDeclaredProperties, setAbstract, setAliasNames, setAppInfoElements, setBaseTypes, setDataType, setFinalized, setImplClassName, setInstanceClass, setInstanceClassName, setInstanceProperty, setMixed, setNonFinalizedMappingURIs, setNonFinalizedReferencingProps, setPropertyValues, setPseudoDefault, setQName, setSequenced, setSubTypes, setupInheritance, setXmlDescriptor, setXsd, setXsdList, setXsdLocalName, setXsdType
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface commonj.sdo.Type
get, getAliasNames, getBaseTypes, getDeclaredProperties, getInstanceClass, getInstanceProperties, getName, getProperties, getProperty, getURI
 

Constructor Detail

SDODataType

public SDODataType(java.lang.String aUri,
                   java.lang.String aName,
                   SDOTypeHelper sdoTypeHelper)

SDODataType

public SDODataType(java.lang.String aUri,
                   java.lang.String aName,
                   java.lang.Class aClass,
                   SDOTypeHelper sdoTypeHelper)

SDODataType

public SDODataType(java.lang.String aUri,
                   java.lang.String aName,
                   java.lang.Class aClass,
                   SDOTypeHelper sdoTypeHelper,
                   java.lang.Object aPseudoDefault)
Method Detail

isAbstract

public boolean isAbstract()
Description copied from interface: Type
Indicates if this Type is abstract. If true, this Type cannot be instantiated. Abstract types cannot be used in DataObject or DataFactory create methods.

Specified by:
isAbstract in interface Type
Overrides:
isAbstract in class SDOType
Returns:
true if this Type is abstract.

isDataType

public boolean isDataType()
Description copied from interface: Type
Indicates if this Type specifies DataTypes (true) or DataObjects (false). When false, any object that is an instance of this type also implements the DataObject interface. True for simple types such as Strings and numbers. For any object:
   isInstance(object) && !isDataType() implies
   DataObject.class.isInstance(object) returns true. 
 

Specified by:
isDataType in interface Type
Overrides:
isDataType in class SDOType
Returns:
true if Type specifies DataTypes, false for DataObjects.

isInstance

public boolean isInstance(java.lang.Object object)
Description copied from interface: Type
Returns whether the specified object is an instance of this type.

Specified by:
isInstance in interface Type
Overrides:
isInstance in class SDOType
Parameters:
object - the object in question.
Returns:
true if the object is an instance.
See Also:
Class.isInstance(java.lang.Object)

isOpen

public boolean isOpen()
Description copied from interface: Type
Indicates if this Type allows any form of open content. If false, dataObject.getInstanceProperties() must be the same as dataObject.getType().getProperties() for any DataObject dataObject of this Type.

Specified by:
isOpen in interface Type
Overrides:
isOpen in class SDOType
Returns:
true if this Type allows open content.

isSequenced

public boolean isSequenced()
Description copied from interface: Type
Indicates if this Type specifies Sequenced DataObjects. Sequenced DataObjects are used when the order of values between Properties must be preserved. When true, a DataObject will return a Sequence. For example,
  Sequence elements = dataObject.getSequence();
 

Specified by:
isSequenced in interface Type
Overrides:
isSequenced in class SDOType
Returns:
true if this Type specifies Sequenced DataObjects.

getPseudoDefault

public java.lang.Object getPseudoDefault()
Description copied from class: SDOType
INTERNAL: Return the wrapped initial value for the primitive numeric (when not defined) See p.45 of Java Spec 4th edition. See p.85 Sect 9.3 of the SDO Spec.

Overrides:
getPseudoDefault in class SDOType
Returns:
aDefault Object (primitive numerics) or null (DataObjects, String, Lists)

addOpenMappings

protected void addOpenMappings()

setOpen

public void setOpen(boolean bOpen)
Description copied from class: SDOType
INTERNAL: Make this Type an opened Type to allow open content by assigning true value or a Type not to accept any additional properties by assigning false value, SDOType.isOpen().

Overrides:
setOpen in class SDOType
Parameters:
bOpen - boolean value implying if this Type is open

EclipseLink 1.2.0, build 'v20091016-r5565' API Reference