EclipseLink 1.0_1.0 M6.1 - 20080422 API Reference - Incubation

org.eclipse.persistence.sdo
Class SDOType

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

public class SDOType
extends java.lang.Object
implements commonj.sdo.Type, java.io.Serializable

See Also:
Serialized Form

Constructor Summary
SDOType(commonj.sdo.helper.HelperContext aContext)
           
SDOType(java.lang.String uri, java.lang.String type_name)
          INTERNAL: Build up a Type with given name and uri and a default static HelperContext.
SDOType(java.lang.String uri, java.lang.String type_name, commonj.sdo.helper.HelperContext aContext)
          Build up a Type with given name and uri
 
Method Summary
 void addAliasName(java.lang.String name)
          INTERNAL: Assign a unique string to a type, which belongs to same uri, among types.
 void addBaseType(SDOType type)
          INTERNAL:
 void addDeclaredProperty(commonj.sdo.Property property)
          INTERNAL:
 void addDeclaredProperty(commonj.sdo.Property property, int index)
          INTERNAL:
 boolean equals(java.lang.Object object)
           
 java.lang.Object get(commonj.sdo.Property property)
           
 java.util.List getAliasNames()
           
 java.util.List getAppInfoElements()
          INTERNAL:
 java.util.Map getAppInfoMap()
          INTERNAL:
 java.util.List getBaseTypes()
           
 commonj.sdo.Property getChangeSummaryProperty()
          INTERNAL:
 java.util.List getDeclaredProperties()
           
 java.util.Map getDeclaredPropertiesMap()
          INTERNAL:
 commonj.sdo.helper.HelperContext getHelperContext()
          Return the HelperContext object associated with this type.
 java.lang.Class getImplClass()
          INTERNAL:
 java.lang.String getImplClassName()
          INTERNAL:
 java.lang.Class getInstanceClass()
           
 java.lang.String getInstanceClassName()
          INTERNAL: Returns the Java class name that this type represents.
 java.util.List getInstanceProperties()
           
 java.lang.String getName()
           
 java.util.List getNonFinalizedMappingURIs()
          INTERNAL:
 java.util.List getNonFinalizedReferencingProps()
          INTERNAL:
 java.util.List getProperties()
           
 commonj.sdo.Property[] getPropertiesArray()
          INTERNAL:
 commonj.sdo.Property getProperty(java.lang.String propertyName)
           
 java.util.Map getPropertyValues()
          INTERNAL:
 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.
 java.util.List getSubTypes()
          INTERNAL:
 java.lang.String getURI()
           
 XMLDescriptor getXmlDescriptor()
           
 XMLDescriptor getXmlDescriptor(java.util.List namespaceResolvers)
          INTERNAL: Get the XMLDescriptor associated with this Type or generate a new one.
 java.lang.String getXsdLocalName()
          INTERNAL: Returns the local name of the Property.
 javax.xml.namespace.QName getXsdType()
          INTERNAL:
 boolean isAbstract()
           
 boolean isDataType()
           
 boolean isFinalized()
          INTERNAL:
 boolean isInstance(java.lang.Object object)
           
 boolean isOpen()
           
 boolean isSequenced()
           
 boolean isXsd()
          INTERNAL: Returns if this property was declared in an XML schema.
 boolean isXsdList()
          INTERNAL: Indicates if this Type is an xsd:list in the schema
 void postInitialize()
          INTERNAL:
 void preInitialize(java.lang.String packageName, java.util.List namespaceResolvers)
          INTERNAL: For this Type generate classes
 void removeDeclaredProperties(commonj.sdo.Property p)
          INTERNAL:
 void setAbstract(boolean makeAbstract)
          INTERNAL: Change this Type's abstract setting.
 void setAliasNames(java.util.List names)
          INTERNAL: Assign a list of alias names to a type, which are unique in URI.
 void setAppInfoElements(java.util.List appInfoElementsList)
          INTERNAL:
 void setBaseTypes(java.util.List bTypes)
          INTERNAL: Set a list of Types as This Type's base Types.
 void setDataType(boolean datatype)
          INTERNAL: Set this Type to a simple Type by passing in boolean value true.
 void setFinalized(boolean bFinalized)
          INTERNAL:
 void setImplClassName(java.lang.String implClassName)
          INTERNAL:
 void setInstanceClass(java.lang.Class aClass)
          INTERNAL: Sets the Java class that this type represents.
 void setInstanceClassName(java.lang.String instanceClassName)
          INTERNAL: Sets the name of the Java class that this type represents.
 void setInstanceProperty(commonj.sdo.Property property, java.lang.Object value)
          INTERNAL:
 void setNonFinalizedMappingURIs(java.util.List nonFinalizedMappingURIsList)
          INTERNAL:
 void setNonFinalizedReferencingProps(java.util.List nonFinalizedReferencingProps)
          INTERNAL:
 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, isOpen().
 void setPropertyValues(java.util.Map properties)
          INTERNAL:
 void setPseudoDefault(java.lang.Object anObject)
          INTERNAL: Set an Object wrapper around primitive numeric types
 void setSequenced(boolean sequenced)
          INTERNAL: If set as true, this Type specifies Sequenced DataObjects.
 void setSubTypes(java.util.List subTypesList)
          INTERNAL:
 void setupInheritance(SDOType parentType)
           
 void setUri(java.lang.String uri)
          INTERNAL: Assign a logic uri to this Type.
 void setXmlDescriptor(XMLDescriptor anXMLDescriptor)
          INTERNAL: Set the XMLDescriptor on this Type
 void setXsd(boolean bXsd)
          INTERNAL: Set if this property was declared in an XML schema.
 void setXsdList(boolean anXsdList)
          INTERNAL: Set if this type is an xsd:list in the schema
 void setXsdLocalName(java.lang.String xsdLocalNameString)
          INTERNAL: Set the local name of this property.
 void setXsdType(javax.xml.namespace.QName xsdTypeQName)
          INTERNAL:
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SDOType

