|
Oracle Fusion Middleware Java API Reference for Oracle TopLink 11g Release 1 (11.1.1) E28847-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
org.eclipse.persistence.sdo.SDOProperty
public class SDOProperty
Purpose:A representation of a Property in the type
of a data object
.
Responsibilities:
Field Summary | |
---|---|
private HelperContext |
aHelperContext |
private java.util.List |
aliasNames |
private java.util.List |
appInfoElements |
private java.util.Map |
appInfoMap |
private SDOType |
containingType |
private java.lang.Object |
defaultValue |
private boolean |
finalized |
private boolean |
global |
private boolean |
hasMany |
private int |
indexInDeclaredProperties |
private int |
indexInType |
private static boolean |
isActivationAvailable |
private boolean |
isContainment |
private boolean |
isDefaultSet |
private java.lang.Boolean |
isElement |
private boolean |
isSubstitutable |
private boolean |
nameCollision |
private boolean |
namespaceQualified |
private boolean |
nullable |
private SDOProperty |
opposite |
private java.lang.String |
propertyName |
private java.util.Map<Property,java.lang.Object> |
propertyValues |
private boolean |
readOnly |
private java.util.Collection<SDOProperty> |
substitutableElements |
private SDOType |
type |
private java.lang.String |
uri |
private boolean |
valueProperty |
private DatabaseMapping |
xmlMapping |
private boolean |
xsd |
private java.lang.String |
xsdLocalName |
private javax.xml.namespace.QName |
xsdType |
Constructor Summary | |
---|---|
SDOProperty(HelperContext aContext) |
|
SDOProperty(HelperContext aContext, java.lang.String aName) |
|
SDOProperty(HelperContext aContext, java.lang.String aName, SDOType aType) |
|
SDOProperty(HelperContext aContext, java.lang.String aName, SDOType aType, boolean hasMany) |
|
SDOProperty(HelperContext aContext, java.lang.String aUri, java.lang.String aName, SDOType aType) |
Method Summary | |
---|---|
void |
addMappingToOwner(boolean sdoMethodAttributeAccessor, int indexToAdd) INTERNAL: |
void |
buildChangeSummaryMapping() INTERNAL: |
void |
buildMapping(java.lang.String mappingUri) INTERNAL: |
void |
buildMapping(java.lang.String mappingUri, int indexToAdd) INTERNAL: |
private DatabaseMapping |
buildXMLBinaryDataCollectionMapping(java.lang.String mappingUri, MimeTypePolicy mimeTypePolicy) |
private DatabaseMapping |
buildXMLBinaryDataMapping(java.lang.String mappingUri, MimeTypePolicy mimeTypePolicy) |
private DatabaseMapping |
buildXMLChoiceCollectionMapping(java.lang.String mappingUri) |
private DatabaseMapping |
buildXMLChoiceObjectMapping(java.lang.String mappingUri) |
private DatabaseMapping |
buildXMLCollectionReferenceMapping(java.lang.String mappingUri) |
private DatabaseMapping |
buildXMLCompositeCollectionMapping(java.lang.String mappingUri) |
private DatabaseMapping |
buildXMLCompositeDirectCollectionMapping(java.lang.String mappingUri) |
private DatabaseMapping |
buildXMLCompositeObjectMapping(java.lang.String mappingUri) |
private DatabaseMapping |
buildXMLDirectMapping(java.lang.String mappingUri) |
XMLFragmentCollectionMapping |
buildXMLFragmentCollectionMapping(java.lang.String mappingUri) |
XMLFragmentMapping |
buildXMLFragmentMapping(java.lang.String uri) |
private DatabaseMapping |
buildXMLObjectReferenceMapping(java.lang.String mappingUri) |
private DatabaseMapping |
buildXMLTransformationMapping(java.lang.String mappingUri) |
boolean |
equals(java.lang.Object obj) Indicate if a given SDOProperty instance is equal to this instance. |
java.lang.Object |
get(Property property) |
java.util.List |
getAliasNames() Return a list of alias names for this Property. |
java.util.List |
getAppInfoElements() INTERNAL: |
java.util.Map |
getAppInfoMap() INTERNAL: |
SDOType |
getContainingType() Returns the containing type of this Property. |
java.lang.Object |
getDefault() Returns the default value this Property will have in a data object where the Property hasn't been set. |
private SDOProperty |
getIDProp(Type aType) INTERNAL: Get the reference ID open content Property if it exists for this Type. |
int |
getIndexInDeclaredProperties() INTERNAL: |
int |
getIndexInType() INTERNAL: |
java.util.List |
getInstanceProperties() |
MimeTypePolicy |
getMimeTypePolicy() INTERNAL: |
java.lang.String |
getName() Returns the name of the Property. |
SDOProperty |
getOpposite() Returns the opposite Property if the Property is bi-directional or null otherwise. |
java.util.Map |
getPropertyValues() INTERNAL: |
java.lang.String |
getQualifiedXPath(java.lang.String uri, boolean simple) INTERNAL: |
private java.lang.String |
getQualifiedXPath(java.lang.String uri, boolean simple, SDOType containingType) |
java.util.Collection<SDOProperty> |
getSubstitutableElements() |
SDOType |
getType() Returns the type of the Property. |
java.lang.String |
getUri() |
DatabaseMapping |
getXmlMapping() INTERNAL: |
java.lang.String |
getXPath() INTERNAL: |
java.lang.String |
getXsdLocalName() INTERNAL: Returns the local name of the Property. |
javax.xml.namespace.QName |
getXsdType() INTERNAL: |
boolean |
hasAliasNames() |
int |
hashCode() Return a unique hashCode (as an int) for this instance. |
boolean |
isContainment() Returns whether the Property is containment, i.e., whether it represents by-value composition. |
boolean |
isDefaultSet() INTERNAL: Return whether the default value has been set by the schema either via a define by an XSD or a DataObject. |
protected java.lang.Boolean |
isElement() INTERNAL: Return true if the property is an element, false if the property is an attribute, and null if it has not been specified. |
boolean |
isFinalized() |
boolean |
isGlobal() INTERNAL: |
boolean |
isMany() Returns whether the Property is many-valued. |
boolean |
isNameCollision() |
boolean |
isNamespaceQualified() INTERNAL: Returns if the element or attribute corresponding to this Property should be namespace qualified in the XSD. |
boolean |
isNullable() |
boolean |
isOpenContent() Return whether or not this is an open content property. |
boolean |
isReadOnly() Returns true if values for this Property cannot be modified using the SDO APIs. |
boolean |
isSubstitutable() |
boolean |
isValueProperty() INTERNAL: |
boolean |
isXsd() INTERNAL: Returns if this property was declared in an XML schema. |
void |
setAliasNames(java.util.List names) INTERNAL: Set this Property's alias name list which are unique within the Type. |
void |
setAppInfoElements(java.util.List appInfoElements) INTERNAL: |
void |
setContainingType(Type type) INTERNAL: Set the containing type of this Property. |
void |
setContainment(boolean containment) INTERNAL: Set this Property's Containment which shows parent-child relationship in a tree of DataObjects. |
void |
setDefault(java.lang.Object aDefaultValue) INTERNAL: Set the default value of this Property. |
void |
setFinalized(boolean isFinalized) |
void |
setGlobal(boolean global) INTERNAL: |
void |
setIndexInDeclaredProperties(int indexInDeclaredProperties) INTERNAL: |
void |
setIndexInType(int indexInType) INTERNAL: |
void |
setInstanceProperty(Property property, java.lang.Object value) |
private void |
setIsSetNillablePolicyOnMapping(XMLNillableMapping aMapping, java.lang.Object propertyName) INTERNAL: Alter the default state of the policy to act as a nillable null policy |
private void |
setIsSetOptionalPolicyOnMapping(XMLNillableMapping aMapping, java.lang.Object propertyName) INTERNAL Alter the default state of the policy to act as an optional non-nillable null policy |
private AbstractNullPolicy |
setIsSetPolicyOnMapping(XMLNillableMapping aMapping, java.lang.Object propertyName) INTERNAL: Create and set an IsSetNodePolicy on the mapping - leaving the policy in default state |
void |
setMany(boolean many) INTERNAL: Set this property as single-valued(false) or many-valued(true). |
void |
setName(java.lang.String name) INTERNAL: Assign a string as a unique name of this Property among Properties that belongs to a DataObject. |
void |
setNameCollision(boolean nameCollision) |
void |
setNamespaceQualified(boolean namespaceQualified) INTERNAL: Set if the element or attribute corresponding to this Property is namespace qualified in the XSD. |
void |
setNullable(boolean nullable) INTERNAL: |
void |
setOpposite(Property property) INTERNAL: Set the opposite Property. |
void |
setPropertyValues(java.util.Map properties) INTERNAL: |
void |
setReadOnly(boolean readOnly) INTERNAL: Set this Property as read-only Property. |
void |
setSubstitutable(boolean substitutable) |
void |
setSubstitutableElements(java.util.Collection<SDOProperty> elements) |
void |
setType(Type type) INTERNAL: Assign a Type to this Property. |
void |
setUri(java.lang.String uri) |
void |
setValueProperty(boolean valueProperty) INTERNAL: |
void |
setXmlMapping(DatabaseMapping xmlMapping) INTERNAL: |
void |
setXsd(boolean xsd) INTERNAL: Set if this property was declared in an XML schema. |
void |
setXsdLocalName(java.lang.String xsdLocalName) INTERNAL: Set the local name of this property. |
void |
setXsdType(javax.xml.namespace.QName xsdType) INTERNAL: |
private boolean |
shouldAddInstanceClassConverter() |
private void |
updateType() |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private java.lang.String propertyName
private SDOType type
private SDOType containingType
private boolean isContainment
private boolean hasMany
private boolean readOnly
private java.util.List aliasNames
private java.lang.Object defaultValue
private boolean isDefaultSet
private int indexInType
private int indexInDeclaredProperties
private SDOProperty opposite
private boolean xsd
private java.lang.String xsdLocalName
private java.lang.Boolean isElement
private boolean global
private boolean namespaceQualified
private transient DatabaseMapping xmlMapping
private java.util.Map<Property,java.lang.Object> propertyValues
private boolean nullable
private javax.xml.namespace.QName xsdType
private boolean valueProperty
private java.util.List appInfoElements
private java.util.Map appInfoMap
private boolean nameCollision
private java.lang.String uri
private boolean isSubstitutable
private java.util.Collection<SDOProperty> substitutableElements
private boolean finalized
private static boolean isActivationAvailable
private HelperContext aHelperContext
Constructor Detail |
---|
public SDOProperty(HelperContext aContext)
public SDOProperty(HelperContext aContext, java.lang.String aName)
public SDOProperty(HelperContext aContext, java.lang.String aName, SDOType aType)
public SDOProperty(HelperContext aContext, java.lang.String aName, SDOType aType, boolean hasMany)
public SDOProperty(HelperContext aContext, java.lang.String aUri, java.lang.String aName, SDOType aType)
Method Detail |
---|
public java.lang.String getName()
public SDOType getType()
public boolean isMany()
true
if the Property is many-valued.public boolean isOpenContent()
public boolean isContainment()
true
if the Property is containment.public SDOType getContainingType()
Type#getProperties()
public java.lang.Object getDefault()
data object
where the Property hasn't been set.public boolean isReadOnly()
public SDOProperty getOpposite()
public boolean hasAliasNames()
public java.util.List getAliasNames()
public void setName(java.lang.String name)
name
- a string representing unique name of a property of a DataObject.public void setType(Type type)
type
- the type of this property.public void setContainment(boolean containment)
containment
- a boolean value showing if this Property is containment.public void setMany(boolean many)
many
- a boolean value if this property is many-valued or not.public void setReadOnly(boolean readOnly)
readOnly
- boolean value implying this Property is readonly.public void setAliasNames(java.util.List names)
names
- a list of alias name of this Property.public void setContainingType(Type type)
type
- a Type which is the containing type of this Propertypublic void setDefault(java.lang.Object aDefaultValue)
aDefaultValue
- an Object to be the default value of this type.public void setOpposite(Property property)
the
- opposite Property if the Property is bi-directional, otherwise nullpublic void setXsd(boolean xsd)
xsd
- a boolean representing if this property was declared in an XML schemapublic boolean isXsd()
public void setXsdLocalName(java.lang.String xsdLocalName)
xsdLocalName
- a String representing the local name of this property if it was declared in an XML schemapublic java.lang.String getXsdLocalName()
public void setNamespaceQualified(boolean namespaceQualified)
namespaceQualified
- a boolean representing if the element or attribute corresponding to this Property is namespace qualified in the XSD.public boolean isNamespaceQualified()
public void setXmlMapping(DatabaseMapping xmlMapping)
public DatabaseMapping getXmlMapping()
public void setGlobal(boolean global)
public boolean isGlobal()
protected java.lang.Boolean isElement()
private void setIsSetNillablePolicyOnMapping(XMLNillableMapping aMapping, java.lang.Object propertyName)
aMapping
-propertyName
-private void setIsSetOptionalPolicyOnMapping(XMLNillableMapping aMapping, java.lang.Object propertyName)
aMapping
-propertyName
-private AbstractNullPolicy setIsSetPolicyOnMapping(XMLNillableMapping aMapping, java.lang.Object propertyName)
aMapping
-propertyName
-public void buildMapping(java.lang.String mappingUri)
public void buildMapping(java.lang.String mappingUri, int indexToAdd)
public void buildChangeSummaryMapping()
public void addMappingToOwner(boolean sdoMethodAttributeAccessor, int indexToAdd)
private DatabaseMapping buildXMLBinaryDataMapping(java.lang.String mappingUri, MimeTypePolicy mimeTypePolicy)
private DatabaseMapping buildXMLBinaryDataCollectionMapping(java.lang.String mappingUri, MimeTypePolicy mimeTypePolicy)
private DatabaseMapping buildXMLTransformationMapping(java.lang.String mappingUri)
private DatabaseMapping buildXMLDirectMapping(java.lang.String mappingUri)
private DatabaseMapping buildXMLCompositeDirectCollectionMapping(java.lang.String mappingUri)
private DatabaseMapping buildXMLCompositeCollectionMapping(java.lang.String mappingUri)
private DatabaseMapping buildXMLCompositeObjectMapping(java.lang.String mappingUri)
private DatabaseMapping buildXMLObjectReferenceMapping(java.lang.String mappingUri)
private DatabaseMapping buildXMLChoiceObjectMapping(java.lang.String mappingUri)
private DatabaseMapping buildXMLChoiceCollectionMapping(java.lang.String mappingUri)
private SDOProperty getIDProp(Type aType)
private DatabaseMapping buildXMLCollectionReferenceMapping(java.lang.String mappingUri)
private boolean shouldAddInstanceClassConverter()
public java.lang.String getXPath()
public java.lang.String getQualifiedXPath(java.lang.String uri, boolean simple)
private java.lang.String getQualifiedXPath(java.lang.String uri, boolean simple, SDOType containingType)
public java.lang.Object get(Property property)
public java.util.List getInstanceProperties()
public void setPropertyValues(java.util.Map properties)
public java.util.Map getPropertyValues()
public void setInstanceProperty(Property property, java.lang.Object value)
public void setIndexInType(int indexInType)
public int getIndexInType()
public void setNullable(boolean nullable)
public boolean isNullable()
public void setXsdType(javax.xml.namespace.QName xsdType)
public javax.xml.namespace.QName getXsdType()
public MimeTypePolicy getMimeTypePolicy()
public void setIndexInDeclaredProperties(int indexInDeclaredProperties)
public int getIndexInDeclaredProperties()
public void setValueProperty(boolean valueProperty)
public boolean isValueProperty()
public void setAppInfoElements(java.util.List appInfoElements)
public java.util.List getAppInfoElements()
public java.util.Map getAppInfoMap()
public void setNameCollision(boolean nameCollision)
public boolean isNameCollision()
public boolean isDefaultSet()
public void setUri(java.lang.String uri)
public java.lang.String getUri()
public XMLFragmentMapping buildXMLFragmentMapping(java.lang.String uri)
public XMLFragmentCollectionMapping buildXMLFragmentCollectionMapping(java.lang.String mappingUri)
public boolean isSubstitutable()
public void setSubstitutable(boolean substitutable)
public java.util.Collection<SDOProperty> getSubstitutableElements()
public void setSubstitutableElements(java.util.Collection<SDOProperty> elements)
public void setFinalized(boolean isFinalized)
public boolean isFinalized()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- Object to compare to this SDOProperty instanceprivate void updateType()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |