Package org.eclipse.persistence.sdo

Class SDODataObject

    • Constructor Summary

      Constructors 
      Constructor Description
      SDODataObject()
      INTERNAL: Private constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      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.
      Note: Implementers of the ValueStore interface require this accessor.
      List _getOpenContentProperties()
      INTERNAL: Returns a list of the Properties currently used in this DataObject which are not included in getType().getProperties
      List _getOpenContentPropertiesAttributes()  
      Map _getOpenContentPropertiesAttributesMap()  
      List _getOpenContentPropertiesWithXMLRoots()
      INTERNAL: This function is implemented by SDOType.setOpen() in a mapping setGet/SetMethodName call
      String _getPath()
      INTERNAL: Return an SDO Path string from root of the caller to itself
      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​(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​(List openContentPropertiesAttributes)  
      void _setOpenContentPropertiesAttributesMap​(Map openAttributeProperties)  
      void _setOpenContentPropertiesWithXMLRoots​(List openContentPropertiesWithXMLRoots)
      INTERNAL: This function is implemented by SDOType.setOpen() in a mapping setGet/SetMethodName call
      void _setSdoRef​(String newRef)  
      void _setType​(Type aType)
      INTERNAL:
      void addOpenContentProperty​(Property property)
      INTERNAL: Add the open content property into all 3 data structures.
      Object convertObjectToValue​(Property property, int position, Class cls)
      INTERNAL:
      Object convertObjectToValue​(Property property, 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, String namespaceURI, 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​(String propertyName)
      Returns a new data object contained by this object using the specified property, which must be a containment property.
      SDODataObject 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.
      Property defineOpenContentProperty​(String name, Object value)
      INTERNAL: Create a dynamic open content property if no property exists for (name).
      Property defineOpenContentProperty​(String name, 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.
      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.
      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​(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​(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.
      List getInstanceProperties()
      Returns a read-only List of the Properties currently used in this DataObject.
      SDOProperty getInstanceProperty​(int propertyIndex)
      INTERNAL:
      SDOProperty getInstanceProperty​(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​(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.
      SDOProperty getProperty​(String propertyName)  
      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​(String path)
      Deprecated.
      in SDO 2.1.0.
      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​(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.
      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​(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​(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, 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 set​(SDOProperty property, Object value, boolean updateSequence)
      INTERNAL: Sets the value of the given property of the object to the new 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 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​(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 setInternal​(SDOProperty property, Object value, boolean updateSequence)  
      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 setPropertyInternal​(SDOProperty property, 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​(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 undoChanges​(boolean isCSRoot, ChangeSummary cs, SDODataObject origContainer, 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​(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, Collection values)
      INTERNAL: Update containment on the specified collection of values and default to true = update the sequence
      void updateContainment​(Property property, 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
      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.

    • Method Detail

      • _setHelperContext

        public void _setHelperContext​(HelperContext aContext)
        INTERNAL: Set the HelperContext that will be associated with this DataObject.
        Parameters:
        aContext -

      • get

        public Object get​(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)

      • isSet

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

      • getByte

        public byte getByte​(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​(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​(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​(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​(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​(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​(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​(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 BigDecimal getBigDecimal​(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 BigInteger getBigInteger​(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)

      • getDate

        public Date getDate​(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 String getString​(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 List getList​(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​(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​(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​(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​(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​(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​(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​(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​(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​(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​(String path,
                          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​(String path,
                          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​(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​(String path,
                    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​(String path,
                      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)

      • set

        public void set​(int propertyIndex,
                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)

      • 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)

      • getList

        public 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 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,
                          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,
                          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,
                    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,
                      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)

      • 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,
                  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 -

      • getDate

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

      • setDate

        public void setDate​(Property property,
                    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)

      • setList

        public void setList​(Property property,
                    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 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

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

      • getInstanceProperty

        public SDOProperty getInstanceProperty​(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.

      • 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,
                        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:
        aValueStore -

      • _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 Map _getOpenContentPropertiesAttributesMap()

      • _setOpenContentPropertiesAttributesMap

        public void _setOpenContentPropertiesAttributesMap​(Map openAttributeProperties)

      • _setOpenContentPropertiesWithXMLRoots

        public void _setOpenContentPropertiesWithXMLRoots​(List openContentPropertiesWithXMLRoots)
        INTERNAL: This function is implemented by SDOType.setOpen() in a mapping setGet/SetMethodName call
        Parameters:
        openContentPropertiesWithXMLRoots -

      • _getOpenContentPropertiesWithXMLRoots

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

      • _getOpenContentProperties

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

      • _setContainmentPropertyName

        public void _setContainmentPropertyName​(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 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​(Object value)
        INTERNAL:
        Parameters:
        value -
        Returns:

      • updateContainment

        public void updateContainment​(Property property,
                              Collection values,
                              boolean updateSequence)
        INTERNAL: Update containment with flagged update sequence state
        Parameters:
        property -
        values -
        updateSequence -

      • updateContainment

        public void updateContainment​(Property property,
                              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 -
        aDataObject -
        updateSequence -

      • updateContainment

        public void updateContainment​(Property property,
                              SDODataObject value)
        INTERNAL: update containment and the update the sequence value by default.
        Parameters:
        property -
        value -

      • writeReplace

        public 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 String _getPath()
        INTERNAL: Return an SDO Path string from root of the caller to itself
        Returns:
        String

      • getPropertyInternal

        public Object getPropertyInternal​(Property property)
        INTERNAL: Get the value of the property (open-content or declared)..
        Parameters:
        property -
        Returns:

      • setPropertyInternal

        public void setPropertyInternal​(SDOProperty property,
                                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 String _getSdoRef()
        INTERNAL: Return the sdoref attribute value during unmarshaling
        Returns:

      • _setOpenContentPropertiesAttributes

        public void _setOpenContentPropertiesAttributes​(List openContentPropertiesAttributes)

      • _getOpenContentPropertiesAttributes

        public List _getOpenContentPropertiesAttributes()

      • _setSdoRef

        public void _setSdoRef​(String newRef)