public SDOType(commonj.sdo.helper.HelperContext aContext)

SDOType

public SDOType(java.lang.String uri,
               java.lang.String type_name)
INTERNAL: Build up a Type with given name and uri and a default static HelperContext. Use SDOType(uri, typeName, aHelperContext) instead

Parameters:
uri - the URI of this type
type_name - the unique of this Type

SDOType

public SDOType(java.lang.String uri,
               java.lang.String type_name,
               commonj.sdo.helper.HelperContext aContext)
Build up a Type with given name and uri

Parameters:
uri - the URI of this type
type_name - the unique of this Type
aContext - the current HelperContext
Method Detail

getName

public java.lang.String getName()
Specified by:
getName in interface commonj.sdo.Type

getURI

public java.lang.String getURI()
Specified by:
getURI in interface commonj.sdo.Type

getInstanceClass

public java.lang.Class getInstanceClass()
Specified by:
getInstanceClass in interface commonj.sdo.Type

isInstance

public boolean isInstance(java.lang.Object object)
Specified by:
isInstance in interface commonj.sdo.Type

getProperties

public java.util.List getProperties()
Specified by:
getProperties in interface commonj.sdo.Type

getProperty

public commonj.sdo.Property getProperty(java.lang.String propertyName)
Specified by:
getProperty in interface commonj.sdo.Type

isDataType

public boolean isDataType()
Specified by:
isDataType in interface commonj.sdo.Type

isOpen

public boolean isOpen()
Specified by:
isOpen in interface commonj.sdo.Type

isSequenced

public boolean isSequenced()
Specified by:
isSequenced in interface commonj.sdo.Type

isAbstract

public boolean isAbstract()
Specified by:
isAbstract in interface commonj.sdo.Type

getBaseTypes

public java.util.List getBaseTypes()
Specified by:
getBaseTypes in interface commonj.sdo.Type

