|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.persistence.sdo.SDOType
public class SDOType
Nested Class Summary | |
---|---|
static class |
SDOType.TypeInstantiationPolicy
|
Field Summary | |
---|---|
protected HelperContext |
aHelperContext
|
protected boolean |
isDataType
|
protected java.lang.Class |
javaImplClass
|
protected XMLDescriptor |
xmlDescriptor
|
Constructor Summary | |
---|---|
|
SDOType(HelperContext helperContext)
|
|
SDOType(SDOTypeHelper sdoTypeHelper)
|
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: |
void |
addDeclaredProperty(Property property)
INTERNAL: |
void |
addDeclaredProperty(Property property,
int index)
INTERNAL: |
void |
addDeclaredProperty(SDOProperty property)
INTERNAL: |
void |
addDeclaredProperty(SDOProperty property,
int index)
INTERNAL: |
java.lang.Object |
get(Property property)
Returns the value of the specified instance property of this Type. |
java.util.List |
getAliasNames()
Return a list of alias names for this Type. |
java.util.List |
getAppInfoElements()
INTERNAL: |
java.util.Map |
getAppInfoMap()
INTERNAL: |
java.util.List |
getBaseTypes()
Returns the List of base Types for this Type. |
SDOProperty |
getChangeSummaryProperty()
INTERNAL: |
java.util.List |
getDeclaredProperties()
Returns the Properties declared in this Type as opposed to those declared in base Types. |
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()
Returns the Java class that this type represents. |
java.lang.String |
getInstanceClassName()
INTERNAL: Returns the Java class name that this type represents. |
java.util.List |
getInstanceProperties()
Returns a read-only List of instance Properties available on this Type. |
java.lang.String |
getName()
Returns the name of the type. |
java.util.List |
getNonFinalizedMappingURIs()
INTERNAL: |
java.util.List |
getNonFinalizedReferencingProps()
INTERNAL: |
java.util.List |
getProperties()
Returns the List of the Properties of this type. |
SDOProperty[] |
getPropertiesArray()
INTERNAL: |
SDOProperty |
getProperty(java.lang.String propertyName)
Returns from all the Properties of this type, the one with the specified name. |
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()
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()
|
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()
Indicates if this Type is abstract. |
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()
Indicates if this Type specifies DataTypes (true) or DataObjects (false). |
boolean |
isFinalized()
INTERNAL: |
boolean |
isInstance(java.lang.Object object)
Returns whether the specified object is an instance of this type. |
boolean |
isOpen()
Indicates if this Type allows any form of open content. |
boolean |
isOpenSequencedType()
|
boolean |
isSequenced()
Indicates if this Type specifies Sequenced DataObjects. |
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(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: |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected boolean isDataType
protected transient XMLDescriptor xmlDescriptor
protected java.lang.Class javaImplClass
protected HelperContext aHelperContext
Constructor Detail |
---|
public SDOType(HelperContext helperContext)
public SDOType(SDOTypeHelper sdoTypeHelper)
protected SDOType(SDOTypeHelper sdoTypeHelper, XMLDescriptor xmlDescriptor)
public SDOType(java.lang.String uri, java.lang.String type_name)
SDOType(uri, typeName, aHelperContext)
instead
uri
- the URI of this typetype_name
- the unique of this Typepublic SDOType(java.lang.String uri, java.lang.String name, SDOTypeHelper sdoTypeHelper)
uri
- the URI of this typetype_name
- the unique of this TypeaContext
- the current HelperContextprotected SDOType(java.lang.String uri, java.lang.String name, SDOTypeHelper sdoTypeHelper, XMLDescriptor xmlDescriptor)
Method Detail |
---|
public javax.xml.namespace.QName getQName()
public void setQName(javax.xml.namespace.QName qName)
public java.lang.String getName()
Type
getName
in interface Type
public java.lang.String getURI()
Type
null
if the type has no URI
(for example it was generated from a Schema with no target namespace).
getURI
in interface Type
public java.lang.Class getInstanceClass()
Type
getInstanceClass
in interface Type
public boolean isInstance(java.lang.Object object)
Type
isInstance
in interface Type
object
- the object in question.
true
if the object is an instance.Class.isInstance(java.lang.Object)
public java.util.List getProperties()
Type
Properties
of 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));
getProperties
in interface Type
Property.getContainingType()
public SDOProperty getProperty(java.lang.String propertyName)
Type
all the Properties
of this type, the one with the specified name.
As such, these expressions are equivalent:
dataObject.get
("name") dataObject.get
(dataObject.getType().getProperty("name"))
getProperty
in interface Type
Type.getProperties()
public boolean isDataType()
Type
isInstance(object) && !isDataType() implies DataObject.class.isInstance(object) returns true.
isDataType
in interface Type
public boolean isOpen()
Type
isOpen
in interface Type
public boolean isSequenced()
Type
Sequence elements = dataObject.getSequence
();
isSequenced
in interface Type
public boolean isAbstract()
Type
isAbstract
in interface Type
public java.util.List getBaseTypes()
Type
getBaseTypes
in interface Type
public boolean isSubType()
public java.util.List getDeclaredProperties()
Type
getDeclaredProperties
in interface Type
public java.util.List getAliasNames()
Type
getAliasNames
in interface Type
public void addAliasName(java.lang.String name)
name
- a unique string representing a type.public void setAliasNames(java.util.List names)
names
- a unique string representing a type.public void setOpen(boolean bOpen)
isOpen()
.
bOpen
- boolean value implying if this Type is openpublic void setAbstract(boolean makeAbstract)
makeAbstract
- boolean value implying if this Type is abstract.public void setSequenced(boolean sequenced)
sequenced
- boolean value implying if this type is sequenced.public void setMixed(boolean isMixed)
public void setDataType(boolean datatype)
datatype
- boolean value implying if it is a simple Typepublic void setBaseTypes(java.util.List bTypes)
bTypes
- a list types to become this Type's base Type.public void addBaseType(SDOType type)
type
- a type to become this Type's base Type.public void setInstanceClass(java.lang.Class aClass)
aClass
- the Java class that this type represents.public void setXsd(boolean bXsd)
bXsd
- a boolean representing if this property was declared in an XML schemapublic boolean isXsd()
public void setXsdLocalName(java.lang.String xsdLocalNameString)
xsdLocalName
- a String representing the local name of this property if it was declared in an XML schemapublic java.lang.String getXsdLocalName()
public void addDeclaredProperty(Property property)
property
- public void addDeclaredProperty(SDOProperty property)
property
- public void addDeclaredProperty(Property property, int index)
property
- public void addDeclaredProperty(SDOProperty property, int index)
property
- public void removeDeclaredProperties(Property p)
public java.util.Map getDeclaredPropertiesMap()
public void setInstanceClassName(java.lang.String instanceClassName)
instanceClassName
- the Java class that this type represents.public java.lang.String getInstanceClassName()
public void setXsdList(boolean anXsdList)
xsdList
- a boolean representing if this type represents an xsd:list in the schemapublic boolean isXsdList()
public void setXmlDescriptor(XMLDescriptor anXMLDescriptor)
anXMLDescriptor
- public XMLDescriptor getXmlDescriptor()
public void initializeNamespaces(java.util.List namespaceResolvers)
public void setupInheritance(SDOType parentType)
public void preInitialize(java.lang.String packageName, java.util.List namespaceResolvers)
packageName
- nr
- public void postInitialize()
public void setImplClassName(java.lang.String implClassName)
public java.lang.String getImplClassName()
public java.lang.Class getImplClass()
public java.lang.Object get(Property property)
Type
get
in interface Type
property
- one of the properties returned by Type.getInstanceProperties()
.
DataObject.get(Property)
public java.util.List getInstanceProperties()
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.
getInstanceProperties
in interface Type
public void setPropertyValues(java.util.Map properties)
public java.util.Map getPropertyValues()
public void setInstanceProperty(Property property, java.lang.Object value)
property
- value
- public SDOProperty getChangeSummaryProperty()
public SDOProperty[] getPropertiesArray()
public void setSubTypes(java.util.List subTypesList)
public java.util.List getSubTypes()
public boolean isBaseType()
public void setXsdType(javax.xml.namespace.QName xsdTypeQName)
public javax.xml.namespace.QName getXsdType()
public void setFinalized(boolean bFinalized)
public boolean isFinalized()
public void setNonFinalizedReferencingProps(java.util.List nonFinalizedReferencingProps)
public java.util.List getNonFinalizedReferencingProps()
public void setNonFinalizedMappingURIs(java.util.List nonFinalizedMappingURIsList)
public java.util.List getNonFinalizedMappingURIs()
public void setAppInfoElements(java.util.List appInfoElementsList)
public java.util.List getAppInfoElements()
public java.util.Map getAppInfoMap()
public java.lang.Object getPseudoDefault()
public void setPseudoDefault(java.lang.Object anObject)
anObject
- public HelperContext getHelperContext()
public boolean isChangeSummaryType()
public boolean isDataObjectType()
public boolean isTypeType()
public boolean isOpenSequencedType()
public boolean isWrapperType()
|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |