Overview

  		Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES  
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

 

commonj.sdo
Interface DataObject

All Superinterfaces:
Serializable

All Known Subinterfaces:
EDataObject, EDataObjectAnyType, EDataObjectSimpleAnyType, InternalEDataObject

All Known Implementing Classes:
DynamicEDataObjectImpl, DynamicEStoreEDataObjectImpl, EChangeSummaryImpl, EChangeSummarySettingImpl, EDataObjectAnyTypeImpl, EDataObjectImpl, EDataObjectSimpleAnyTypeImpl, EStoreEDataObjectImpl

public interface DataObject
extends Serializable

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 accesss, 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.

Method Summary
 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, String namespaceURI, 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)
          Returns a new data object contained by this object using the specified property, which must be a containment property.
 DataObject createDataObject(Property property, Type type)
          Returns a new data object contained by this object using the specified property, which must be of containment type.
 DataObject createDataObject(String propertyName)
          Returns a new data object contained by this object using the specified property, which must be a containment property.
 DataObject createDataObject(String propertyName, String namespaceURI, String typeName)
          Returns a new data object contained by this object using the specified property, which must be a containment property.
 void delete()
          Remove this object from its container and unset all its properties.
 Object get(int propertyIndex)
          Returns the value of the property at the specified index in property list of this object's type.
 Object get(Property property)
          Returns the value of the given property of this object.
 Object get(String path)
          Returns the value of a property of either this object or an object reachable from it, as identified by the specified path.
 BigDecimal getBigDecimal(int propertyIndex)
          Returns the value of a BigDecimal property identified by the specified property index.
 BigDecimal getBigDecimal(Property property)
          Returns the value of the specified BigDecimal property.
 BigDecimal getBigDecimal(String path)
          Returns the value of a BigDecimal property identified by the specified path.
 BigInteger getBigInteger(int propertyIndex)
          Returns the value of a BigInteger property identified by the specified property index.
 BigInteger getBigInteger(Property property)
          Returns the value of the specified BigInteger property.
 BigInteger getBigInteger(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(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(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(String path)
          Returns the value of a byte[] property identified by the specified path.
 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(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(Property property)
          Returns the value of the specified DataObject property.
 DataObject getDataObject(String path)
          Returns the value of a DataObject property identified by the specified path.
 Date getDate(int propertyIndex)
          Returns the value of a Date property identified by the specified property index.
 Date getDate(Property property)
          Returns the value of the specified Date property.
 Date getDate(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(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(String path)
          Returns the value of a float property identified by the specified path.
 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(String path)
          Returns the value of a int property identified by the specified path.
 List getList(int propertyIndex)
          Returns the value of a List property identified by the specified property index.
 List getList(Property property)
          Returns the value of the specified List property.
 List getList(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(String path)
          Returns the value of a long property identified by the specified path.
 Sequence getSequence(int propertyIndex)
          Returns the value of a Sequence property identified by the specified property index.
 Sequence getSequence(Property property)
          Returns the value of the specified Sequence property.
 Sequence getSequence(String path)
          Returns the value of a Sequence property identified by the specified path.
 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(String path)
          Returns the value of a short property identified by the specified path.
 String getString(int propertyIndex)
          Returns the value of a String property identified by the specified property index.
 String getString(Property property)
          Returns the value of the specified String property.
 String getString(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(Property property)
          Returns whether the property of the object is considered to be set.
 boolean isSet(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.
 void set(int propertyIndex, 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, Object value)
          Sets the value of the given property of the object to the new value.
 void set(String path, 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, BigDecimal value)
          Sets the value of a BigDecimal property identified by the specified property index, to the specified value.
 void setBigDecimal(Property property, BigDecimal value)
          Sets the value of the specified BigDecimal property, to the specified value.
 void setBigDecimal(String path, BigDecimal value)
          Sets the value of a BigDecimal property identified by the specified path, to the specified value.
 void setBigInteger(int propertyIndex, BigInteger value)
          Sets the value of a BigInteger property identified by the specified property index, to the specified value.
 void setBigInteger(Property property, BigInteger value)
          Sets the value of the specified BigInteger property, to the specified value.
 void setBigInteger(String path, 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(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(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(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(String path, char value)
          Sets the value of a char property identified by the specified path, to the specified value.
 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(String path, DataObject value)
          Sets the value of a DataObject property identified by the specified path, to the specified value.
 void setDate(int propertyIndex, Date value)
          Sets the value of a Date property identified by the specified property index, to the specified value.
 void setDate(Property property, Date value)
          Sets the value of the specified Date property, to the specified value.
 void setDate(String path, 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(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(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(String path, int value)
          Sets the value of a int property identified by the specified path, to the specified value.
 void setList(int propertyIndex, List value)
          Sets the value of a List property identified by the specified property index, to the specified value.
 void setList(Property property, List value)
          Sets the value of the specified List property, to the specified value.
 void setList(String path, 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(String path, long value)
          Sets the value of a long property identified by the specified path, to the specified value.
 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(String path, short value)
          Sets the value of a short property identified by the specified path, to the specified value.
 void setString(int propertyIndex, String value)
          Sets the value of a String property identified by the specified property index, to the specified value.
 void setString(Property property, String value)
          Sets the value of the specified String property, to the specified value.
 void setString(String path, String value)
          Sets the value of a String property identified by the specified path, to the specified value.
 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(String path)
          Unsets a property of either this object or an object reachable from it, as identified by the specified path.
 

Method Detail

 

 

get

public Object get(String path)

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

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

 

 

set

public void set(String path,
                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.

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

 

 

isSet

public boolean isSet(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.

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

 

 

unset

public void unset(String path)

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

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

 

 

getBoolean

public boolean getBoolean(String path)

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

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

 

 

getByte

public byte getByte(String path)

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

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

 

 

getChar

public char getChar(String path)

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

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

 

 

getDouble

public double getDouble(String path)

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

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

 

 

getFloat

public float getFloat(String path)

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

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

 

 

getInt

public int getInt(String path)

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

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

 

 

getLong

public long getLong(String path)

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

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

 

 

getShort

public short getShort(String path)

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

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

 

 

getBytes

public byte[] getBytes(String path)

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

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

 

 

getBigDecimal

public BigDecimal getBigDecimal(String path)

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

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

 

 

getBigInteger

public BigInteger getBigInteger(String path)

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

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

 

 

getDataObject

public DataObject getDataObject(String path)

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

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

 

 

getDate

public Date getDate(String path)

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

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

 

 

getString

public String getString(String path)

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

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

 

 

getList

public List getList(String path)

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

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

 

 

getSequence

public Sequence getSequence(String path)

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

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

 

 

setBoolean

public void setBoolean(String path,
                       boolean value)

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

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

 

 

setByte

public void setByte(String path,
                    byte value)

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

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

 

 

setChar

public void setChar(String path,
                    char value)

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

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

 

 

setDouble

public void setDouble(String path,
                      double value)

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

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

 

 

setFloat

public void setFloat(String path,
                     float value)

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

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

 

 

setInt

public void setInt(String path,
                   int value)

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

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

 

 

setLong

public void setLong(String path,
                    long value)

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

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

 

 

setShort

public void setShort(String path,
                     short value)

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

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

 

 

setBytes

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

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

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

 

 

setBigDecimal

public void setBigDecimal(String path,
                          BigDecimal value)

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

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

 

 

setBigInteger

public void setBigInteger(String path,
                          BigInteger value)

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

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

 

 

setDataObject

public void setDataObject(String path,
                          DataObject value)

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

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

 

 

setDate

public void setDate(String path,
                    Date value)

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

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

 

 

setString

public void setString(String path,
                      String value)

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

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

 

 

setList

public void setList(String path,
                    List value)

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

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

 

 

get

public Object get(int propertyIndex)

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

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

 

 

set

public void set(int propertyIndex,
                Object value)

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

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

 

 

isSet

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

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

 

 

unset

public void unset(int propertyIndex)

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

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

 

 

getBoolean

public boolean getBoolean(int propertyIndex)

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

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

 

 

getByte

public byte getByte(int propertyIndex)

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

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

 

 

getChar

public char getChar(int propertyIndex)

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

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

 

 

getDouble

public double getDouble(int propertyIndex)

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

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

 

 

getFloat

public float getFloat(int propertyIndex)

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

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

 

 

getInt

public int getInt(int propertyIndex)

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

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

 

 

getLong

public long getLong(int propertyIndex)

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

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

 

 

getShort

public short getShort(int propertyIndex)

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

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

 

 

getBytes

public byte[] getBytes(int propertyIndex)

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

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

 

 

getBigDecimal

public BigDecimal getBigDecimal(int propertyIndex)

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

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

 

 

getBigInteger

public BigInteger getBigInteger(int propertyIndex)

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

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

 

 

getDataObject

public DataObject getDataObject(int propertyIndex)

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

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

 

 

getDate

public Date getDate(int propertyIndex)

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

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

 

 

getString

public String getString(int propertyIndex)

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

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

 

 

getList

public List getList(int propertyIndex)

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

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

 

 

getSequence

public Sequence getSequence(int propertyIndex)

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

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

 

 

setBoolean

public void setBoolean(int propertyIndex,
                       boolean value)

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

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

 

 

setByte

public void setByte(int propertyIndex,
                    byte value)

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

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

 

 

setChar

public void setChar(int propertyIndex,
                    char value)

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

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

 

 

setDouble

public void setDouble(int propertyIndex,
                      double value)

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

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

 

 

setFloat

public void setFloat(int propertyIndex,
                     float value)

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

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

 

 

setInt

public void setInt(int propertyIndex,
                   int value)

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

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

 

 

setLong

public void setLong(int propertyIndex,
                    long value)

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

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

 

 

setShort

public void setShort(int propertyIndex,
                     short value)

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

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

 

 

setBytes

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

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

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

 

 

setBigDecimal

public void setBigDecimal(int propertyIndex,
                          BigDecimal value)

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

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

 

 

setBigInteger

public void setBigInteger(int propertyIndex,
                          BigInteger value)

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

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

 

 

setDataObject

public void setDataObject(int propertyIndex,
                          DataObject value)

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

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

 

 

setDate

public void setDate(int propertyIndex,
                    Date value)

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

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

 

 

setString

public void setString(int propertyIndex,
                      String value)

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

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

 

 

setList

public void setList(int propertyIndex,
                    List value)

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

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

 

 

get

public Object get(Property property)

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.

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

 

 

set

public void set(Property property,
                Object value)

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.

Parameters:
property - the property of the value to set.
value - the new value for the property.
See Also:
unset(Property), isSet(Property), get(Property)

 

 

isSet

public boolean isSet(Property property)

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

If the property is many-valued, the value must be an List and the property is considered set if the list is not empty. Otherwise, the value of the property of the object is compared against the property's default value. The property is considered set if it's not the same as the default.

This value can affect serialization, since defaults are typically omitted in a compact serialization.

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

 

 

unset

public void unset(Property property)

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.

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

 

 

getBoolean

public boolean getBoolean(Property property)

Returns the value of the specified boolean property.

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

 

 

getByte

public byte getByte(Property property)

Returns the value of the specified byte property.

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

 

 

getChar

public char getChar(Property property)

Returns the value of the specified char property.

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

 

 

getDouble

public double getDouble(Property property)

Returns the value of the specified double property.

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

 

 

getFloat

public float getFloat(Property property)

Returns the value of the specified float property.

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

 

 

getInt

public int getInt(Property property)

Returns the value of the specified int property.

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

 

 

getLong

public long getLong(Property property)

Returns the value of the specified long property.

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

 

 

getShort

public short getShort(Property property)

Returns the value of the specified short property.

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

 

 

getBytes

public byte[] getBytes(Property property)

Returns the value of the specified byte[] property.

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

 

 

getBigDecimal

public BigDecimal getBigDecimal(Property property)

Returns the value of the specified BigDecimal property.

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

 

 

getBigInteger

public BigInteger getBigInteger(Property property)

Returns the value of the specified BigInteger property.

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

 

 

getDataObject

public DataObject getDataObject(Property property)

Returns the value of the specified DataObject property.

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

 

 

getDate

public Date getDate(Property property)

Returns the value of the specified Date property.

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

 

 

getString

public String getString(Property property)

Returns the value of the specified String property.

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

 

 

getList

public List getList(Property property)

Returns the value of the specified List property.

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

 

 

getSequence

public Sequence getSequence(Property property)

Returns the value of the specified Sequence property.

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

 

 

setBoolean

public void setBoolean(Property property,
                       boolean value)

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

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

 

 

setByte

public void setByte(Property property,
                    byte value)

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

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

 

 

setChar

public void setChar(Property property,
                    char value)

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

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

 

 

setDouble

public void setDouble(Property property,
                      double value)

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

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

 

 

setFloat

public void setFloat(Property property,
                     float value)

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

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

 

 

setInt

public void setInt(Property property,
                   int value)

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

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

 

 

setLong

public void setLong(Property property,
                    long value)

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

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

 

 

setShort

public void setShort(Property property,
                     short value)

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

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

 

 

setBytes

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

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

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

 

 

setBigDecimal

public void setBigDecimal(Property property,
                          BigDecimal value)

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

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

 

 

setBigInteger

public void setBigInteger(Property property,
                          BigInteger value)

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

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

 

 

setDataObject

public void setDataObject(Property property,
                          DataObject value)

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

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

 

 

setDate

public void setDate(Property property,
                    Date value)

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

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

 

 

setString

public void setString(Property property,
                      String value)

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

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

 

 

setList

public void setList(Property property,
                    List value)

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

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

 

 

createDataObject

public DataObject createDataObject(String propertyName)

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.

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

 

 

createDataObject

public DataObject createDataObject(int propertyIndex)

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.

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

 

 

createDataObject

public DataObject createDataObject(Property property)

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.

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

 

 

createDataObject

public DataObject createDataObject(String propertyName,
                                   String namespaceURI,
                                   String typeName)

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.

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:
createDataObject(String), DataGraph.getType(java.lang.String, java.lang.String)

 

 

createDataObject

public DataObject createDataObject(int propertyIndex,
                                   String namespaceURI,
                                   String typeName)

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

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:
createDataObject(int), DataGraph.getType(java.lang.String, java.lang.String)

 

 

createDataObject

public DataObject createDataObject(Property property,
                                   Type type)

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.

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

 

 

delete

public void delete()

Remove this object from its container and unset all its properties.

 

 

getContainer

public DataObject getContainer()

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

Returns:
the containing data object or null.

 

 

getContainmentProperty

public Property getContainmentProperty()

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

Returns:
the property containing this data object.

 

 

getDataGraph

public DataGraph getDataGraph()

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

Returns:
the containing data graph or null.

 

 

getType

public Type getType()

Returns the data object's type.

The type defines the properties available for reflective access.

Returns:
the type.

 

Overview

  		Package   Class  Use  Tree  Deprecated  Index  Help 
Copyright 2001-2004 IBM Corporation and others.
All Rights Reserved.
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES  
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD