|
EclipseLink 1.0_1.0M2 API Reference - Incubation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.sdo.SDODataObject
public class SDODataObject
Purpose: A data object is a representation of some structured data.
It is the fundamental component in the SDO (Service Data Objects) package.
Data objects support reflection, path-based access, convenience creation and deletion methods,
and the ability to be part of a data graph
.
Each data object holds its data as a series of Properties
.
Properties can be accessed by name, property index, or using the property meta object itself.
A data object can also contain references to other data objects, through reference-type Properties.
A data object has a series of convenience accessors for its Properties.
These methods either use a path (String),
a property index,
or the property's meta object
itself, to identify the property.
Some examples of the path-based accessors are as follows:
DataObject company = ...; company.get("name"); is the same as company.get(company.getType().getProperty("name")) company.set("name", "acme"); company.get("department.0/name") is the same as ((DataObject)((List)company.get("department")).get(0)).get("name") .n indexes from 0 ... implies the name property of the first department company.get("department[1]/name") [] indexes from 1 ... implies the name property of the first department company.get("department[number=123]") returns the first department where number=123 company.get("..") returns the containing data object company.get("/") returns the root containing data object
There are general accessors for Properties, i.e., get
and set
,
as well as specific accessors for the primitive types and commonly used data types like
String, Date, List, BigInteger, and BigDecimal.
Constructor Summary | |
---|---|
SDODataObject()
INTERNAL: Private constructor. |
Method Summary | |
---|---|
java.lang.String |
_getContainmentPropertyName()
INTERNAL: Return the name of the Property of the DataObject containing this data object or null if there is no container. |
ValueStore |
_getCurrentValueStore()
INTERNAL: Map interface into the currentValueStore of this DataObject. |
HelperContext |
_getHelperContext()
INTERNAL: Return the HelperContext associated with this DataObject. |
java.util.List |
_getOpenContentProperties()
INTERNAL: Returns a list of the Properties currently used in this DataObject which are not included in getType().getProperties |
java.util.List |
_getOpenContentPropertiesAttributes()
|
java.util.Map |
_getOpenContentPropertiesAttributesMap()
|
java.util.List |
_getOpenContentPropertiesWithXMLRoots()
INTERNAL: This function is implemented by SDOType.setOpen() in a mapping setGet/SetMethodName call |
java.lang.String |
_getPath()
INTERNAL: Return an SDO Path string from root of the caller to itself |
java.lang.String |
_getSdoRef()
INTERNAL: Return the sdoref attribute value during unmarshaling |
void |
_setChangeSummary(ChangeSummary aChangeSummary)
INTERNAL: Recursively Set this DataObject's ChangeSummary as passed in value. |
void |
_setContainer(DataObject aContainer)
INTERNAL: Sets the DataObject which contains this DataObject. |
void |
_setContainmentPropertyName(java.lang.String aContainmentPropertyName)
INTERNAL: Sets the name of the property on the containing DataObject which contains this DataObject as a value. |
void |
_setCreated(boolean created)
INTERNAL: Set flag created value. |
void |
_setCurrentValueStore(ValueStore aValueStore)
INTERNAL: Pluggable Interface for substituting the default Map with a custom Map Class |
void |
_setHelperContext(HelperContext aContext)
INTERNAL: Set the HelperContext that will be associated with this DataObject. |
void |
_setModified(boolean modified)
INTERNAL: Set flag modified value. |
void |
_setOpenContentPropertiesAttributes(java.util.List openContentPropertiesAttributes)
|
void |
_setOpenContentPropertiesAttributesMap(java.util.Map openAttributeProperties)
|
void |
_setOpenContentPropertiesWithXMLRoots(java.util.List openContentPropertiesWithXMLRoots)
INTERNAL: This function is implemented by SDOType.setOpen() in a mapping setGet/SetMethodName call |
void |
_setType(Type aType)
INTERNAL: |
void |
addOpenContentProperty(Property property)
INTERNAL: Add the open content property into all 3 data structures. |
java.lang.Object |
convertObjectToValue(Property property,
java.lang.Class cls)
INTERNAL: |
java.lang.Object |
convertObjectToValue(Property property,
int position,
java.lang.Class cls)
INTERNAL: |
DataObject |
createDataObject(int propertyIndex)
Returns a new data object contained by this object using the specified property,
which must be a containment property . |
DataObject |
createDataObject(int propertyIndex,
java.lang.String namespaceURI,
java.lang.String typeName)
Returns a new data object contained by this object using the specified property,
which must be a containment property . |
DataObject |
createDataObject(Property property,
Type aType)
Returns a new data object contained by this object using the specified property,
which must be of containment type . |
DataObject |
createDataObject(java.lang.String propertyName)
Returns a new data object contained by this object using the specified property,
which must be a containment property . |
DataObject |
createDataObject(java.lang.String propertyName,
java.lang.String namespaceURI,
java.lang.String typeName)
Returns a new data object contained by this object using the specified property,
which must be a containment property . |
Property |
defineOpenContentProperty(java.lang.String name,
java.lang.Object value)
INTERNAL: Create a dynamic open content property if no property exists for (name). |
void |
delete()
Remove this object from its container and then unset all its non- readOnly Properties. |
void |
detach()
Removes this DataObject from its container, if any. |
void |
detachOrDelete(boolean fromDelete)
INTERNAL: Recursively walk the tree and set oldSettings for a detached/deleted object. |
java.lang.Object |
get(int propertyIndex)
Returns the value of the property at the specified index in property list
of this object's type . |
java.lang.Object |
get(java.lang.String path)
Returns the value of a property of either this object or an object reachable from it, as identified by the specified path. |
java.math.BigDecimal |
getBigDecimal(int propertyIndex)
Returns the value of a BigDecimal property identified by the specified property index. |
java.math.BigDecimal |
getBigDecimal(java.lang.String path)
Returns the value of a BigDecimal property identified by the specified path. |
java.math.BigInteger |
getBigInteger(int propertyIndex)
Returns the value of a BigInteger property identified by the specified property index. |
java.math.BigInteger |
getBigInteger(java.lang.String path)
Returns the value of a BigInteger property identified by the specified path. |
boolean |
getBoolean(int propertyIndex)
Returns the value of a boolean property identified by the specified property index. |
boolean |
getBoolean(java.lang.String path)
Returns the value of a boolean property identified by the specified path. |
byte |
getByte(int propertyIndex)
Returns the value of a byte property identified by the specified property index. |
byte |
getByte(java.lang.String path)
Returns the value of a byte property identified by the specified path. |
byte[] |
getBytes(int propertyIndex)
Returns the value of a byte[] property identified by the specified property index. |
byte[] |
getBytes(java.lang.String path)
Returns the value of a byte[] property identified by the specified path. |
ChangeSummary |
getChangeSummary()
Returns the ChangeSummary with scope covering this dataObject, or null if there is no ChangeSummary. |
char |
getChar(int propertyIndex)
Returns the value of a char property identified by the specified property index. |
char |
getChar(java.lang.String path)
Returns the value of a char property identified by the specified path. |
DataObject |
getContainer()
Returns the containing data object
or null if there is no container. |
Property |
getContainmentProperty()
Return the Property of the data object containing this data object
or null if there is no container. |
DataGraph |
getDataGraph()
Returns the data graph for this object or null if there isn't one. |
DataObject |
getDataObject(int propertyIndex)
Returns the value of a DataObject property identified by the specified property index. |
DataObject |
getDataObject(java.lang.String path)
Returns the value of a DataObject property identified by the specified path. |
java.util.Date |
getDate(int propertyIndex)
Returns the value of a Date property identified by the specified property index. |
java.util.Date |
getDate(java.lang.String path)
Returns the value of a Date property identified by the specified path. |
double |
getDouble(int propertyIndex)
Returns the value of a double property identified by the specified property index. |
double |
getDouble(java.lang.String path)
Returns the value of a double property identified by the specified path. |
float |
getFloat(int propertyIndex)
Returns the value of a float property identified by the specified property index. |
float |
getFloat(java.lang.String path)
Returns the value of a float property identified by the specified path. |
java.util.List |
getInstanceProperties()
Returns a read-only List of the Properties currently used in this DataObject. |
Property |
getInstanceProperty(int propertyIndex)
INTERNAL: |
Property |
getInstanceProperty(java.lang.String propertyName)
Returns the named Property from the current instance currentValueStore, or null if not found. |
int |
getInt(int propertyIndex)
Returns the value of a int property identified by the specified property index. |
int |
getInt(java.lang.String path)
Returns the value of a int property identified by the specified path. |
java.util.List |
getList(int propertyIndex)
Returns the value of a List property identified by the specified property index. |
java.util.List |
getList(java.lang.String path)
Returns the value of a List property identified by the specified path. |
long |
getLong(int propertyIndex)
Returns the value of a long property identified by the specified property index. |
long |
getLong(java.lang.String path)
Returns the value of a long property identified by the specified path. |
Property |
getProperty(java.lang.String propertyName)
Deprecated. replaced by #getInstanceProperty() in 2.1.0 |
java.lang.Object |
getPropertyInternal(Property property)
INTERNAL: Get the value of the property (open-content or declared).. |
DataObject |
getRootObject()
Returns the root data object . |
Sequence |
getSequence()
Returns the Sequence for this DataObject. |
Sequence |
getSequence(int propertyIndex)
Deprecated. in 2.1.0. |
Sequence |
getSequence(java.lang.String path)
Deprecated. in 2.1.0. |
short |
getShort(int propertyIndex)
Returns the value of a short property identified by the specified property index. |
short |
getShort(java.lang.String path)
Returns the value of a short property identified by the specified path. |
java.lang.String |
getString(int propertyIndex)
Returns the value of a String property identified by the specified property index. |
java.lang.String |
getString(java.lang.String path)
Returns the value of a String property identified by the specified path. |
Type |
getType()
Returns the data object's type. |
boolean |
isSet(int propertyIndex)
Returns whether the the property at the specified index in property list of this object's
type , is considered to be set. |
boolean |
isSet(java.lang.String path)
Returns whether a property of either this object or an object reachable from it, as identified by the specified path, is considered to be set. |
boolean |
isSetInternal(Property property)
INTERNAL: Return whether the property (open-content or declared) is set? |
boolean |
parentContains(java.lang.Object value)
INTERNAL: |
void |
removeOpenContentProperty(Property property)
INTERNAL: Remove the open content property (property) from all 3 data structures. |
void |
resetChanges()
INTERNAL: Initialize all old settings related to ChangeSummary and recursively go down the tree to initialize all DataObjects rooted at this DataObject. |
void |
set(int propertyIndex,
java.lang.Object value)
Sets the property at the specified index in property list of this object's
type , to the specified value. |
void |
set(Property property,
java.lang.Object value,
boolean updateSequence)
INTERNAL: Sets the value of the given property of the object to the new value. |
void |
set(java.lang.String path,
java.lang.Object value)
Sets a property of either this object or an object reachable from it, as identified by the specified path, to the specified value. |
void |
setBigDecimal(int propertyIndex,
java.math.BigDecimal value)
Sets the value of a BigDecimal property identified by the specified property index, to the specified value. |
void |
setBigDecimal(java.lang.String path,
java.math.BigDecimal value)
Sets the value of a BigDecimal property identified by the specified path, to the specified value. |
void |
setBigInteger(int propertyIndex,
java.math.BigInteger value)
Sets the value of a BigInteger property identified by the specified property index, to the specified value. |
void |
setBigInteger(java.lang.String path,
java.math.BigInteger value)
Sets the value of a BigInteger property identified by the specified path, to the specified value. |
void |
setBoolean(int propertyIndex,
boolean value)
Sets the value of a boolean property identified by the specified property index, to the specified value. |
void |
setBoolean(java.lang.String path,
boolean value)
Sets the value of a boolean property identified by the specified path, to the specified value. |
void |
setByte(int propertyIndex,
byte value)
Sets the value of a byte property identified by the specified property index, to the specified value. |
void |
setByte(java.lang.String path,
byte value)
Sets the value of a byte property identified by the specified path, to the specified value. |
void |
setBytes(int propertyIndex,
byte[] value)
Sets the value of a byte[] property identified by the specified property index, to the specified value. |
void |
setBytes(java.lang.String path,
byte[] value)
Sets the value of a byte[] property identified by the specified path, to the specified value. |
void |
setChar(int propertyIndex,
char value)
Sets the value of a char property identified by the specified property index, to the specified value. |
void |
setChar(java.lang.String path,
char value)
Sets the value of a char property identified by the specified path, to the specified value. |
void |
setDataGraph(DataGraph dataGraph)
|
void |
setDataObject(int propertyIndex,
DataObject value)
Sets the value of a DataObject property identified by the specified property index, to the specified value. |
void |
setDataObject(java.lang.String path,
DataObject value)
Sets the value of a DataObject property identified by the specified path, to the specified value. |
void |
setDate(int propertyIndex,
java.util.Date value)
Sets the value of a Date property identified by the specified property index, to the specified value. |
void |
setDate(java.lang.String path,
java.util.Date value)
Sets the value of a Date property identified by the specified path, to the specified value. |
void |
setDouble(int propertyIndex,
double value)
Sets the value of a double property identified by the specified property index, to the specified value. |
void |
setDouble(java.lang.String path,
double value)
Sets the value of a double property identified by the specified path, to the specified value. |
void |
setFloat(int propertyIndex,
float value)
Sets the value of a float property identified by the specified property index, to the specified value. |
void |
setFloat(java.lang.String path,
float value)
Sets the value of a float property identified by the specified path, to the specified value. |
void |
setInt(int propertyIndex,
int value)
Sets the value of a int property identified by the specified property index, to the specified value. |
void |
setInt(java.lang.String path,
int value)
Sets the value of a int property identified by the specified path, to the specified value. |
void |
setList(int propertyIndex,
java.util.List value)
Sets the value of a List property identified by the specified property index, to the specified value. |
void |
setList(java.lang.String path,
java.util.List value)
Sets the value of a List property identified by the specified path, to the specified value. |
void |
setLong(int propertyIndex,
long value)
Sets the value of a long property identified by the specified property index, to the specified value. |
void |
setLong(java.lang.String path,
long value)
Sets the value of a long property identified by the specified path, to the specified value. |
void |
setPropertyInternal(Property property,
java.lang.Object value,
boolean updateSequence)
INTERNAL: Update the ValueStore with the new property value and update any sequence if it exists. |
void |
setShort(int propertyIndex,
short value)
Sets the value of a short property identified by the specified property index, to the specified value. |
void |
setShort(java.lang.String path,
short value)
Sets the value of a short property identified by the specified path, to the specified value. |
void |
setString(int propertyIndex,
java.lang.String value)
Sets the value of a String property identified by the specified property index, to the specified value. |
void |
setString(java.lang.String path,
java.lang.String value)
Sets the value of a String property identified by the specified path, to the specified value. |
void |
undoChanges(boolean isCSRoot,
ChangeSummary cs,
SDODataObject origContainer,
java.lang.String origContainmentPropName)
INTERNAL: This function reverses any operations that were performed on this object since change tracking was turned on. |
void |
unset(int propertyIndex)
Unsets the property at the specified index in property list of this object's type . |
void |
unset(Property property,
boolean fromDelete,
boolean updateSequence)
INTERNAL: Unset the specified property on this DataObject. |
void |
unset(java.lang.String path)
Unsets a property of either this object or an object reachable from it, as identified by the specified path. |
void |
updateContainment(Property property,
java.util.Collection values)
INTERNAL: Update containment on the specified collection of values and default to true = update the sequence |
void |
updateContainment(Property property,
java.util.Collection values,
boolean updateSequence)
INTERNAL: Update containment with flagged update sequence state |
java.lang.Object |
writeReplace()
INTERNAL: Defined in SDO 2.01 spec on page 65 Externalizable function is called by ObjectStream.writeObject() A replacement object for serialization can be called here. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SDODataObject()
#SDODataObject(HelperContext)
instead
Method Detail |
---|
public void _setHelperContext(HelperContext aContext)
aContext
- public HelperContext _getHelperContext()
public java.lang.Object get(java.lang.String path)
path
- the path to a valid object and property.
#get(Property)
public void set(java.lang.String path, java.lang.Object value) throws java.lang.ClassCastException, java.lang.UnsupportedOperationException, java.lang.IllegalArgumentException
path
- the path to a valid object and property.value
- the new value for the property.
java.lang.ClassCastException
java.lang.UnsupportedOperationException
java.lang.IllegalArgumentException
#set(Property, Object)
public boolean isSet(java.lang.String path)
path
- the path to a valid object and property.#isSet(Property)
public void unset(java.lang.String path)
path
- the path to a valid object and property.#unset(Property)
public boolean getBoolean(java.lang.String path) throws java.lang.ClassCastException
boolean
property identified by the specified path.
path
- the path to a valid object and property.
boolean
value of the specified property.
java.lang.ClassCastException
get(String)
public byte getByte(java.lang.String path)
byte
property identified by the specified path.
path
- the path to a valid object and property.
byte
value of the specified property.get(String)
public char getChar(java.lang.String path)
char
property identified by the specified path.
path
- the path to a valid object and property.
char
value of the specified property.get(String)
public double getDouble(java.lang.String path)
double
property identified by the specified path.
path
- the path to a valid object and property.
double
value of the specified property.get(String)
public float getFloat(java.lang.String path)
float
property identified by the specified path.
path
- the path to a valid object and property.
float
value of the specified property.get(String)
public int getInt(java.lang.String path)
int
property identified by the specified path.
path
- the path to a valid object and property.
int
value of the specified property.get(String)
public long getLong(java.lang.String path)
long
property identified by the specified path.
path
- the path to a valid object and property.
long
value of the specified property.get(String)
public short getShort(java.lang.String path)
short
property identified by the specified path.
path
- the path to a valid object and property.
short
value of the specified property.get(String)
public byte[] getBytes(java.lang.String path)
byte[]
property identified by the specified path.
path
- the path to a valid object and property.
byte[]
value of the specified property.get(String)
public java.math.BigDecimal getBigDecimal(java.lang.String path)
BigDecimal
property identified by the specified path.
path
- the path to a valid object and property.
BigDecimal
value of the specified property.get(String)
public java.math.BigInteger getBigInteger(java.lang.String path)
BigInteger
property identified by the specified path.
path
- the path to a valid object and property.
BigInteger
value of the specified property.get(String)
public DataObject getDataObject(java.lang.String path) throws java.lang.ClassCastException
DataObject
property identified by the specified path.
path
- the path to a valid object and property.
DataObject
value of the specified property.
java.lang.ClassCastException
get(String)
public java.util.Date getDate(java.lang.String path)
Date
property identified by the specified path.
path
- the path to a valid object and property.
Date
value of the specified property.get(String)
public java.lang.String getString(java.lang.String path)
String
property identified by the specified path.
path
- the path to a valid object and property.
String
value of the specified property.get(String)
public java.util.List getList(java.lang.String path)
List
property identified by the specified path.
path
- the path to a valid object and property.
List
value of the specified property.get(String)
public void setBoolean(java.lang.String path, boolean value)
boolean
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
public void setByte(java.lang.String path, byte value)
byte
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
public void setChar(java.lang.String path, char value)
char
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
public void setDouble(java.lang.String path, double value)
double
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
public void setFloat(java.lang.String path, float value)
float
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
public void setInt(java.lang.String path, int value)
int
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
public void setLong(java.lang.String path, long value)
long
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
public void setShort(java.lang.String path, short value)
short
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
public void setBytes(java.lang.String path, byte[] value)
byte[]
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
public void setBigDecimal(java.lang.String path, java.math.BigDecimal value)
BigDecimal
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
public void setBigInteger(java.lang.String path, java.math.BigInteger value)
BigInteger
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
public void setDataObject(java.lang.String path, DataObject value)
DataObject
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
public void setDate(java.lang.String path, java.util.Date value)
Date
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
public void setString(java.lang.String path, java.lang.String value)
String
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
public void setList(java.lang.String path, java.util.List value)
List
property identified by the specified path, to the specified value.
path
- the path to a valid object and property.value
- the new value for the property.set(String, Object)
,
#setList(Property, List)
public java.lang.Object get(int propertyIndex) throws java.lang.IllegalArgumentException
property list
of this object's type
.
propertyIndex
- the index of the property.
java.lang.IllegalArgumentException
#get(Property)
public void set(int propertyIndex, java.lang.Object value)
property list
of this object's
type
, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.#set(Property, Object)
public boolean isSet(int propertyIndex)
property list
of this object's
type
, is considered to be set.
propertyIndex
- the index of the property.
#isSet(Property)
public void unset(int propertyIndex)
property list
of this object's type
.
propertyIndex
- the index of the property.#unset(Property)
public boolean getBoolean(int propertyIndex) throws java.lang.IllegalArgumentException, java.lang.ClassCastException
boolean
property identified by the specified property index.
propertyIndex
- the index of the property.
boolean
value of the specified property.
java.lang.IllegalArgumentException
java.lang.ClassCastException
get(int)
public byte getByte(int propertyIndex) throws java.lang.IllegalArgumentException, java.lang.ClassCastException
byte
property identified by the specified property index.
propertyIndex
- the index of the property.
byte
value of the specified property.
java.lang.IllegalArgumentException
java.lang.ClassCastException
get(int)
public char getChar(int propertyIndex) throws java.lang.IllegalArgumentException, java.lang.ClassCastException
char
property identified by the specified property index.
propertyIndex
- the index of the property.
char
value of the specified property.
java.lang.IllegalArgumentException
java.lang.ClassCastException
get(int)
public double getDouble(int propertyIndex) throws java.lang.IllegalArgumentException, java.lang.ClassCastException
double
property identified by the specified property index.
propertyIndex
- the index of the property.
double
value of the specified property.
java.lang.IllegalArgumentException
java.lang.ClassCastException
get(int)
public float getFloat(int propertyIndex) throws java.lang.IllegalArgumentException, java.lang.ClassCastException
float
property identified by the specified property index.
propertyIndex
- the index of the property.
float
value of the specified property.
java.lang.IllegalArgumentException
java.lang.ClassCastException
get(int)
public int getInt(int propertyIndex) throws java.lang.IllegalArgumentException, java.lang.ClassCastException
int
property identified by the specified property index.
propertyIndex
- the index of the property.
int
value of the specified property.
java.lang.IllegalArgumentException
java.lang.ClassCastException
get(int)
public long getLong(int propertyIndex) throws java.lang.IllegalArgumentException, java.lang.ClassCastException
long
property identified by the specified property index.
propertyIndex
- the index of the property.
long
value of the specified property.
java.lang.IllegalArgumentException
java.lang.ClassCastException
get(int)
public short getShort(int propertyIndex) throws java.lang.IllegalArgumentException, java.lang.ClassCastException
short
property identified by the specified property index.
propertyIndex
- the index of the property.
short
value of the specified property.
java.lang.IllegalArgumentException
java.lang.ClassCastException
get(int)
public byte[] getBytes(int propertyIndex) throws java.lang.IllegalArgumentException, java.lang.ClassCastException
byte[]
property identified by the specified property index.
propertyIndex
- the index of the property.
byte[]
value of the specified property.
java.lang.IllegalArgumentException
java.lang.ClassCastException
get(int)
public java.math.BigDecimal getBigDecimal(int propertyIndex) throws java.lang.IllegalArgumentException, java.lang.ClassCastException
BigDecimal
property identified by the specified property index.
propertyIndex
- the index of the property.
BigDecimal
value of the specified property.
java.lang.IllegalArgumentException
java.lang.ClassCastException
get(int)
public java.math.BigInteger getBigInteger(int propertyIndex) throws java.lang.IllegalArgumentException, java.lang.ClassCastException
BigInteger
property identified by the specified property index.
propertyIndex
- the index of the property.
BigInteger
value of the specified property.
java.lang.IllegalArgumentException
java.lang.ClassCastException
get(int)
public DataObject getDataObject(int propertyIndex)
DataObject
property identified by the specified property index.
propertyIndex
- the index of the property.
DataObject
value of the specified property.get(int)
public java.util.Date getDate(int propertyIndex) throws java.lang.IllegalArgumentException, java.lang.ClassCastException
Date
property identified by the specified property index.
propertyIndex
- the index of the property.
Date
value of the specified property.
java.lang.IllegalArgumentException
java.lang.ClassCastException
get(int)
public java.lang.String getString(int propertyIndex) throws java.lang.IllegalArgumentException, java.lang.ClassCastException
String
property identified by the specified property index.
propertyIndex
- the index of the property.
String
value of the specified property.
java.lang.IllegalArgumentException
java.lang.ClassCastException
get(int)
public java.util.List getList(int propertyIndex)
List
property identified by the specified property index.
propertyIndex
- the index of the property.
List
value of the specified property.get(int)
public Sequence getSequence(java.lang.String path)
Sequence
property identified by the specified path.
path
- the path to a valid object and property.
Sequence
value of the specified property.get(String)
public Sequence getSequence(int propertyIndex)
Sequence
property identified by the specified property index.
propertyIndex
- the index of the property.
Sequence
value of the specified property.get(int)
public Sequence getSequence()
Sequence
for this DataObject.
When getType().isSequencedType() == true,
the Sequence of a DataObject corresponds to the
XML elements representing the values of its Properties.
Updates through DataObject and the Lists or Sequences returned
from DataObject operate on the same data.
When getType().isSequencedType() == false, null is returned.
Sequence
or null.public void setBoolean(int propertyIndex, boolean value)
boolean
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
public void setByte(int propertyIndex, byte value)
byte
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
public void setChar(int propertyIndex, char value)
char
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
public void setDouble(int propertyIndex, double value)
double
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
public void setFloat(int propertyIndex, float value)
float
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
public void setInt(int propertyIndex, int value)
int
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
public void setLong(int propertyIndex, long value)
long
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
public void setShort(int propertyIndex, short value)
short
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
public void setBytes(int propertyIndex, byte[] value)
byte[]
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
public void setBigDecimal(int propertyIndex, java.math.BigDecimal value)
BigDecimal
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
public void setBigInteger(int propertyIndex, java.math.BigInteger value)
BigInteger
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
public void setDataObject(int propertyIndex, DataObject value)
DataObject
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
public void setDate(int propertyIndex, java.util.Date value)
Date
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
public void setString(int propertyIndex, java.lang.String value)
String
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
public void setList(int propertyIndex, java.util.List value)
List
property identified by the specified property index, to the specified value.
propertyIndex
- the index of the property.value
- the new value for the property.set(int, Object)
,
#setList(Property, List)
public Property defineOpenContentProperty(java.lang.String name, java.lang.Object value) throws java.lang.UnsupportedOperationException, java.lang.IllegalArgumentException
name
- value
-
java.lang.UnsupportedOperationException
java.lang.IllegalArgumentException
public void set(Property property, java.lang.Object value, boolean updateSequence) throws java.lang.UnsupportedOperationException, java.lang.IllegalArgumentException
The use of a false updateSequence flag is internally implemented during an SDOSequence.add() call. Refactor: we need to abstract this function using a type of Command pattern to handle the sequence context.
property
- value
- updateSequence
-
java.lang.UnsupportedOperationException
java.lang.IllegalArgumentException
public void unset(Property property, boolean fromDelete, boolean updateSequence)
property
- fromDelete
- updateSequence
- public DataObject createDataObject(java.lang.String propertyName)
data object
contained by this object using the specified property,
which must be a containment property
.
The type of the created object is the declared type
of the specified property.
propertyName
- the name of the specified containment property.
createDataObject(String, String, String)
public DataObject createDataObject(int propertyIndex)
data object
contained by this object using the specified property,
which must be a containment property
.
The type of the created object is the declared type
of the specified property.
propertyIndex
- the index of the specified containment property.
createDataObject(int, String, String)
public DataObject createDataObject(java.lang.String propertyName, java.lang.String namespaceURI, java.lang.String typeName)
data object
contained by this object using the specified property,
which must be a containment property
.
The type of the created object is specified by the packageURI and typeName arguments.
The specified type must be a compatible target for the property identified by propertyName.
propertyName
- the name of the specified containment property.namespaceURI
- the namespace URI of the package containing the type of object to be created.typeName
- the name of a type in the specified package.
createDataObject(String)
,
DataGraph#getType
public DataObject createDataObject(int propertyIndex, java.lang.String namespaceURI, java.lang.String typeName)
data object
contained by this object using the specified property,
which must be a containment property
.
The type of the created object is specified by the packageURI and typeName arguments.
The specified type must be a compatible target for the property identified by propertyIndex.
propertyIndex
- the index of the specified containment property.namespaceURI
- the namespace URI of the package containing the type of object to be created.typeName
- the name of a type in the specified package.
createDataObject(int)
,
DataGraph#getType
public DataObject createDataObject(Property property, Type aType)
data object
contained by this object using the specified property,
which must be of containment type
.
The type of the created object is specified by the type argument,
which must be a compatible target for the specifed property.
property
- a containment property of this object.type
- the type of object to be created.
createDataObject(int)
public void detachOrDelete(boolean fromDelete)
fromDelete
- (flag the action true = delete, false = detach)public void detach()
public void delete()
readOnly
Properties.
If this object is contained by a readOnly
containment property
, its non-readOnly
Properties will be unset but the object will not be removed from its container.
All DataObjects recursively contained by containment Properties
will also be deleted.
public DataObject getContainer()
data object
or null
if there is no container.
null
.public Property getContainmentProperty()
data object
containing this data object
or null
if there is no container.
public DataGraph getDataGraph()
data graph
for this object or null
if there isn't one.
null
.public void setDataGraph(DataGraph dataGraph)
public Type getType()
The type defines the Properties available for reflective access.
public java.util.List getInstanceProperties()
public Property getProperty(java.lang.String propertyName)
#getInstanceProperty()
in 2.1.0
public Property getInstanceProperty(java.lang.String propertyName)
propertyName
- the name of the Property
public Property getInstanceProperty(int propertyIndex) throws java.lang.IllegalArgumentException
propertyIndex
-
SDOException
java.lang.IllegalArgumentException
public DataObject getRootObject()
data object
.
public ChangeSummary getChangeSummary()
public void _setCreated(boolean created)
created
- flag created's new value.public void _setModified(boolean modified)
modified
- flag modified's new value.public void _setChangeSummary(ChangeSummary aChangeSummary)
aChangeSummary
- the ChangeSummary taking this DataObject as root.public void undoChanges(boolean isCSRoot, ChangeSummary cs, SDODataObject origContainer, java.lang.String origContainmentPropName)
isCSRoot
- cs
- origContainer
- origContainmentPropName
- public void resetChanges()
public void _setType(Type aType)
aType
- public void _setCurrentValueStore(ValueStore aValueStore)
currentValueStore
- voidpublic ValueStore _getCurrentValueStore()
ValueStore
interface require this accessor.
public void _setContainer(DataObject aContainer)
aContainer
- the DataObject which is the container of this DataObject.public java.util.Map _getOpenContentPropertiesAttributesMap()
public void _setOpenContentPropertiesAttributesMap(java.util.Map openAttributeProperties)
public void _setOpenContentPropertiesWithXMLRoots(java.util.List openContentPropertiesWithXMLRoots)
openContentPropertiesWithXMLRoots
- public java.util.List _getOpenContentPropertiesWithXMLRoots()
public java.util.List _getOpenContentProperties()
public java.lang.Object convertObjectToValue(Property property, java.lang.Class cls) throws java.lang.ClassCastException, java.lang.IllegalArgumentException
property
- cls
-
java.lang.ClassCastException
java.lang.IllegalArgumentException
public java.lang.Object convertObjectToValue(Property property, int position, java.lang.Class cls) throws java.lang.ClassCastException, java.lang.IllegalArgumentException
property
- position
- cls
-
java.lang.ClassCastException
java.lang.IllegalArgumentException
public void _setContainmentPropertyName(java.lang.String aContainmentPropertyName)
aContainmentPropertyName
- the name of the property on the containing DataObject which has this DataObject as a value.public java.lang.String _getContainmentPropertyName()
public boolean parentContains(java.lang.Object value)
value
-
public void updateContainment(Property property, java.util.Collection values, boolean updateSequence)
property
- values
- updateSequence
- public void updateContainment(Property property, java.util.Collection values)
property
- values
- public java.lang.Object writeReplace()
SDOResolvable
public java.lang.String _getPath()
public java.lang.Object getPropertyInternal(Property property)
property
-
public void setPropertyInternal(Property property, java.lang.Object value, boolean updateSequence)
property
- value
- updateSequence
- (truncate call back from sequence when this function was called from sequence)public void addOpenContentProperty(Property property)
property
- public void removeOpenContentProperty(Property property)
property
- public boolean isSetInternal(Property property)
property
-
public java.lang.String _getSdoRef()
public void _setOpenContentPropertiesAttributes(java.util.List openContentPropertiesAttributes)
public java.util.List _getOpenContentPropertiesAttributes()
|
EclipseLink 1.0_1.0M2 API Reference - Incubation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |