EclipseLink 2.2.0, build 'v20110202-r8913' API Reference

org.eclipse.persistence.sdo.types
Class SDOWrapperType

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

public class SDOWrapperType
extends SDOType
implements Type

Wrapper for XML datatypes.

See Also:
Serialized Form
Author:
rbarkhou

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
SDOWrapperType(Type aPropertyType, java.lang.String aTypeName, SDOTypeHelper aSDOTypeHelper)
           
SDOWrapperType(Type aPropertyType, java.lang.String aTypeName, SDOTypeHelper aSDOTypeHelper, javax.xml.namespace.QName aSchemaType)
           
SDOWrapperType(Type aPropertyType, java.lang.String aTypeName, SDOTypeHelper aSDOTypeHelper, javax.xml.namespace.QName[] schemaTypes)
           
 
Method Summary
 void addDescriptorToProject(Project project)
           
 java.util.List getAliasNames()
          Return a list of alias names for this Type.
 java.util.List getBaseTypes()
          Returns the List of base Types for this Type.
 java.util.Map getDescriptorsMap()
           
 java.lang.String getName()
          Returns the name of the type.
 java.lang.String getURI()
          Returns the namespace URI of the type or null if the type has no URI (for example it was generated from a Schema with no target namespace).
 XMLDescriptor getXmlDescriptor(javax.xml.namespace.QName aQName)
           
 boolean isAbstract()
          Indicates if this Type is abstract.
 boolean isDataType()
          Indicates if this Type specifies DataTypes (true) or DataObjects (false).
 boolean isFinalized()
          INTERNAL:
 boolean isOpen()
          Indicates if this Type allows any form of open content.
 boolean isSequenced()
          Indicates if this Type specifies Sequenced DataObjects.
 boolean isWrapperType()
           
 java.lang.String toString()
           
 
Methods inherited from class org.eclipse.persistence.sdo.SDOType
addAliasName, addBaseType, addDeclaredProperty, addDeclaredProperty, addDeclaredProperty, addDeclaredProperty, get, getAppInfoElements, getAppInfoMap, getChangeSummaryProperty, getDeclaredProperties, getDeclaredPropertiesMap, getHelperContext, getImplClass, getImplClassName, getInstanceClass, getInstanceClassName, getInstanceProperties, getNonFinalizedMappingURIs, getNonFinalizedReferencingProps, getProperties, getPropertiesArray, getProperty, getPropertyValues, getPseudoDefault, getQName, getSubTypes, getXmlDescriptor, getXsdLocalName, getXsdType, initializeNamespaces, isChangeSummaryType, isDataObjectType, isInstance, isOpenSequencedType, isSubType, isTypeType, isXsd, isXsdList, postInitialize, preInitialize, removeDeclaredProperties, setAbstract, setAliasNames, setAppInfoElements, setBaseTypes, setDataType, setFinalized, setImplClassName, setInstanceClass, setInstanceClassName, setInstanceProperty, setMixed, setNonFinalizedMappingURIs, setNonFinalizedReferencingProps, setOpen, setPropertyValues, setPseudoDefault, setQName, setSequenced, setSubTypes, setupInheritance, setXmlDescriptor, setXsd, setXsdList, setXsdLocalName, setXsdType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface commonj.sdo.Type
get, getDeclaredProperties, getInstanceClass, getInstanceProperties, getProperties, getProperty, isInstance
 

Constructor Detail

SDOWrapperType

public SDOWrapperType(Type aPropertyType,
                      java.lang.String aTypeName,
                      SDOTypeHelper aSDOTypeHelper)

SDOWrapperType

public SDOWrapperType(Type aPropertyType,
                      java.lang.String aTypeName,
                      SDOTypeHelper aSDOTypeHelper,
                      javax.xml.namespace.QName aSchemaType)

SDOWrapperType

public SDOWrapperType(Type aPropertyType,
                      java.lang.String aTypeName,
                      SDOTypeHelper aSDOTypeHelper,
                      javax.xml.namespace.QName[] schemaTypes)
Method Detail

getXmlDescriptor

public XMLDescriptor getXmlDescriptor(javax.xml.namespace.QName aQName)

getDescriptorsMap

public java.util.Map getDescriptorsMap()

addDescriptorToProject

public void addDescriptorToProject(Project project)

getAliasNames

public java.util.List getAliasNames()
Description copied from interface: Type
Return a list of alias names for this Type.

Specified by:
getAliasNames in interface Type
Overrides:
getAliasNames in class SDOType
Returns:
a list of alias names for this Type.

getBaseTypes

public java.util.List getBaseTypes()
Description copied from interface: Type
Returns the List of base Types for this Type. The List is empty if there are no base Types. XSD , , and Java extends keyword are mapped to this list.

Specified by:
getBaseTypes in interface Type
Overrides:
getBaseTypes in class SDOType
Returns:
the List of base Types for this Type.

getName

public java.lang.String getName()
Description copied from interface: Type
Returns the name of the type.

Specified by:
getName in interface Type
Overrides:
getName in class SDOType
Returns:
the type name.

getURI

public java.lang.String getURI()
Description copied from interface: Type
Returns the namespace URI of the type or null if the type has no URI (for example it was generated from a Schema with no target namespace).

Specified by:
getURI in interface Type
Overrides:
getURI in class SDOType
Returns:
the namespace URI.

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.

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.

isFinalized

public boolean isFinalized()
Description copied from class: SDOType
INTERNAL:

Overrides:
isFinalized in class SDOType

isWrapperType

public boolean isWrapperType()
Overrides:
isWrapperType in class SDOType

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

EclipseLink 2.2.0, build 'v20110202-r8913' API Reference