SDOType (EclipseLink 2.6.3, "build v20160428-59c81c5" API Reference)

java.lang.Object
- org.eclipse.persistence.sdo.SDOType

All Implemented Interfaces:

commonj.sdo.Type, java.io.Serializable

Direct Known Subclasses:

SDOChangeSummaryType, SDODataObjectType, SDODataType, SDOObjectType, SDOOpenSequencedType, SDOPropertyType, SDOTypeType, SDOWrapperType, SDOXMLHelperLoadOptionsType
```
public class SDOType
extends java.lang.Object
implements commonj.sdo.Type, java.io.Serializable
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SDOType.TypeInstantiationPolicy

Nested Classes
Modifier and Type	Class and Description
`static class`	`SDOType.TypeInstantiationPolicy`

Constructor Summary

Constructors
Constructor and Description
`SDOType(commonj.sdo.helper.HelperContext helperContext)`
`SDOType(SDOTypeHelper sdoTypeHelper)`
`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 name, SDOTypeHelper sdoTypeHelper)` Build up a Type with given name and uri

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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:
`void`	`addDeclaredProperty(SDOProperty property)` INTERNAL:
`void`	`addDeclaredProperty(SDOProperty property, int index)` INTERNAL:
`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()`
`SDOProperty`	`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()`
`SDOProperty[]`	`getPropertiesArray()` INTERNAL:
`SDOProperty`	`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.
`javax.xml.namespace.QName`	`getQName()`
`java.util.List`	`getSubTypes()` INTERNAL:
`java.lang.String`	`getURI()`
`XMLDescriptor`	`getXmlDescriptor()`
`java.lang.String`	`getXsdLocalName()` INTERNAL: Returns the local name of the Property.
`javax.xml.namespace.QName`	`getXsdType()` INTERNAL:
`void`	`initializeNamespaces(java.util.List namespaceResolvers)` INTERNAL: Get the XMLDescriptor associated with this Type or generate a new one.
`boolean`	`isAbstract()`
`boolean`	`isBaseType()` INTERNAL: Provide a means to determine if this type has sub types without causing the sub types property to be initialized.
`boolean`	`isChangeSummaryType()`
`boolean`	`isDataObjectType()`
`boolean`	`isDataType()`
`boolean`	`isFinalized()` INTERNAL:
`boolean`	`isInstance(java.lang.Object object)`
`boolean`	`isOpen()`
`boolean`	`isOpenSequencedType()`
`boolean`	`isSequenced()`
`boolean`	`isSubType()` INTERNAL: Provide a means to determine if this type has base types without causing the base types property to be initialized.
`boolean`	`isTypeType()`
`boolean`	`isWrapperType()`
`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`	`setMixed(boolean isMixed)`
`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`	`setQName(javax.xml.namespace.QName qName)`
`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`	`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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SDOType
```
public SDOType(commonj.sdo.helper.HelperContext helperContext)
```
  - SDOType
```
public SDOType(SDOTypeHelper sdoTypeHelper)
```
  - 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(String, String, org.eclipse.persistence.sdo.helper.SDOTypeHelper) 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 name,
               SDOTypeHelper sdoTypeHelper)
```
    Build up a Type with given name and uri
    
    Parameters:
    
    uri - the URI of this type
    
    name - the unique of this Type
    
    sdoTypeHelper - the current HelperContext
- Method Detail
  - getQName
```
public javax.xml.namespace.QName getQName()
```
  - setQName
```
public void setQName(javax.xml.namespace.QName qName)
```
  - 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 SDOProperty 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
  - isSubType
```
public boolean isSubType()
```
    INTERNAL: Provide a means to determine if this type has base types without causing the base types property to be initialized.
  - 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.
  - 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.
  - setMixed
```
public void setMixed(boolean isMixed)
```
  - 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:
    
    xsdLocalNameString - 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(SDOProperty property)
```
    INTERNAL:
    
    Parameters:
    
    property -
  - addDeclaredProperty
```
public void addDeclaredProperty(commonj.sdo.Property property,
                                int index)
```
    INTERNAL:
    
    Parameters:
    
    property -
  - addDeclaredProperty
```
public void addDeclaredProperty(SDOProperty property,
                                int index)
```
    INTERNAL:
    
    Parameters:
    
    property -
  - removeDeclaredProperties
```
public void removeDeclaredProperties(commonj.sdo.Property p)
```
    INTERNAL:
  - getDeclaredPropertiesMap
```
public java.util.Map getDeclaredPropertiesMap()
```
    INTERNAL:
  - 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:
    
    anXsdList - 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()
```
  - initializeNamespaces
```
public void initializeNamespaces(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 -
    
    namespaceResolvers -
  - 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 SDOProperty getChangeSummaryProperty()
```
    INTERNAL:
  - getPropertiesArray
```
public SDOProperty[] getPropertiesArray()
```
    INTERNAL:
  - setSubTypes
```
public void setSubTypes(java.util.List subTypesList)
```
    INTERNAL:
  - getSubTypes
```
public java.util.List getSubTypes()
```
    INTERNAL:
  - isBaseType
```
public boolean isBaseType()
```
    INTERNAL: Provide a means to determine if this type has sub types without causing the sub types property to be initialized.
  - 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
  - isChangeSummaryType
```
public boolean isChangeSummaryType()
```
  - isDataObjectType
```
public boolean isDataObjectType()
```
  - isTypeType
```
public boolean isTypeType()
```
  - isOpenSequencedType
```
public boolean isOpenSequencedType()
```
  - isWrapperType
```
public boolean isWrapperType()
```

Class SDOType

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SDOType

SDOType

SDOType

SDOType

Method Detail

getQName

setQName

getName

getURI

getInstanceClass

isInstance

getProperties

getProperty

isDataType

isOpen

isSequenced

isAbstract

getBaseTypes

isSubType

getDeclaredProperties

getAliasNames

addAliasName

setAliasNames

setOpen

setAbstract

setSequenced

setMixed

setDataType

setBaseTypes

addBaseType

setInstanceClass

setXsd

isXsd

setXsdLocalName

getXsdLocalName

addDeclaredProperty

addDeclaredProperty

addDeclaredProperty

addDeclaredProperty

removeDeclaredProperties

getDeclaredPropertiesMap

setInstanceClassName

getInstanceClassName

setXsdList

isXsdList

setXmlDescriptor

getXmlDescriptor

initializeNamespaces

setupInheritance

preInitialize

postInitialize

setImplClassName

getImplClassName

getImplClass

get

getInstanceProperties

setPropertyValues

getPropertyValues

setInstanceProperty

getChangeSummaryProperty

getPropertiesArray

setSubTypes

getSubTypes

isBaseType

setXsdType

getXsdType

setFinalized

isFinalized

setNonFinalizedReferencingProps

getNonFinalizedReferencingProps

setNonFinalizedMappingURIs

getNonFinalizedMappingURIs

setAppInfoElements

getAppInfoElements