java.lang.Object
org.eclipse.persistence.sdo.SDOType
- All Implemented Interfaces:
Type,Serializable
- Direct Known Subclasses:
SDOChangeSummaryType,SDODataObjectType,SDODataType,SDOObjectType,SDOOpenSequencedType,SDOPropertyType,SDOTypeType,SDOWrapperType,SDOXMLHelperLoadOptionsType
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected HelperContextprotected booleanprotected Class<?>protected org.eclipse.persistence.oxm.XMLDescriptor -
Constructor Summary
ConstructorsModifierConstructorDescriptionSDOType(HelperContext helperContext) INTERNAL: Build up a Type with given name and uri and a default static HelperContext.SDOType(String uri, String name, SDOTypeHelper sdoTypeHelper) Build up a Type with given name and uriprotectedSDOType(String uri, String name, SDOTypeHelper sdoTypeHelper, org.eclipse.persistence.oxm.XMLDescriptor xmlDescriptor) SDOType(SDOTypeHelper sdoTypeHelper) protectedSDOType(SDOTypeHelper sdoTypeHelper, org.eclipse.persistence.oxm.XMLDescriptor xmlDescriptor) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddAliasName(String name) INTERNAL: Assign a unique string to a type, which belongs to same uri, among types.voidaddBaseType(SDOType type) INTERNAL:voidaddDeclaredProperty(Property property) INTERNAL:voidaddDeclaredProperty(Property property, int index) INTERNAL:voidaddDeclaredProperty(SDOProperty property) INTERNAL:voidaddDeclaredProperty(SDOProperty property, int index) INTERNAL:Returns the value of the specified instance property of this Type.Return a list of alias names for this Type.INTERNAL:INTERNAL:Returns the List of base Types for this Type.INTERNAL:Returns the Properties declared in this Type as opposed to those declared in base Types.INTERNAL:Return the HelperContext object associated with this type.Class<?>INTERNAL:INTERNAL:Class<?>Returns the Java class that this type represents.INTERNAL: Returns the Java class name that this type represents.Returns a read-only List of instance Properties available on this Type.getName()Returns the name of the type.INTERNAL:INTERNAL:Returns the List of thePropertiesof this type.INTERNAL:getProperty(String propertyName) Returns fromall the Propertiesof this type, the one with the specified name.INTERNAL:INTERNAL: Return the wrapped initial value for the primitive numeric (when not defined) See p.45 of Java Spec 4th edition.getQName()INTERNAL:getURI()Returns the namespace URI of the type ornullif the type has no URI (for example it was generated from a Schema with no target namespace).org.eclipse.persistence.oxm.XMLDescriptorINTERNAL: Returns the local name of the Property.INTERNAL:voidinitializeNamespaces(List namespaceResolvers) INTERNAL: Get the XMLDescriptor associated with this Type or generate a new one.booleanIndicates if this Type is abstract.booleanINTERNAL: Provide a means to determine if this type has sub types without causing the sub types property to be initialized.booleanbooleanbooleanIndicates if this Type specifies DataTypes (true) or DataObjects (false).booleanINTERNAL:booleanisInstance(Object object) Returns whether the specified object is an instance of this type.booleanisOpen()Indicates if this Type allows any form of open content.booleanbooleanIndicates if this Type specifies Sequenced DataObjects.booleanINTERNAL: Provide a means to determine if this type has base types without causing the base types property to be initialized.booleanbooleanbooleanisXsd()INTERNAL: Returns if this property was declared in an XML schema.booleanINTERNAL: Indicates if this Type is an xsd:list in the schemavoidINTERNAL:voidpreInitialize(String packageName, List namespaceResolvers) INTERNAL: For this Type generate classesvoidINTERNAL:voidsetAbstract(boolean makeAbstract) INTERNAL: Change this Type's abstract setting.voidsetAliasNames(List names) INTERNAL: Assign a list of alias names to a type, which are unique in URI.voidsetAppInfoElements(List appInfoElementsList) INTERNAL:voidsetBaseTypes(List bTypes) INTERNAL: Set a list of Types as This Type's base Types.voidsetDataType(boolean datatype) INTERNAL: Set this Type to a simple Type by passing in boolean value true.voidsetFinalized(boolean bFinalized) INTERNAL:voidsetImplClassName(String implClassName) INTERNAL:voidsetInstanceClass(Class<?> aClass) INTERNAL: Sets the Java class that this type represents.voidsetInstanceClassName(String instanceClassName) INTERNAL: Sets the name of the Java class that this type represents.voidsetInstanceProperty(Property property, Object value) INTERNAL:voidsetMixed(boolean isMixed) voidsetNonFinalizedMappingURIs(List nonFinalizedMappingURIsList) INTERNAL:voidsetNonFinalizedReferencingProps(List nonFinalizedReferencingProps) INTERNAL:voidsetOpen(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().voidsetPropertyValues(Map properties) INTERNAL:voidsetPseudoDefault(Object anObject) INTERNAL: Set an Object wrapper around primitive numeric typesvoidvoidsetSequenced(boolean sequenced) INTERNAL: If set as true, this Type specifies Sequenced DataObjects.voidsetSubTypes(List subTypesList) INTERNAL:voidsetupInheritance(SDOType parentType) voidsetXmlDescriptor(org.eclipse.persistence.oxm.XMLDescriptor anXMLDescriptor) INTERNAL: Set the XMLDescriptor on this TypevoidsetXsd(boolean bXsd) INTERNAL: Set if this property was declared in an XML schema.voidsetXsdList(boolean anXsdList) INTERNAL: Set if this type is an xsd:list in the schemavoidsetXsdLocalName(String xsdLocalNameString) INTERNAL: Set the local name of this property.voidsetXsdType(QName xsdTypeQName) INTERNAL:
-
Field Details
-
isDataType
protected boolean isDataType -
xmlDescriptor
protected transient org.eclipse.persistence.oxm.XMLDescriptor xmlDescriptor -
javaImplClass
-
aHelperContext
-
-
Constructor Details
-
SDOType
-
SDOType
-
SDOType
protected SDOType(SDOTypeHelper sdoTypeHelper, org.eclipse.persistence.oxm.XMLDescriptor xmlDescriptor) -
SDOType
INTERNAL: Build up a Type with given name and uri and a default static HelperContext. UseSDOType(String, String, org.eclipse.persistence.sdo.helper.SDOTypeHelper)instead- Parameters:
uri- the URI of this typetype_name- the unique of this Type
-
SDOType
Build up a Type with given name and uri- Parameters:
uri- the URI of this typename- the unique of this TypesdoTypeHelper- the current HelperContext
-
SDOType
protected SDOType(String uri, String name, SDOTypeHelper sdoTypeHelper, org.eclipse.persistence.oxm.XMLDescriptor xmlDescriptor)
-
-
Method Details
-
getQName
-
setQName
-
getName
Description copied from interface:TypeReturns the name of the type. -
getURI
Description copied from interface:TypeReturns the namespace URI of the type ornullif the type has no URI (for example it was generated from a Schema with no target namespace). -
getInstanceClass
Description copied from interface:TypeReturns the Java class that this type represents.- Specified by:
getInstanceClassin interfaceType- Returns:
- the Java class.
-
isInstance
Description copied from interface:TypeReturns whether the specified object is an instance of this type.- Specified by:
isInstancein interfaceType- Parameters:
object- the object in question.- Returns:
trueif the object is an instance.- See Also:
-
getProperties
Description copied from interface:TypeReturns the List of thePropertiesof this type.The expression
type.getProperties().indexOf(property)
yields the property's index relative to this type. As such, these expressions are equivalent:dataObject.get(i) dataObject.get((Property)dataObject.getType().getProperties().get(i));- Specified by:
getPropertiesin interfaceType- Returns:
- the Properties of the type.
- See Also:
-
getProperty
Description copied from interface:TypeReturns fromall the Propertiesof this type, the one with the specified name. As such, these expressions are equivalent:dataObject.get("name") dataObject.get(dataObject.getType().getProperty("name"))- Specified by:
getPropertyin interfaceType- Returns:
- the Property with the specified name.
- See Also:
-
isDataType
public boolean isDataType()Description copied from interface:TypeIndicates 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:
isDataTypein interfaceType- Returns:
- true if Type specifies DataTypes, false for DataObjects.
-
isOpen
public boolean isOpen()Description copied from interface:TypeIndicates 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. -
isSequenced
public boolean isSequenced()Description copied from interface:TypeIndicates 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:
isSequencedin interfaceType- Returns:
- true if this Type specifies Sequenced DataObjects.
-
isAbstract
public boolean isAbstract()Description copied from interface:TypeIndicates 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:
isAbstractin interfaceType- Returns:
- true if this Type is abstract.
-
getBaseTypes
Description copied from interface:TypeReturns 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:
getBaseTypesin interfaceType- Returns:
- the List of base Types for this 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
Description copied from interface:TypeReturns the Properties declared in this Type as opposed to those declared in base Types.- Specified by:
getDeclaredPropertiesin interfaceType- Returns:
- the Properties declared in this Type.
-
getAliasNames
Description copied from interface:TypeReturn a list of alias names for this Type.- Specified by:
getAliasNamesin interfaceType- Returns:
- a list of alias names for this Type.
-
addAliasName
INTERNAL: Assign a unique string to a type, which belongs to same uri, among types.- Parameters:
name- a unique string representing a type.
-
setAliasNames
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
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
INTERNAL:- Parameters:
type- a type to become this Type's base Type.
-
setInstanceClass
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
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
INTERNAL: Returns the local name of the Property.- Returns:
- the local name of the property.
-
addDeclaredProperty
INTERNAL:- Parameters:
property-
-
addDeclaredProperty
INTERNAL:- Parameters:
property-
-
addDeclaredProperty
INTERNAL:- Parameters:
property-
-
addDeclaredProperty
INTERNAL:- Parameters:
property-
-
removeDeclaredProperties
INTERNAL: -
getDeclaredPropertiesMap
INTERNAL: -
setInstanceClassName
INTERNAL: Sets the name of the Java class that this type represents.- Parameters:
instanceClassName- the Java class that this type represents.
-
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(org.eclipse.persistence.oxm.XMLDescriptor anXMLDescriptor) INTERNAL: Set the XMLDescriptor on this Type- Parameters:
anXMLDescriptor-
-
getXmlDescriptor
public org.eclipse.persistence.oxm.XMLDescriptor getXmlDescriptor() -
initializeNamespaces
INTERNAL: Get the XMLDescriptor associated with this Type or generate a new one. -
setupInheritance
-
preInitialize
INTERNAL: For this Type generate classes- Parameters:
packageName-namespaceResolvers-
-
postInitialize
public void postInitialize()INTERNAL: -
setImplClassName
INTERNAL: -
getImplClassName
INTERNAL: -
getImplClass
INTERNAL: -
get
Description copied from interface:TypeReturns the value of the specified instance property of this Type.- Specified by:
getin interfaceType- Parameters:
property- one of the properties returned byType.getInstanceProperties().- Returns:
- the value of the specified property.
- See Also:
-
getInstanceProperties
Description copied from interface:TypeReturns a read-only List of instance Properties available on this Type.This list includes, at a minimum, any open content properties (extensions) added to the object before
defining the Type's Type. Implementations may, but are not required to in the 2.1 version of SDO, provide additional instance properties.- Specified by:
getInstancePropertiesin interfaceType- Returns:
- the List of instance Properties on this Type.
-
setPropertyValues
INTERNAL: -
getPropertyValues
INTERNAL: -
setInstanceProperty
INTERNAL:- Parameters:
property-value-
-
getChangeSummaryProperty
INTERNAL: -
getPropertiesArray
INTERNAL: -
setSubTypes
INTERNAL: -
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
INTERNAL: -
getXsdType
INTERNAL: -
setFinalized
public void setFinalized(boolean bFinalized) INTERNAL: -
isFinalized
public boolean isFinalized()INTERNAL: -
setNonFinalizedReferencingProps
INTERNAL: -
getNonFinalizedReferencingProps
INTERNAL: -
setNonFinalizedMappingURIs
INTERNAL: -
getNonFinalizedMappingURIs
INTERNAL: -
setAppInfoElements
INTERNAL: -
getAppInfoElements
INTERNAL: -
getAppInfoMap
INTERNAL: -
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
INTERNAL: Set an Object wrapper around primitive numeric types- Parameters:
anObject-
-
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()
-