SDODataObject (EclipseLink 2.0.0, build 'v20091127-r5931' API Reference)

Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

EclipseLink 2.0.0, build 'v20091127-r5931' API Reference

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.persistence.sdo
Class SDODataObject

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

All Implemented Interfaces:: DataObject, java.io.Serializable, SequencedObject

Direct Known Subclasses:: OpenSequencedTypeImpl

public class SDODataObject
extends java.lang.Object
implements DataObject, SequencedObject
extends java.lang.Object
implements DataObject, SequencedObject

See Also:: Serialized Form

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.
`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(SDOChangeSummary 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`	`_setSdoRef(java.lang.String newRef)`
`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:
`SDODataObject`	`createDataObject(int propertyIndex)` Returns a new `data object` contained by this object using the specified property, which must be a `containment property`.
`SDODataObject`	`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`.
`SDODataObject`	`createDataObject(Property aProperty)` Returns a new `data object` contained by this object using the specified property, which must be a `containment property`.
`SDODataObject`	`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`.
`SDODataObject`	`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).
`Property`	`defineOpenContentProperty(java.lang.String name, java.lang.Object value, Type sdotype)`
`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(Property property)` Returns the value of the given property of this object.
`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(Property property)` Returns the value of the specified `BigDecimal` property.
`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(Property property)` Returns the value of the specified `BigInteger` property.
`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(Property property)` Returns the value of the specified `boolean` property.
`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(Property property)` Returns the value of the specified `byte` property.
`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(Property property)` Returns the value of the specified `byte[]` property.
`byte[]`	`getBytes(java.lang.String path)` Returns the value of a `byte[]` property identified by the specified path.
`SDOChangeSummary`	`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(Property property)` Returns the value of the specified `char` property.
`char`	`getChar(java.lang.String path)` Returns the value of a `char` property identified by the specified path.
`SDODataObject`	`getContainer()` Returns the containing `data object` or `null` if there is no container.
`SDOProperty`	`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.
`SDODataObject`	`getDataObject(int propertyIndex)` Returns the value of a `DataObject` property identified by the specified property index.
`SDODataObject`	`getDataObject(Property property)` Returns the value of the specified `DataObject` property.
`SDODataObject`	`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(Property property)` Returns the value of the specified `Date` property.
`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(Property property)` Returns the value of the specified `double` property.
`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(Property property)` Returns the value of the specified `float` property.
`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.
`SDOProperty`	`getInstanceProperty(int propertyIndex)` INTERNAL:
`SDOProperty`	`getInstanceProperty(java.lang.String propertyName)` Returns the named Property from the current instance properties, or null if not found.
`int`	`getInt(int propertyIndex)` Returns the value of a `int` property identified by the specified property index.
`int`	`getInt(Property property)` Returns the value of the specified `int` property.
`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(Property property)` Returns the value of the specified `List` property.
`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(Property property)` Returns the value of the specified `long` property.
`long`	`getLong(java.lang.String path)` Returns the value of a `long` property identified by the specified path.
`SDOProperty`	`getProperty(java.lang.String propertyName)`
`java.lang.Object`	`getPropertyInternal(Property property)` INTERNAL: Get the value of the property (open-content or declared)..
`SDODataObject`	`getRootObject()` Returns the root `data object`.
`SDOSequence`	`getSequence()` Returns the `Sequence` for this DataObject.
`Sequence`	`getSequence(int propertyIndex)` Deprecated. in SDO 2.1.0.
`Sequence`	`getSequence(Property property)` Deprecated. in SDO 2.1.0.
`Sequence`	`getSequence(java.lang.String path)` Deprecated. in SDO 2.1.0.
`java.util.List<Setting>`	`getSettings()`
`short`	`getShort(int propertyIndex)` Returns the value of a `short` property identified by the specified property index.
`short`	`getShort(Property property)` Returns the value of the specified `short` property.
`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(Property property)` Returns the value of the specified `String` property.
`java.lang.String`	`getString(java.lang.String path)` Returns the value of a `String` property identified by the specified path.
`SDOType`	`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(Property property)` Returns whether the property of the object 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)` Sets the value of the given property of the object to the new value.
`void`	`set(SDOProperty 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(Property property, java.math.BigDecimal value)` Sets the value of the specified `BigDecimal` property, 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(Property property, java.math.BigInteger value)` Sets the value of the specified `BigInteger` property, 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(Property property, boolean value)` Sets the value of the specified `boolean` property, 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(Property property, byte value)` Sets the value of the specified `byte` property, 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(Property property, byte[] value)` Sets the value of the specified `byte[]` property, 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(Property property, char value)` Sets the value of the specified `char` property, 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(Property property, DataObject value)` Sets the value of the specified `DataObject` property, 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(Property property, java.util.Date value)` Sets the value of the specified `Date` property, 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(Property property, double value)` Sets the value of the specified `double` property, 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(Property property, float value)` Sets the value of the specified `float` property, 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(Property property, int value)` Sets the value of the specified `int` property, 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`	`setInternal(SDOProperty property, java.lang.Object value, boolean updateSequence)`
`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(Property property, java.util.List value)` Sets the value of the specified `List` property, 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(Property property, long value)` Sets the value of the specified `long` property, 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(SDOProperty 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(Property property, short value)` Sets the value of the specified `short` property, 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(Property property, java.lang.String value)` Sets the value of the specified `String` property, 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)` Unsets the property of the object.
`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
`void`	`updateContainment(Property property, SDODataObject value)` INTERNAL: update containment and the update the sequence value by default.
`void`	`updateContainment(Property property, SDODataObject aDataObject, boolean updateSequence)` INTERNAL: Update containment on the dataObject with specified 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

SDODataObject

public SDODataObject()

INTERNAL: Private constructor. Use #SDODataObject(HelperContext) instead

Method Detail

_setHelperContext

public void _setHelperContext(HelperContext aContext)

INTERNAL: Set the HelperContext that will be associated with this DataObject.

Parameters:: aContext -

get

public java.lang.Object get(java.lang.String path)

Description copied from interface: DataObject

Returns the value of a property of either this object or an object reachable from it, as identified by the specified path.

Specified by:: get in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the value of the specified property.
See Also:: DataObject.get(Property)

set

public void set(java.lang.String path,
                java.lang.Object value)
         throws java.lang.ClassCastException,
                java.lang.UnsupportedOperationException,
                java.lang.IllegalArgumentException

Description copied from interface: DataObject

Sets a property of either this object or an object reachable from it, as identified by the specified path, to the specified value.

Specified by:: set in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
Throws:: java.lang.ClassCastException; java.lang.UnsupportedOperationException; java.lang.IllegalArgumentException
See Also:: DataObject.set(Property, Object)

isSet

public boolean isSet(java.lang.String path)

Description copied from interface: DataObject

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.

Specified by:: isSet in interface DataObject

Parameters:: path - the path to a valid object and property.
See Also:: DataObject.isSet(Property)

unset

public void unset(java.lang.String path)

Description copied from interface: DataObject

Unsets a property of either this object or an object reachable from it, as identified by the specified path.

Specified by:: unset in interface DataObject

Parameters:: path - the path to a valid object and property.
See Also:: DataObject.unset(Property)

getBoolean

public boolean getBoolean(java.lang.String path)
                   throws java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a boolean property identified by the specified path.

Specified by:: getBoolean in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the boolean value of the specified property.
Throws:: java.lang.ClassCastException
See Also:: DataObject.get(String)

getByte

public byte getByte(java.lang.String path)

Description copied from interface: DataObject

Returns the value of a byte property identified by the specified path.

Specified by:: getByte in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the byte value of the specified property.
See Also:: DataObject.get(String)

getChar

public char getChar(java.lang.String path)

Description copied from interface: DataObject

Returns the value of a char property identified by the specified path.

Specified by:: getChar in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the char value of the specified property.
See Also:: DataObject.get(String)

getDouble

public double getDouble(java.lang.String path)

Description copied from interface: DataObject

Returns the value of a double property identified by the specified path.

Specified by:: getDouble in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the double value of the specified property.
See Also:: DataObject.get(String)

getFloat

public float getFloat(java.lang.String path)

Description copied from interface: DataObject

Returns the value of a float property identified by the specified path.

Specified by:: getFloat in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the float value of the specified property.
See Also:: DataObject.get(String)

getInt

public int getInt(java.lang.String path)

Description copied from interface: DataObject

Returns the value of a int property identified by the specified path.

Specified by:: getInt in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the int value of the specified property.
See Also:: DataObject.get(String)

getLong

public long getLong(java.lang.String path)

Description copied from interface: DataObject

Returns the value of a long property identified by the specified path.

Specified by:: getLong in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the long value of the specified property.
See Also:: DataObject.get(String)

getShort

public short getShort(java.lang.String path)

Description copied from interface: DataObject

Returns the value of a short property identified by the specified path.

Specified by:: getShort in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the short value of the specified property.
See Also:: DataObject.get(String)

getBytes

public byte[] getBytes(java.lang.String path)

Description copied from interface: DataObject

Returns the value of a byte[] property identified by the specified path.

Specified by:: getBytes in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the byte[] value of the specified property.
See Also:: DataObject.get(String)

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String path)

Description copied from interface: DataObject

Returns the value of a BigDecimal property identified by the specified path.

Specified by:: getBigDecimal in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the BigDecimal value of the specified property.
See Also:: DataObject.get(String)

getBigInteger

public java.math.BigInteger getBigInteger(java.lang.String path)

Description copied from interface: DataObject

Returns the value of a BigInteger property identified by the specified path.

Specified by:: getBigInteger in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the BigInteger value of the specified property.
See Also:: DataObject.get(String)

getDataObject

public SDODataObject getDataObject(java.lang.String path)
                            throws java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a DataObject property identified by the specified path.

Specified by:: getDataObject in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the DataObject value of the specified property.
Throws:: java.lang.ClassCastException
See Also:: DataObject.get(String)

getDate

public java.util.Date getDate(java.lang.String path)

Description copied from interface: DataObject

Returns the value of a Date property identified by the specified path.

Specified by:: getDate in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the Date value of the specified property.
See Also:: DataObject.get(String)

getString

public java.lang.String getString(java.lang.String path)

Description copied from interface: DataObject

Returns the value of a String property identified by the specified path.

Specified by:: getString in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the String value of the specified property.
See Also:: DataObject.get(String)

getList

public java.util.List getList(java.lang.String path)

Description copied from interface: DataObject

Returns the value of a List property identified by the specified path.

Specified by:: getList in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the List value of the specified property.
See Also:: DataObject.get(String)

setBoolean

public void setBoolean(java.lang.String path,
                       boolean value)

Description copied from interface: DataObject

Sets the value of a boolean property identified by the specified path, to the specified value.

Specified by:: setBoolean in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object)

setByte

public void setByte(java.lang.String path,
                    byte value)

Description copied from interface: DataObject

Sets the value of a byte property identified by the specified path, to the specified value.

Specified by:: setByte in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object)

setChar

public void setChar(java.lang.String path,
                    char value)

Description copied from interface: DataObject

Sets the value of a char property identified by the specified path, to the specified value.

Specified by:: setChar in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object)

setDouble

public void setDouble(java.lang.String path,
                      double value)

Description copied from interface: DataObject

Sets the value of a double property identified by the specified path, to the specified value.

Specified by:: setDouble in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object)

setFloat

public void setFloat(java.lang.String path,
                     float value)

Description copied from interface: DataObject

Sets the value of a float property identified by the specified path, to the specified value.

Specified by:: setFloat in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object)

setInt

public void setInt(java.lang.String path,
                   int value)

Description copied from interface: DataObject

Sets the value of a int property identified by the specified path, to the specified value.

Specified by:: setInt in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object)

setLong

public void setLong(java.lang.String path,
                    long value)

Description copied from interface: DataObject

Sets the value of a long property identified by the specified path, to the specified value.

Specified by:: setLong in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object)

setShort

public void setShort(java.lang.String path,
                     short value)

Description copied from interface: DataObject

Sets the value of a short property identified by the specified path, to the specified value.

Specified by:: setShort in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object)

setBytes

public void setBytes(java.lang.String path,
                     byte[] value)

Description copied from interface: DataObject

Sets the value of a byte[] property identified by the specified path, to the specified value.

Specified by:: setBytes in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object)

setBigDecimal

public void setBigDecimal(java.lang.String path,
                          java.math.BigDecimal value)

Description copied from interface: DataObject

Sets the value of a BigDecimal property identified by the specified path, to the specified value.

Specified by:: setBigDecimal in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object)

setBigInteger

public void setBigInteger(java.lang.String path,
                          java.math.BigInteger value)

Description copied from interface: DataObject

Sets the value of a BigInteger property identified by the specified path, to the specified value.

Specified by:: setBigInteger in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object)

setDataObject

public void setDataObject(java.lang.String path,
                          DataObject value)

Description copied from interface: DataObject

Sets the value of a DataObject property identified by the specified path, to the specified value.

Specified by:: setDataObject in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object)

setDate

public void setDate(java.lang.String path,
                    java.util.Date value)

Description copied from interface: DataObject

Sets the value of a Date property identified by the specified path, to the specified value.

Specified by:: setDate in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object)

setString

public void setString(java.lang.String path,
                      java.lang.String value)

Description copied from interface: DataObject

Sets the value of a String property identified by the specified path, to the specified value.

Specified by:: setString in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object)

setList

public void setList(java.lang.String path,
                    java.util.List value)

Description copied from interface: DataObject

Sets the value of a List property identified by the specified path, to the specified value.

Specified by:: setList in interface DataObject

Parameters:: path - the path to a valid object and property.; value - the new value for the property.
See Also:: DataObject.set(String, Object), DataObject.setList(Property, List)

get

public java.lang.Object get(int propertyIndex)
                     throws java.lang.IllegalArgumentException

Description copied from interface: DataObject

Returns the value of the property at the specified index in property list of this object's type.

Specified by:: get in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the value of the specified property.
Throws:: java.lang.IllegalArgumentException
See Also:: DataObject.get(Property)

set

public void set(int propertyIndex,
                java.lang.Object value)

Description copied from interface: DataObject

Sets the property at the specified index in property list of this object's type, to the specified value.

Specified by:: set in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

isSet

public boolean isSet(int propertyIndex)

Description copied from interface: DataObject

Returns whether the the property at the specified index in property list of this object's type, is considered to be set.

Specified by:: isSet in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: whether the specified property is set.
See Also:: DataObject.isSet(Property)

unset

public void unset(int propertyIndex)

Description copied from interface: DataObject

Unsets the property at the specified index in property list of this object's type.

Specified by:: unset in interface DataObject

Parameters:: propertyIndex - the index of the property.
See Also:: DataObject.unset(Property)

getBoolean

public boolean getBoolean(int propertyIndex)
                   throws java.lang.IllegalArgumentException,
                          java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a boolean property identified by the specified property index.

Specified by:: getBoolean in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the boolean value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(int)

getByte

public byte getByte(int propertyIndex)
             throws java.lang.IllegalArgumentException,
                    java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a byte property identified by the specified property index.

Specified by:: getByte in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the byte value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(int)

getChar

public char getChar(int propertyIndex)
             throws java.lang.IllegalArgumentException,
                    java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a char property identified by the specified property index.

Specified by:: getChar in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the char value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(int)

getDouble

public double getDouble(int propertyIndex)
                 throws java.lang.IllegalArgumentException,
                        java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a double property identified by the specified property index.

Specified by:: getDouble in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the double value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(int)

getFloat

public float getFloat(int propertyIndex)
               throws java.lang.IllegalArgumentException,
                      java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a float property identified by the specified property index.

Specified by:: getFloat in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the float value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(int)

getInt

public int getInt(int propertyIndex)
           throws java.lang.IllegalArgumentException,
                  java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a int property identified by the specified property index.

Specified by:: getInt in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the int value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(int)

getLong

public long getLong(int propertyIndex)
             throws java.lang.IllegalArgumentException,
                    java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a long property identified by the specified property index.

Specified by:: getLong in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the long value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(int)

getShort

public short getShort(int propertyIndex)
               throws java.lang.IllegalArgumentException,
                      java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a short property identified by the specified property index.

Specified by:: getShort in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the short value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(int)

getBytes

public byte[] getBytes(int propertyIndex)
                throws java.lang.IllegalArgumentException,
                       java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a byte[] property identified by the specified property index.

Specified by:: getBytes in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the byte[] value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(int)

getBigDecimal

public java.math.BigDecimal getBigDecimal(int propertyIndex)
                                   throws java.lang.IllegalArgumentException,
                                          java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a BigDecimal property identified by the specified property index.

Specified by:: getBigDecimal in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the BigDecimal value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(int)

getBigInteger

public java.math.BigInteger getBigInteger(int propertyIndex)
                                   throws java.lang.IllegalArgumentException,
                                          java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a BigInteger property identified by the specified property index.

Specified by:: getBigInteger in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the BigInteger value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(int)

getDataObject

public SDODataObject getDataObject(int propertyIndex)

Description copied from interface: DataObject

Returns the value of a DataObject property identified by the specified property index.

Specified by:: getDataObject in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the DataObject value of the specified property.
See Also:: DataObject.get(int)

getDate

public java.util.Date getDate(int propertyIndex)
                       throws java.lang.IllegalArgumentException,
                              java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a Date property identified by the specified property index.

Specified by:: getDate in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the Date value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(int)

getString

public java.lang.String getString(int propertyIndex)
                           throws java.lang.IllegalArgumentException,
                                  java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of a String property identified by the specified property index.

Specified by:: getString in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the String value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(int)

getList

public java.util.List getList(int propertyIndex)

Description copied from interface: DataObject

Returns the value of a List property identified by the specified property index.

Specified by:: getList in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the List value of the specified property.
See Also:: DataObject.get(int)

getSequence

public Sequence getSequence(java.lang.String path)

Deprecated. in SDO 2.1.0.

Specified by:: getSequence in interface DataObject

Parameters:: path - the path to a valid object and property.
Returns:: the Sequence value of the specified property.
See Also:: Returns the value of a Sequence property identified by the specified path. An implementation may throw an UnsupportedOperationException., DataObject.get(String)

getSequence

public Sequence getSequence(int propertyIndex)

Deprecated. in SDO 2.1.0.

Specified by:: getSequence in interface DataObject

Parameters:: propertyIndex - the index of the property.
Returns:: the Sequence value of the specified property.
See Also:: Returns the value of a Sequence property identified by the specified property index. An implementation may throw an UnsupportedOperationException., DataObject.get(int)

getSequence

public Sequence getSequence(Property property)

Deprecated. in SDO 2.1.0.

Specified by:: getSequence in interface DataObject

Parameters:: property - the property to get.
Returns:: the Sequence value of the specified property.
See Also:: Returns the value of the specified Sequence property. An implementation may throw an UnsupportedOperationException., DataObject.get(Property)

getSequence

public SDOSequence getSequence()

Description copied from interface: DataObject

Returns the 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.

Specified by:: getSequence in interface DataObject

Returns:: the Sequence or null.

setBoolean

public void setBoolean(int propertyIndex,
                       boolean value)

Description copied from interface: DataObject

Sets the value of a boolean property identified by the specified property index, to the specified value.

Specified by:: setBoolean in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object)

setByte

public void setByte(int propertyIndex,
                    byte value)

Description copied from interface: DataObject

Sets the value of a byte property identified by the specified property index, to the specified value.

Specified by:: setByte in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object)

setChar

public void setChar(int propertyIndex,
                    char value)

Description copied from interface: DataObject

Sets the value of a char property identified by the specified property index, to the specified value.

Specified by:: setChar in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object)

setDouble

public void setDouble(int propertyIndex,
                      double value)

Description copied from interface: DataObject

Sets the value of a double property identified by the specified property index, to the specified value.

Specified by:: setDouble in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object)

setFloat

public void setFloat(int propertyIndex,
                     float value)

Description copied from interface: DataObject

Sets the value of a float property identified by the specified property index, to the specified value.

Specified by:: setFloat in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object)

setInt

public void setInt(int propertyIndex,
                   int value)

Description copied from interface: DataObject

Sets the value of a int property identified by the specified property index, to the specified value.

Specified by:: setInt in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object)

setLong

public void setLong(int propertyIndex,
                    long value)

Description copied from interface: DataObject

Sets the value of a long property identified by the specified property index, to the specified value.

Specified by:: setLong in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object)

setShort

public void setShort(int propertyIndex,
                     short value)

Description copied from interface: DataObject

Sets the value of a short property identified by the specified property index, to the specified value.

Specified by:: setShort in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object)

setBytes

public void setBytes(int propertyIndex,
                     byte[] value)

Description copied from interface: DataObject

Sets the value of a byte[] property identified by the specified property index, to the specified value.

Specified by:: setBytes in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object)

setBigDecimal

public void setBigDecimal(int propertyIndex,
                          java.math.BigDecimal value)

Description copied from interface: DataObject

Sets the value of a BigDecimal property identified by the specified property index, to the specified value.

Specified by:: setBigDecimal in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object)

setBigInteger

public void setBigInteger(int propertyIndex,
                          java.math.BigInteger value)

Description copied from interface: DataObject

Sets the value of a BigInteger property identified by the specified property index, to the specified value.

Specified by:: setBigInteger in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object)

setDataObject

public void setDataObject(int propertyIndex,
                          DataObject value)

Description copied from interface: DataObject

Sets the value of a DataObject property identified by the specified property index, to the specified value.

Specified by:: setDataObject in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object)

setDate

public void setDate(int propertyIndex,
                    java.util.Date value)

Description copied from interface: DataObject

Sets the value of a Date property identified by the specified property index, to the specified value.

Specified by:: setDate in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object)

setString

public void setString(int propertyIndex,
                      java.lang.String value)

Description copied from interface: DataObject

Sets the value of a String property identified by the specified property index, to the specified value.

Specified by:: setString in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object)

setList

public void setList(int propertyIndex,
                    java.util.List value)

Description copied from interface: DataObject

Sets the value of a List property identified by the specified property index, to the specified value.

Specified by:: setList in interface DataObject

Parameters:: propertyIndex - the index of the property.; value - the new value for the property.
See Also:: DataObject.set(int, Object), DataObject.setList(Property, List)

get

public java.lang.Object get(Property property)
                     throws java.lang.IllegalArgumentException

Description copied from interface: DataObject

Returns the value of the given property of this object.

If the property is many-valued, the result will be a List and each object in the List will be an instance of the property's type. Otherwise the result will directly be an instance of the property's type.

Specified by:: get in interface DataObject

Parameters:: property - the property of the value to fetch.
Returns:: the value of the given property of the object.
Throws:: java.lang.IllegalArgumentException
See Also:: DataObject.set(Property, Object), DataObject.unset(Property), DataObject.isSet(Property)

defineOpenContentProperty

public Property defineOpenContentProperty(java.lang.String name,
                                          java.lang.Object value)
                                   throws java.lang.UnsupportedOperationException,
                                          java.lang.IllegalArgumentException

INTERNAL: Create a dynamic open content property if no property exists for (name).

Parameters:: name -; value -
Returns:: Property
Throws:: java.lang.UnsupportedOperationException; java.lang.IllegalArgumentException

defineOpenContentProperty

public Property defineOpenContentProperty(java.lang.String name,
                                          java.lang.Object value,
                                          Type sdotype)
                                   throws java.lang.UnsupportedOperationException,
                                          java.lang.IllegalArgumentException

Throws:: java.lang.UnsupportedOperationException; java.lang.IllegalArgumentException

set

public void set(Property property,
                java.lang.Object value)
         throws java.lang.UnsupportedOperationException,
                java.lang.IllegalArgumentException

Description copied from interface: DataObject

Sets the value of the given property of the object to the new value.

If the property is many-valued, the new value must be a List and each object in that list must be an instance of the property's type; the existing contents are cleared and the contents of the new value are added. Otherwise the new value directly must be an instance of the property's type and it becomes the new value of the property of the object.

Specified by:: set in interface DataObject

Parameters:: property - the property of the value to set.; value - the new value for the property.
Throws:: java.lang.UnsupportedOperationException; java.lang.IllegalArgumentException
See Also:: DataObject.unset(Property), DataObject.isSet(Property), DataObject.get(Property)

setInternal

public void setInternal(SDOProperty property,
                        java.lang.Object value,
                        boolean updateSequence)
                 throws java.lang.UnsupportedOperationException,
                        java.lang.IllegalArgumentException

Throws:: java.lang.UnsupportedOperationException; java.lang.IllegalArgumentException

set

public void set(SDOProperty property,
                java.lang.Object value,
                boolean updateSequence)
         throws java.lang.UnsupportedOperationException,
                java.lang.IllegalArgumentException

INTERNAL: Sets the value of the given property of the object to the new value.

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.

Parameters:: property -; value -; updateSequence -
Throws:: java.lang.UnsupportedOperationException; java.lang.IllegalArgumentException

isSet

public boolean isSet(Property property)

Description copied from interface: DataObject

Returns whether the property of the object is considered to be set.

isSet() for many-valued Properties returns true if the List is not empty and false if the List is empty. For single-valued Properties it returns true if the Property has been set() and not unset(), and false otherwise. Any call to set() without a call to unset() will cause isSet() to return true, regardless of the value being set. For example, after calling set(property, property.getDefault()) on a previously unset property, isSet(property) will return true, even though the value of get(property) will be unchanged.

Specified by:: isSet in interface DataObject

Parameters:: property - the property in question.
Returns:: whether the property of the object is set.
See Also:: DataObject.set(Property, Object), DataObject.unset(Property), DataObject.get(Property)

unset

public void unset(Property property)

Description copied from interface: DataObject

Unsets the property of the object.

If the property is many-valued, the value must be an List and that list is cleared. Otherwise, the value of the property of the object is set to the property's default value. The property will no longer be considered set.

Specified by:: unset in interface DataObject

Parameters:: property - the property in question.
See Also:: DataObject.isSet(Property), DataObject.set(Property, Object), DataObject.get(Property)

unset

public void unset(Property property,
                  boolean fromDelete,
                  boolean updateSequence)

INTERNAL: Unset the specified property on this DataObject. The fromDelete parameter specifies whether we are from a delete or unset/detach operation. The updateSequence parameter is used internally to stop a bidirectional update in the SDOSequence when originally called from this Sequence.

Parameters:: property -; fromDelete -; updateSequence -

getBoolean

public boolean getBoolean(Property property)
                   throws java.lang.IllegalArgumentException,
                          java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of the specified boolean property.

Specified by:: getBoolean in interface DataObject

Parameters:: property - the property to get.
Returns:: the boolean value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(Property)

getByte

public byte getByte(Property property)
             throws java.lang.IllegalArgumentException,
                    java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of the specified byte property.

Specified by:: getByte in interface DataObject

Parameters:: property - the property to get.
Returns:: the byte value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(Property)

getChar

public char getChar(Property property)
             throws java.lang.IllegalArgumentException

Description copied from interface: DataObject

Returns the value of the specified char property.

Specified by:: getChar in interface DataObject

Parameters:: property - the property to get.
Returns:: the char value of the specified property.
Throws:: java.lang.IllegalArgumentException
See Also:: DataObject.get(Property)

getDouble

public double getDouble(Property property)
                 throws java.lang.IllegalArgumentException

Description copied from interface: DataObject

Returns the value of the specified double property.

Specified by:: getDouble in interface DataObject

Parameters:: property - the property to get.
Returns:: the double value of the specified property.
Throws:: java.lang.IllegalArgumentException
See Also:: DataObject.get(Property)

getFloat

public float getFloat(Property property)
               throws java.lang.IllegalArgumentException

Description copied from interface: DataObject

Returns the value of the specified float property.

Specified by:: getFloat in interface DataObject

Parameters:: property - the property to get.
Returns:: the float value of the specified property.
Throws:: java.lang.IllegalArgumentException
See Also:: DataObject.get(Property)

getInt

public int getInt(Property property)
           throws java.lang.IllegalArgumentException

Description copied from interface: DataObject

Returns the value of the specified int property.

Specified by:: getInt in interface DataObject

Parameters:: property - the property to get.
Returns:: the int value of the specified property.
Throws:: java.lang.IllegalArgumentException
See Also:: DataObject.get(Property)

getLong

public long getLong(Property property)
             throws java.lang.IllegalArgumentException

Description copied from interface: DataObject

Returns the value of the specified long property.

Specified by:: getLong in interface DataObject

Parameters:: property - the property to get.
Returns:: the long value of the specified property.
Throws:: java.lang.IllegalArgumentException
See Also:: DataObject.get(Property)

getShort

public short getShort(Property property)
               throws java.lang.IllegalArgumentException

Description copied from interface: DataObject

Returns the value of the specified short property.

Specified by:: getShort in interface DataObject

Parameters:: property - the property to get.
Returns:: the short value of the specified property.
Throws:: java.lang.IllegalArgumentException
See Also:: DataObject.get(Property)

getBytes

public byte[] getBytes(Property property)
                throws java.lang.IllegalArgumentException

Description copied from interface: DataObject

Returns the value of the specified byte[] property.

Specified by:: getBytes in interface DataObject

Parameters:: property - the property to get.
Returns:: the byte[] value of the specified property.
Throws:: java.lang.IllegalArgumentException
See Also:: DataObject.get(Property)

getBigDecimal

public java.math.BigDecimal getBigDecimal(Property property)
                                   throws java.lang.IllegalArgumentException

Description copied from interface: DataObject

Returns the value of the specified BigDecimal property.

Specified by:: getBigDecimal in interface DataObject

Parameters:: property - the property to get.
Returns:: the BigDecimal value of the specified property.
Throws:: java.lang.IllegalArgumentException
See Also:: DataObject.get(Property)

getBigInteger

public java.math.BigInteger getBigInteger(Property property)
                                   throws java.lang.IllegalArgumentException

Description copied from interface: DataObject

Returns the value of the specified BigInteger property.

Specified by:: getBigInteger in interface DataObject

Parameters:: property - the property to get.
Returns:: the BigInteger value of the specified property.
Throws:: java.lang.IllegalArgumentException
See Also:: DataObject.get(Property)

getDataObject

public SDODataObject getDataObject(Property property)
                            throws java.lang.IllegalArgumentException,
                                   java.lang.ClassCastException

Description copied from interface: DataObject

Returns the value of the specified DataObject property.

Specified by:: getDataObject in interface DataObject

Parameters:: property - the property to get.
Returns:: the DataObject value of the specified property.
Throws:: java.lang.IllegalArgumentException; java.lang.ClassCastException
See Also:: DataObject.get(Property)

getDate

public java.util.Date getDate(Property property)

Description copied from interface: DataObject

Returns the value of the specified Date property.

Specified by:: getDate in interface DataObject

Parameters:: property - the property to get.
Returns:: the Date value of the specified property.
See Also:: DataObject.get(Property)

getString

public java.lang.String getString(Property property)

Description copied from interface: DataObject

Returns the value of the specified String property.

Specified by:: getString in interface DataObject

Parameters:: property - the property to get.
Returns:: the String value of the specified property.
See Also:: DataObject.get(Property)

getList

public java.util.List getList(Property property)

Description copied from interface: DataObject

Returns the value of the specified List property. The List returned contains the current values. Updates through the List interface operate on the current values of the DataObject. Each access returns the same List object.

Specified by:: getList in interface DataObject

Parameters:: property - the property to get.
Returns:: the List value of the specified property.
See Also:: DataObject.get(Property)

setBoolean

public void setBoolean(Property property,
                       boolean value)

Description copied from interface: DataObject

Sets the value of the specified boolean property, to the specified value.

Specified by:: setBoolean in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

setByte

public void setByte(Property property,
                    byte value)

Description copied from interface: DataObject

Sets the value of the specified byte property, to the specified value.

Specified by:: setByte in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

setChar

public void setChar(Property property,
                    char value)

Description copied from interface: DataObject

Sets the value of the specified char property, to the specified value.

Specified by:: setChar in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

setDouble

public void setDouble(Property property,
                      double value)

Description copied from interface: DataObject

Sets the value of the specified double property, to the specified value.

Specified by:: setDouble in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

setFloat

public void setFloat(Property property,
                     float value)

Description copied from interface: DataObject

Sets the value of the specified float property, to the specified value.

Specified by:: setFloat in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

setInt

public void setInt(Property property,
                   int value)

Description copied from interface: DataObject

Sets the value of the specified int property, to the specified value.

Specified by:: setInt in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

setLong

public void setLong(Property property,
                    long value)

Description copied from interface: DataObject

Sets the value of the specified long property, to the specified value.

Specified by:: setLong in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

setShort

public void setShort(Property property,
                     short value)

Description copied from interface: DataObject

Sets the value of the specified short property, to the specified value.

Specified by:: setShort in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

setBytes

public void setBytes(Property property,
                     byte[] value)

Description copied from interface: DataObject

Sets the value of the specified byte[] property, to the specified value.

Specified by:: setBytes in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

setBigDecimal

public void setBigDecimal(Property property,
                          java.math.BigDecimal value)

Description copied from interface: DataObject

Sets the value of the specified BigDecimal property, to the specified value.

Specified by:: setBigDecimal in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

setBigInteger

public void setBigInteger(Property property,
                          java.math.BigInteger value)

Description copied from interface: DataObject

Sets the value of the specified BigInteger property, to the specified value.

Specified by:: setBigInteger in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

setDataObject

public void setDataObject(Property property,
                          DataObject value)

Description copied from interface: DataObject

Sets the value of the specified DataObject property, to the specified value.

Specified by:: setDataObject in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

setDate

public void setDate(Property property,
                    java.util.Date value)

Description copied from interface: DataObject

Sets the value of the specified Date property, to the specified value.

Specified by:: setDate in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

setString

public void setString(Property property,
                      java.lang.String value)

Description copied from interface: DataObject

Sets the value of the specified String property, to the specified value.

Specified by:: setString in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

setList

public void setList(Property property,
                    java.util.List value)

Description copied from interface: DataObject

Sets the value of the specified List property, to the specified value.

The new value must be a List and each object in that list must be an instance of the property's type; the existing contents are cleared and the contents of the new value are added.

Specified by:: setList in interface DataObject

Parameters:: property - the property to set.; value - the new value for the property.
See Also:: DataObject.set(Property, Object)

createDataObject

public DataObject createDataObject(java.lang.String propertyName)

Description copied from interface: DataObject

Returns a new 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.

Specified by:: createDataObject in interface DataObject

Parameters:: propertyName - the name of the specified containment property.
Returns:: the created data object.
See Also:: DataObject.createDataObject(String, String, String)

createDataObject

public SDODataObject createDataObject(int propertyIndex)

Description copied from interface: DataObject

Specified by:: createDataObject in interface DataObject

Parameters:: propertyIndex - the index of the specified containment property.
Returns:: the created data object.
See Also:: DataObject.createDataObject(int, String, String)

createDataObject

public SDODataObject createDataObject(Property aProperty)

Description copied from interface: DataObject

Specified by:: createDataObject in interface DataObject

Parameters:: aProperty - the specified containment property.
Returns:: the created data object.
See Also:: DataObject.createDataObject(Property, Type)

createDataObject

public SDODataObject createDataObject(java.lang.String propertyName,
                                      java.lang.String namespaceURI,
                                      java.lang.String typeName)

Description copied from interface: DataObject

Returns a new 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.

Specified by:: createDataObject in interface DataObject

Parameters:: 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.
Returns:: the created data object.
See Also:: DataObject.createDataObject(String), TypeHelper.getType(java.lang.String, java.lang.String)

createDataObject

public SDODataObject createDataObject(int propertyIndex,
                                      java.lang.String namespaceURI,
                                      java.lang.String typeName)

Description copied from interface: DataObject

Specified by:: createDataObject in interface DataObject

Parameters:: 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.
Returns:: the created data object.
See Also:: DataObject.createDataObject(int), TypeHelper.getType(java.lang.String, java.lang.String)

createDataObject

public SDODataObject createDataObject(Property property,
                                      Type aType)

Description copied from interface: DataObject

Returns a new 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 speicifed property.

Specified by:: createDataObject in interface DataObject

Parameters:: property - a containment property of this object.; aType - the type of object to be created.
Returns:: the created data object.
See Also:: DataObject.createDataObject(int)

detachOrDelete

public void detachOrDelete(boolean fromDelete)

INTERNAL: Recursively walk the tree and set oldSettings for a detached/deleted object. This function performs a single preOrder traversal of the tree. An unset is done for each property if the action = delete Implementors: detach() and delete() via detach

Parameters:: fromDelete - (flag the action true = delete, false = detach)

detach

public void detach()

Description copied from interface: DataObject

Removes this DataObject from its container, if any. Same as getContainer().getList(getContainmentProperty()).remove(this) or getContainer().unset(getContainmentProperty()) depending on getContainmentProperty().isMany() respectively.

Specified by:: detach in interface DataObject

delete

public void delete()

Description copied from interface: DataObject

Remove this object from its container and then unset all its non-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.

Specified by:: delete in interface DataObject

getContainer

public SDODataObject getContainer()

Description copied from interface: DataObject

Returns the containing data object or null if there is no container.

Specified by:: getContainer in interface DataObject

Returns:: the containing data object or null.

getContainmentProperty

public SDOProperty getContainmentProperty()

Description copied from interface: DataObject

Return the Property of the data object containing this data object or null if there is no container.

Specified by:: getContainmentProperty in interface DataObject

Returns:: the property containing this data object.

getDataGraph

public DataGraph getDataGraph()

Description copied from interface: DataObject

Returns the data graph for this object or null if there isn't one.

Specified by:: getDataGraph in interface DataObject

Returns:: the containing data graph or null.

setDataGraph

public void setDataGraph(DataGraph dataGraph)

getType

public SDOType getType()

Description copied from interface: DataObject

Returns the data object's type.

The type defines the Properties available for reflective access.

Specified by:: getType in interface DataObject

Returns:: the type.

getInstanceProperties

public java.util.List getInstanceProperties()

Description copied from interface: DataObject

Returns a read-only List of the Properties currently used in this DataObject. This list will contain all of the Properties in getType().getProperties() and any Properties where isSet(property) is true. For example, Properties resulting from the use of open or mixed XML content are present if allowed by the Type. the List does not contain duplicates. The order of the Properties in the List begins with getType().getProperties() and the order of the remaining Properties is determined by the implementation. The same list will be returned unless the DataObject is updated so that the contents of the List change.

Specified by:: getInstanceProperties in interface DataObject

Returns:: the List of Properties currently used in this DataObject.

getProperty

public SDOProperty getProperty(java.lang.String propertyName)

Specified by:: getProperty in interface DataObject

getInstanceProperty

public SDOProperty getInstanceProperty(java.lang.String propertyName)

Description copied from interface: DataObject

Returns the named Property from the current instance properties, or null if not found. The instance properties are getInstanceProperties().

Specified by:: getInstanceProperty in interface DataObject

Parameters:: propertyName - the name of the Property
Returns:: the named Property from the DataObject's current instance properties, or null.

getInstanceProperty

public SDOProperty getInstanceProperty(int propertyIndex)
                                throws java.lang.IllegalArgumentException

INTERNAL:

Parameters:: propertyIndex -
Returns:
Throws:: SDOException; java.lang.IllegalArgumentException

getRootObject

public SDODataObject getRootObject()

Description copied from interface: DataObject

Returns the root data object.

Specified by:: getRootObject in interface DataObject

Returns:: the root data object.

getChangeSummary

public SDOChangeSummary getChangeSummary()

Description copied from interface: DataObject

Returns the ChangeSummary with scope covering this dataObject, or null if there is no ChangeSummary.

Specified by:: getChangeSummary in interface DataObject

Returns:: the ChangeSummary with scope covering this dataObject, or null.

_setCreated

public void _setCreated(boolean created)

INTERNAL: Set flag created value.

Parameters:: created - flag created's new value.

_setModified

public void _setModified(boolean modified)

INTERNAL: Set flag modified value.

Parameters:: modified - flag modified's new value.

_setChangeSummary

public void _setChangeSummary(SDOChangeSummary aChangeSummary)

INTERNAL: Recursively Set this DataObject's ChangeSummary as passed in value.

Parameters:: aChangeSummary - the ChangeSummary taking this DataObject as root.

undoChanges

public 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. The object is returned to the state when logging was first started.

Parameters:: isCSRoot -; cs -; origContainer -; origContainmentPropName -

resetChanges

public void resetChanges()

INTERNAL: Initialize all old settings related to ChangeSummary and recursively go down the tree to initialize all DataObjects rooted at this DataObject.

_setType

public void _setType(Type aType)

INTERNAL:

Parameters:: aType -

_setCurrentValueStore

public void _setCurrentValueStore(ValueStore aValueStore)

INTERNAL: Pluggable Interface for substituting the default Map with a custom Map Class

Parameters:: currentValueStore - void

_getCurrentValueStore

public ValueStore _getCurrentValueStore()

INTERNAL: Map interface into the currentValueStore of this DataObject.
Note: Implementers of the ValueStore interface require this accessor.

Returns:

_setContainer

public void _setContainer(DataObject aContainer)

INTERNAL: Sets the DataObject which contains this DataObject.

Parameters:: aContainer - the DataObject which is the container of this DataObject.

_getOpenContentPropertiesAttributesMap

public java.util.Map _getOpenContentPropertiesAttributesMap()

_setOpenContentPropertiesAttributesMap

public void _setOpenContentPropertiesAttributesMap(java.util.Map openAttributeProperties)

_setOpenContentPropertiesWithXMLRoots

public void _setOpenContentPropertiesWithXMLRoots(java.util.List openContentPropertiesWithXMLRoots)

INTERNAL: This function is implemented by SDOType.setOpen() in a mapping setGet/SetMethodName call

Parameters:: openContentPropertiesWithXMLRoots -

_getOpenContentPropertiesWithXMLRoots

public java.util.List _getOpenContentPropertiesWithXMLRoots()

INTERNAL: This function is implemented by SDOType.setOpen() in a mapping setGet/SetMethodName call

Returns:

_getOpenContentProperties

public java.util.List _getOpenContentProperties()

INTERNAL: Returns a list of the Properties currently used in this DataObject which are not included in getType().getProperties

Returns:: the List of open content Properties currently used in this DataObject.

convertObjectToValue

public java.lang.Object convertObjectToValue(Property property,
                                             java.lang.Class cls)
                                      throws java.lang.ClassCastException,
                                             java.lang.IllegalArgumentException

INTERNAL:

Parameters:: property -; cls -
Returns:
Throws:: java.lang.ClassCastException; java.lang.IllegalArgumentException

convertObjectToValue

public java.lang.Object convertObjectToValue(Property property,
                                             int position,
                                             java.lang.Class cls)
                                      throws java.lang.ClassCastException,
                                             java.lang.IllegalArgumentException

INTERNAL:

Parameters:: property -; position -; cls -
Returns:
Throws:: java.lang.ClassCastException; java.lang.IllegalArgumentException

_setContainmentPropertyName

public void _setContainmentPropertyName(java.lang.String aContainmentPropertyName)

INTERNAL: Sets the name of the property on the containing DataObject which contains this DataObject as a value.

Parameters:: aContainmentPropertyName - the name of the property on the containing DataObject which has this DataObject as a value.

_getContainmentPropertyName

public 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.

Returns:: the property containing this data object.

parentContains

public boolean parentContains(java.lang.Object value)

INTERNAL:

Parameters:: value -
Returns:

updateContainment

public void updateContainment(Property property,
                              java.util.Collection values,
                              boolean updateSequence)

INTERNAL: Update containment with flagged update sequence state

Parameters:: property -; values -; updateSequence -

updateContainment

public void updateContainment(Property property,
                              java.util.Collection values)

INTERNAL: Update containment on the specified collection of values and default to true = update the sequence

Parameters:: property -; values -

updateContainment

public void updateContainment(Property property,
                              SDODataObject aDataObject,
                              boolean updateSequence)

INTERNAL: Update containment on the dataObject with specified update sequence state

Parameters:: property -; value -

updateContainment

public void updateContainment(Property property,
                              SDODataObject value)

INTERNAL: update containment and the update the sequence value by default.

Parameters:: property -; value -

writeReplace

public 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.

Security Note: This public function exposes a data replacement vulnerability where an outside client can gain access and modify their non-final constants. We may need to wrap the GZIP streams in some sort of encryption when we are not using HTTPS or SSL/TLS on the wire.

See Also:: SDOResolvable

_getPath

public java.lang.String _getPath()

INTERNAL: Return an SDO Path string from root of the caller to itself

Returns:: String

getPropertyInternal

public java.lang.Object getPropertyInternal(Property property)

INTERNAL: Get the value of the property (open-content or declared)..

Parameters:: property -
Returns:

setPropertyInternal

public void setPropertyInternal(SDOProperty property,
                                java.lang.Object value,
                                boolean updateSequence)

INTERNAL: Update the ValueStore with the new property value and update any sequence if it exists.

Parameters:: property -; value -; updateSequence - (truncate call back from sequence when this function was called from sequence)

addOpenContentProperty

public void addOpenContentProperty(Property property)

INTERNAL: Add the open content property into all 3 data structures. Remove the property from the unset map.

Parameters:: property -

removeOpenContentProperty

public void removeOpenContentProperty(Property property)

INTERNAL: Remove the open content property (property) from all 3 data structures. Add the property to the unset map. We restore this OC property in undoChanges

Parameters:: property -

isSetInternal

public boolean isSetInternal(Property property)

INTERNAL: Return whether the property (open-content or declared) is set?

Parameters:: property -
Returns:: true if set, false otherwise

_getSdoRef

public java.lang.String _getSdoRef()

INTERNAL: Return the sdoref attribute value during unmarshaling

Returns:

_setOpenContentPropertiesAttributes

public void _setOpenContentPropertiesAttributes(java.util.List openContentPropertiesAttributes)

_getOpenContentPropertiesAttributes

public java.util.List _getOpenContentPropertiesAttributes()

getSettings

public java.util.List<Setting> getSettings()

Specified by:: getSettings in interface SequencedObject

_setSdoRef

public void _setSdoRef(java.lang.String newRef)

Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

EclipseLink 2.0.0, build 'v20091127-r5931' API Reference

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.persistence.sdo Class SDODataObject

SDODataObject

_setHelperContext

get

set

isSet

unset

getBoolean

getByte

getChar

getDouble

getFloat

getInt

getLong

getShort

getBytes

getBigDecimal

getBigInteger

getDataObject

getDate

getString

getList

setBoolean

setByte

setChar

setDouble

setFloat

setInt

setLong

setShort

setBytes

setBigDecimal

setBigInteger

setDataObject

setDate

setString

setList

get

set

isSet

unset

getBoolean

getByte

getChar

getDouble

getFloat

getInt

getLong

getShort

getBytes

getBigDecimal

getBigInteger

getDataObject

getDate

getString

getList

getSequence

getSequence

getSequence

getSequence

setBoolean

setByte

setChar

setDouble

setFloat

setInt

setLong

setShort

setBytes

setBigDecimal

setBigInteger

setDataObject

setDate

setString

setList

get

defineOpenContentProperty

defineOpenContentProperty

set

setInternal

org.eclipse.persistence.sdo
Class SDODataObject