Skip navigation links

org.eclipse.persistence.sdo
Class SDOType

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SDOChangeSummaryType, SDODataObjectType, SDODataType, SDOObjectType, SDOOpenSequencedType, SDOPropertyType, SDOTypeType, SDOWrapperType, SDOXMLHelperLoadOptionsType

public class SDOType

extends java.lang.Object

implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

static class

SDOType.TypeInstantiationPolicy

Field Summary

protected HelperContext	aHelperContext
private java.util.List	aliasNames
private java.util.List	allProperties
private SDOProperty[]	allPropertiesArr
private static java.lang.String	ANY_MAPPING_ATTRIBUTE_NAME Open Content setOpen constants
private static java.lang.String	ANY_MAPPING_GET_METHOD_NAME
private static java.lang.String	ANY_MAPPING_SET_METHOD_NAME
private java.util.List	appInfoElements
private java.util.Map	appInfoMap
private java.util.List	baseTypes
private SDOProperty	changeSummaryProperty
private java.util.List	declaredProperties
private java.util.Map	declaredPropertiesMap
private static java.lang.Class[]	EMPTY_CLASS_ARRAY
private boolean	finalized
private boolean	isAbstract
protected boolean	isDataType
private java.lang.Class	javaClass
private java.lang.String	javaClassName
protected java.lang.Class	javaImplClass
private java.lang.String	javaImplClassName
private java.util.List	nonFinalizedMappingURIs
private java.util.List<SDOProperty>	nonFinalizedReferencingProps
private boolean	open
private java.util.Map	propertyValues
private java.lang.Object	pseudoDefault hold a wrapper object for primitive numeric defaults
private javax.xml.namespace.QName	qName
private static java.lang.String	SDO_REF_MAPPING_ATTRIBUTE_NAME
private java.util.List	subTypes
protected XMLDescriptor	xmlDescriptor
private boolean	xsd
private boolean	xsdList
private java.lang.String	xsdLocalName
private javax.xml.namespace.QName	xsdType

Constructor Summary

	SDOType(HelperContext helperContext)
protected	SDOType(SDOTypeHelper sdoTypeHelper, XMLDescriptor xmlDescriptor)
	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