getDeclaredProperties

public java.util.List getDeclaredProperties()
Specified by:
getDeclaredProperties in interface commonj.sdo.Type

getAliasNames

public java.util.List getAliasNames()
Specified by:
getAliasNames in interface commonj.sdo.Type

addAliasName

public void addAliasName(java.lang.String name)
INTERNAL: Assign a unique string to a type, which belongs to same uri, among types.

Parameters:
name - a unique string representing a type.

setAliasNames

public void setAliasNames(java.util.List names)
INTERNAL: Assign a list of alias names to a type, which are unique in URI.

Parameters:
names - a unique string representing a type.

setUri

public void setUri(java.lang.String uri)
INTERNAL: Assign a logic uri to this Type.

Parameters:
uri - a logic uri of a package or target namespace.

setOpen

public 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, isOpen().

Parameters:
bOpen - boolean value implying if this Type is open

setAbstract

public void setAbstract(boolean makeAbstract)
INTERNAL: Change this Type's abstract setting. If it is true, this Type can't be instantiated and typically serve as base Type.

Parameters:
makeAbstract - boolean value implying if this Type is abstract.

setSequenced

public void setSequenced(boolean sequenced)
INTERNAL: If set as true, this Type specifies Sequenced DataObjects.

Parameters:
sequenced - boolean value implying if this type is sequenced.

setDataType

public void setDataType(boolean datatype)
INTERNAL: Set this Type to a simple Type by passing in boolean value true. Otherwise, If boolean value is passed in, instances of this type implement DataObject.

Parameters:
datatype - boolean value implying if it is a simple Type

setBaseTypes

public void setBaseTypes(java.util.List bTypes)
INTERNAL: Set a list of Types as This Type's base Types.

Parameters:
bTypes - a list types to become this Type's base Type.

addBaseType

public void addBaseType(SDOType type)
INTERNAL:

Parameters:
type - a type to become this Type's base Type.

setInstanceClass

public void setInstanceClass(java.lang.Class aClass)
INTERNAL: Sets the Java class that this type represents.

Parameters:
aClass - the Java class that this type represents.

setXsd

public void setXsd(boolean bXsd)
INTERNAL: Set if this property was declared in an XML schema.

Parameters:
bXsd - a boolean representing if this property was declared in an XML schema

isXsd

public boolean isXsd()
INTERNAL: Returns if this property was declared in an XML schema. Defaults to false.

Returns:
if this property was declared in an XML schema

setXsdLocalName

public void setXsdLocalName(java.lang.String xsdLocalNameString)
INTERNAL: Set the local name of this property.

Parameters:
xsdLocalName - a String representing the local name of this property if it was declared in an XML schema

getXsdLocalName

public java.lang.String getXsdLocalName()
INTERNAL: Returns the local name of the Property.

Returns:
the local name of the property.

addDeclaredProperty

public void addDeclaredProperty(commonj.sdo.Property property)
INTERNAL:

Parameters:
property -

addDeclaredProperty

public void addDeclaredProperty(commonj.sdo.Property property,
                                int index)
INTERNAL:

Parameters:
property -

removeDeclaredProperties

public void removeDeclaredProperties(commonj.sdo.Property p)
INTERNAL:


getDeclaredPropertiesMap

public java.util.Map getDeclaredPropertiesMap()
INTERNAL:


equals

public boolean equals(java.lang.Object object)
Overrides:
equals in class java.lang.Object

setInstanceClassName

public void setInstanceClassName(java.lang.String instanceClassName)
INTERNAL: Sets the name of the Java class that this type represents.

Parameters:
instanceClassName - the Java class that this type represents.

getInstanceClassName

public java.lang.String getInstanceClassName()
INTERNAL: Returns the Java class name that this type represents.

Returns:
the Java class name.

setXsdList

public void setXsdList(boolean anXsdList)
INTERNAL: Set if this type is an xsd:list in the schema

Parameters:
xsdList - a boolean representing if this type represents an xsd:list in the schema

isXsdList

public boolean isXsdList()
INTERNAL: Indicates if this Type is an xsd:list in the schema

Returns:
true if this Type represents an xsd:list in the schema

setXmlDescriptor

public void setXmlDescriptor(XMLDescriptor anXMLDescriptor)
INTERNAL: Set the XMLDescriptor on this Type

Parameters:
anXMLDescriptor -

getXmlDescriptor

public XMLDescriptor getXmlDescriptor()

getXmlDescriptor

public XMLDescriptor getXmlDescriptor(java.util.List namespaceResolvers)
INTERNAL: Get the XMLDescriptor associated with this Type or generate a new one.


setupInheritance

public void setupInheritance(SDOType parentType)

preInitialize

public void preInitialize(java.lang.String packageName,
                          java.util.List namespaceResolvers)
INTERNAL: For this Type generate classes

Parameters:
packageName -
nr -

postInitialize

public void postInitialize()
INTERNAL:


setImplClassName

public void setImplClassName(java.lang.String implClassName)
INTERNAL:


getImplClassName

public java.lang.String getImplClassName()
INTERNAL:


getImplClass

public java.lang.Class getImplClass()
INTERNAL:


get

public java.lang.Object get(commonj.sdo.Property property)
Specified by:
get in interface commonj.sdo.Type

getInstanceProperties

public java.util.List getInstanceProperties()
Specified by:
getInstanceProperties in interface commonj.sdo.Type

setPropertyValues

public void setPropertyValues(java.util.Map properties)
INTERNAL:


getPropertyValues

public java.util.Map getPropertyValues()
INTERNAL:


setInstanceProperty

public void setInstanceProperty(commonj.sdo.Property property,
                                java.lang.Object value)
INTERNAL:

Parameters:
property -
value -

getChangeSummaryProperty

public commonj.sdo.Property getChangeSummaryProperty()
INTERNAL:


getPropertiesArray

public commonj.sdo.Property[] getPropertiesArray()
INTERNAL:


setSubTypes

public void setSubTypes(java.util.List subTypesList)
INTERNAL:


getSubTypes

public java.util.List getSubTypes()
INTERNAL:


setXsdType

public void setXsdType(javax.xml.namespace.QName xsdTypeQName)
INTERNAL:


getXsdType

public javax.xml.namespace.QName getXsdType()
INTERNAL:


setFinalized

public void setFinalized(boolean bFinalized)
INTERNAL:


isFinalized

public boolean isFinalized()
INTERNAL:


setNonFinalizedReferencingProps

public void setNonFinalizedReferencingProps(java.util.List nonFinalizedReferencingProps)
INTERNAL:


getNonFinalizedReferencingProps

public java.util.List getNonFinalizedReferencingProps()
INTERNAL:


setNonFinalizedMappingURIs

public void setNonFinalizedMappingURIs(java.util.List nonFinalizedMappingURIsList)
INTERNAL:


getNonFinalizedMappingURIs

public java.util.List getNonFinalizedMappingURIs()
INTERNAL:


setAppInfoElements

public void setAppInfoElements(java.util.List appInfoElementsList)
INTERNAL:


getAppInfoElements

public java.util.List getAppInfoElements()
INTERNAL:


getAppInfoMap

public java.util.Map getAppInfoMap()
INTERNAL:


getPseudoDefault

public 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. See p.85 Sect 9.3 of the SDO Spec.

Returns:
aDefault Object (primitive numerics) or null (DataObjects, String, Lists)

setPseudoDefault

public void setPseudoDefault(java.lang.Object anObject)
INTERNAL: Set an Object wrapper around primitive numeric types

Parameters:
anObject -

getHelperContext

public commonj.sdo.helper.HelperContext getHelperContext()
Return the HelperContext object associated with this type. For example, the typeHelper associated with the returned HelperContext would contain this type


EclipseLink 1.0_1.0 M6.1 - 20080422 API Reference - Incubation