EclipseLink1.0 - 20080707 API Reference

org.eclipse.persistence.sdo
Class SDOSequence

java.lang.Object
  extended by org.eclipse.persistence.sdo.SDOSequence
All Implemented Interfaces:
commonj.sdo.Sequence

public class SDOSequence
extends java.lang.Object
implements commonj.sdo.Sequence


Constructor Summary
SDOSequence(SDODataObject dataObject)
           
 
Method Summary
 void add(int index, int propertyIndex, java.lang.Object value)
           
 boolean add(int propertyIndex, java.lang.Object value)
           
 void add(int index, commonj.sdo.Property property, java.lang.Object value)
           
 void add(int index, java.lang.String text)
           
 void add(int index, java.lang.String propertyName, java.lang.Object value)
           
 boolean add(commonj.sdo.Property property, java.lang.Object value)
           
 void add(java.lang.String text)
           
 boolean add(java.lang.String propertyName, java.lang.Object value)
           
 boolean addSettingWithoutModifyingDataObject(int index, commonj.sdo.Property property, java.lang.Object value)
          INTERNAL: Add a setting to the list at the specified index.
 boolean addSettingWithoutModifyingDataObject(commonj.sdo.Property property, java.lang.Object value)
          INTERNAL:
 boolean addSettingWithoutModifyingDataObject(commonj.sdo.Property property, java.lang.Object value, boolean checkAllowed)
          INTERNAL:
 void addText(int index, java.lang.String text)
           
 void addText(java.lang.String text)
           
 void addValueToSettings(Setting setting)
          INTERNAL:
 void afterUnmarshal()
          INTERNAL: Ensure that each Setting in the settings list is also present in the valuesToSettings map
 SDOSequence copy()
           
 SDODataObject getDataObject()
           
 int getIndexForProperty(commonj.sdo.Property property)
          INTERNAL: Convenience method that returns the index of the Setting associated with a given property in the Settings list
 commonj.sdo.Property getProperty(int index)
           
 commonj.sdo.Property getProperty(Setting setting)
           
static Setting getRootSetting(Setting setting)
          INTERNAL: Get the root Setting for a given Setting.
 java.util.List<Setting> getSettings()
           
 java.lang.Object getValue(int index)
           
protected  java.util.Map<org.eclipse.persistence.sdo.SDOSequence.Key,Setting> getValuesToSettings()
           
 void move(int toIndex, int fromIndex)
           
 void remove(int index)
           
 void removeSettingWithoutModifyingDataObject(commonj.sdo.Property property)
          INTERNAL:
 void removeSettingWithoutModifyingDataObject(commonj.sdo.Property property, java.lang.Object value)
          INTERNAL:
 void removeValueToSettings(Setting setting)
          INTERNAL:
 java.lang.Object setValue(int index, java.lang.Object value)
           
 int size()
           
 void updateSettingWithoutModifyingDataObject(commonj.sdo.Property property, java.lang.Object oldValue, java.lang.Object newValue)
          INTERNAL:
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SDOSequence

public SDOSequence(SDODataObject dataObject)
Method Detail

getDataObject

public SDODataObject getDataObject()

getSettings

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

getValuesToSettings

protected java.util.Map<org.eclipse.persistence.sdo.SDOSequence.Key,Setting> getValuesToSettings()

add

public void add(int index,
                int propertyIndex,
                java.lang.Object value)
Specified by:
add in interface commonj.sdo.Sequence

add

public boolean add(int propertyIndex,
                   java.lang.Object value)
Specified by:
add in interface commonj.sdo.Sequence

add

public void add(int index,
                commonj.sdo.Property property,
                java.lang.Object value)
Specified by:
add in interface commonj.sdo.Sequence

add

public void add(int index,
                java.lang.String propertyName,
                java.lang.Object value)
Specified by:
add in interface commonj.sdo.Sequence

add

public void add(int index,
                java.lang.String text)
Specified by:
add in interface commonj.sdo.Sequence

add

public boolean add(commonj.sdo.Property property,
                   java.lang.Object value)
Specified by:
add in interface commonj.sdo.Sequence

add

public boolean add(java.lang.String propertyName,
                   java.lang.Object value)
Specified by:
add in interface commonj.sdo.Sequence

add

public void add(java.lang.String text)
Specified by:
add in interface commonj.sdo.Sequence

addText

public void addText(int index,
                    java.lang.String text)
Specified by:
addText in interface commonj.sdo.Sequence

addText

public void addText(java.lang.String text)
Specified by:
addText in interface commonj.sdo.Sequence

getProperty

public commonj.sdo.Property getProperty(int index)
Specified by:
getProperty in interface commonj.sdo.Sequence

getProperty

public commonj.sdo.Property getProperty(Setting setting)

getValue

public java.lang.Object getValue(int index)
Specified by:
getValue in interface commonj.sdo.Sequence

move

public void move(int toIndex,
                 int fromIndex)
Specified by:
move in interface commonj.sdo.Sequence

remove

public void remove(int index)
Specified by:
remove in interface commonj.sdo.Sequence

addValueToSettings

public void addValueToSettings(Setting setting)
INTERNAL:

Parameters:
setting -

removeValueToSettings

public void removeValueToSettings(Setting setting)
INTERNAL:

Parameters:
setting -

setValue

public java.lang.Object setValue(int index,
                                 java.lang.Object value)
Specified by:
setValue in interface commonj.sdo.Sequence

size

public int size()
Specified by:
size in interface commonj.sdo.Sequence

copy

public SDOSequence copy()

addSettingWithoutModifyingDataObject

public boolean addSettingWithoutModifyingDataObject(int index,
                                                    commonj.sdo.Property property,
                                                    java.lang.Object value)
INTERNAL: Add a setting to the list at the specified index. The owning DataObject will not be made aware of this addition.

Parameters:
index - the index at which to add the new Setting in the Settings list
property -
value -
Returns:
true if the a Setting was successfully added to the list, otherwise false

addSettingWithoutModifyingDataObject

public boolean addSettingWithoutModifyingDataObject(commonj.sdo.Property property,
                                                    java.lang.Object value)
INTERNAL:


addSettingWithoutModifyingDataObject

public boolean addSettingWithoutModifyingDataObject(commonj.sdo.Property property,
                                                    java.lang.Object value,
                                                    boolean checkAllowed)
INTERNAL:


updateSettingWithoutModifyingDataObject

public void updateSettingWithoutModifyingDataObject(commonj.sdo.Property property,
                                                    java.lang.Object oldValue,
                                                    java.lang.Object newValue)
INTERNAL:


removeSettingWithoutModifyingDataObject

public void removeSettingWithoutModifyingDataObject(commonj.sdo.Property property,
                                                    java.lang.Object value)
INTERNAL:


removeSettingWithoutModifyingDataObject

public void removeSettingWithoutModifyingDataObject(commonj.sdo.Property property)
INTERNAL:


getIndexForProperty

public int getIndexForProperty(commonj.sdo.Property property)
INTERNAL: Convenience method that returns the index of the Setting associated with a given property in the Settings list

Parameters:
property -
Returns:
index of the Setting associated with a given property in the Settings list or -1 if not found

getRootSetting

public static Setting getRootSetting(Setting setting)
INTERNAL: Get the root Setting for a given Setting.

Parameters:
setting -
Returns:
the root Setting or this Setting if it is a root

afterUnmarshal

public void afterUnmarshal()
INTERNAL: Ensure that each Setting in the settings list is also present in the valuesToSettings map


EclipseLink1.0 - 20080707 API Reference