protected	SDOType(java.lang.String uri, java.lang.String name, SDOTypeHelper sdoTypeHelper, XMLDescriptor xmlDescriptor)

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:
private void	addClassIndicator(XMLDescriptor xdesc, java.lang.Class pCls, boolean isInheritanceRoot) INTERNAL: Convenience method that sets up class indicator and @sdoRef attribute.
void	addDeclaredProperty(Property property) INTERNAL:
void	addDeclaredProperty(Property property, int index) INTERNAL:
private void	addOpenMappings()
java.lang.Object	get(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:
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()
private boolean	isValidInstanceClass(java.lang.Class clazz) Verify that the class is a valid instance class.
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(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(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:
private void	updateIndices(int insertPosition, Property property)
private void	updateSubtypes(Type baseType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_CLASS_ARRAY

private static final java.lang.Class[] EMPTY_CLASS_ARRAY

qName

private javax.xml.namespace.QName qName

open

private boolean open

isAbstract

private boolean isAbstract

isDataType

protected boolean isDataType

baseTypes

private java.util.List baseTypes

declaredProperties

private java.util.List declaredProperties

declaredPropertiesMap

private transient java.util.Map declaredPropertiesMap

aliasNames

private java.util.List aliasNames

xsd

private boolean xsd

xsdList

private boolean xsdList

xsdLocalName

private java.lang.String xsdLocalName

xsdType

private javax.xml.namespace.QName xsdType

xmlDescriptor

protected transient XMLDescriptor xmlDescriptor

propertyValues

private java.util.Map propertyValues

changeSummaryProperty

private SDOProperty changeSummaryProperty

allProperties

private java.util.List allProperties

allPropertiesArr

private SDOProperty[] allPropertiesArr

subTypes

private java.util.List subTypes

finalized

private boolean finalized

javaClass

private java.lang.Class javaClass

javaClassName

private java.lang.String javaClassName

javaImplClassName

private java.lang.String javaImplClassName

javaImplClass

protected java.lang.Class javaImplClass

nonFinalizedReferencingProps

private java.util.List<SDOProperty> nonFinalizedReferencingProps

nonFinalizedMappingURIs

private java.util.List nonFinalizedMappingURIs

pseudoDefault

private java.lang.Object pseudoDefault

hold a wrapper object for primitive numeric defaults

aHelperContext

protected HelperContext aHelperContext

appInfoElements

private java.util.List appInfoElements

appInfoMap

private java.util.Map appInfoMap

ANY_MAPPING_ATTRIBUTE_NAME

private static final java.lang.String ANY_MAPPING_ATTRIBUTE_NAME

Open Content setOpen constants

See Also:

Constant Field Values

ANY_MAPPING_GET_METHOD_NAME

private static final java.lang.String ANY_MAPPING_GET_METHOD_NAME

See Also:

Constant Field Values

ANY_MAPPING_SET_METHOD_NAME

private static final java.lang.String ANY_MAPPING_SET_METHOD_NAME

See Also:

Constant Field Values

SDO_REF_MAPPING_ATTRIBUTE_NAME

private static final java.lang.String SDO_REF_MAPPING_ATTRIBUTE_NAME

See Also:

Constant Field Values

Constructor Detail

SDOType

public SDOType(HelperContext helperContext)

SDOType

protected SDOType(SDOTypeHelper sdoTypeHelper,
                  XMLDescriptor xmlDescriptor)

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 name,
               SDOTypeHelper sdoTypeHelper)

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

SDOType

protected SDOType(java.lang.String uri,
                  java.lang.String name,
                  SDOTypeHelper sdoTypeHelper,
                  XMLDescriptor xmlDescriptor)

Method Detail

getQName

public javax.xml.namespace.QName getQName()

setQName

public void setQName(javax.xml.namespace.QName qName)

getName

public java.lang.String getName()

getURI

public java.lang.String getURI()

getInstanceClass

public java.lang.Class getInstanceClass()

isValidInstanceClass

private boolean isValidInstanceClass(java.lang.Class clazz)

Verify that the class is a valid instance class.

isInstance

public boolean isInstance(java.lang.Object object)

getProperties

public java.util.List getProperties()

getProperty

public SDOProperty getProperty(java.lang.String propertyName)

isDataType

public boolean isDataType()

isOpen

public boolean isOpen()

isSequenced

public boolean isSequenced()

isAbstract

public boolean isAbstract()

getBaseTypes

public java.util.List getBaseTypes()

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()

getAliasNames

public java.util.List getAliasNames()

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

addOpenMappings

private void addOpenMappings()

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.

updateSubtypes

private void updateSubtypes(Type baseType)

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(Property property)

INTERNAL:

Parameters:

property -

addDeclaredProperty

public void addDeclaredProperty(Property property,
                                int index)

INTERNAL:

Parameters:

property -

removeDeclaredProperties

public void removeDeclaredProperties(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:

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()

initializeNamespaces

public void initializeNamespaces(java.util.List namespaceResolvers)

INTERNAL: Get the XMLDescriptor associated with this Type or generate a new one.

addClassIndicator

private void addClassIndicator(XMLDescriptor xdesc,
                               java.lang.Class pCls,
                               boolean isInheritanceRoot)

INTERNAL: Convenience method that sets up class indicator and @sdoRef attribute.

Parameters:

xdesc -

pCls -

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(Property property)

getInstanceProperties

public java.util.List getInstanceProperties()

setPropertyValues

public void setPropertyValues(java.util.Map properties)

INTERNAL:

getPropertyValues

public java.util.Map getPropertyValues()

INTERNAL:

setInstanceProperty

public void setInstanceProperty(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.

updateIndices

private void updateIndices(int insertPosition,
                           Property property)

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 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()

Skip navigation links