Module org.eclipse.persistence.sdo

Package org.eclipse.persistence.sdo

Class SDOSequence

java.lang.Object

org.eclipse.persistence.sdo.SDOSequence

All Implemented Interfaces:

Sequence

public class SDOSequence
extends Object
implements Sequence

Constructor Summary

Constructors

Constructor	Description
SDOSequence(SDODataObject dataObject)

Method Summary

Modifier and Type	Method	Description
void	add(int index, int propertyIndex, Object value)	Adds a new entry with the specified property index and value at the specified entry index.
void	add(int index, Property property, Object value)	Adds a new entry with the specified property and value at the specified entry index.
boolean	add(int propertyIndex, Object value)	Adds a new entry with the specified property index and value to the end of the entries.
void	add(int index, String text)
void	add(int index, String propertyName, Object value)	Adds a new entry with the specified property name and value at the specified entry index.
boolean	add(Property property, Object value)	Adds a new entry with the specified property and value to the end of the entries.
void	add(String text)
boolean	add(String propertyName, Object value)	Adds a new entry with the specified property name and value to the end of the entries.
boolean	addSettingWithoutModifyingDataObject(int index, Property property, Object value)	INTERNAL: Add a setting to the list at the specified index.
boolean	addSettingWithoutModifyingDataObject(Property property, Object value)	INTERNAL:
boolean	addSettingWithoutModifyingDataObject(Property property, Object value, boolean checkAllowed)	INTERNAL:
void	addText(int index, String text)	Adds a new text entry at the given index.
void	addText(String text)	Adds a new text entry to the end of the Sequence.
void	addValueToSettings(org.eclipse.persistence.oxm.sequenced.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(Property property)	INTERNAL: Convenience method that returns the index of the Setting associated with a given property in the Settings list
SDOProperty	getProperty(int index)	Returns the property for the given entry index.
SDOProperty	getProperty(org.eclipse.persistence.oxm.sequenced.Setting setting)
static org.eclipse.persistence.oxm.sequenced.Setting	getRootSetting(org.eclipse.persistence.oxm.sequenced.Setting setting)	INTERNAL: Get the root Setting for a given Setting.
List<org.eclipse.persistence.oxm.sequenced.Setting>	getSettings()
Object	getValue(int index)	Returns the property value for the given entry index.
void	move(int toIndex, int fromIndex)	Moves the entry at fromIndex to toIndex.
void	remove(int index)	Removes the entry at the given entry index.
void	removeSettingWithoutModifyingDataObject(Property property)	INTERNAL:
void	removeSettingWithoutModifyingDataObject(Property property, Object value)	INTERNAL:
void	removeValueToSettings(org.eclipse.persistence.oxm.sequenced.Setting setting)	INTERNAL:
Object	setValue(int index, Object value)	Sets the entry at a specified index to the new value.
int	size()	Returns the number of entries in the sequence.
void	updateSettingWithoutModifyingDataObject(Property property, Object oldValue, 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 List<org.eclipse.persistence.oxm.sequenced.Setting> getSettings()

add

public void add(int index,
                int propertyIndex,
                Object value)

Description copied from interface: Sequence

Adds a new entry with the specified property index and value at the specified entry index.

Specified by:

add in interface Sequence

Parameters:

index - the index at which to add the entry.

propertyIndex - the index of the entry's property.

value - the value for the entry.

add

public boolean add(int propertyIndex,
                   Object value)

Description copied from interface: Sequence

Adds a new entry with the specified property index and value to the end of the entries.

Specified by:

add in interface Sequence

Parameters:

propertyIndex - the index of the entry's property.

value - the value for the entry.

add

public void add(int index,
                Property property,
                Object value)

Description copied from interface: Sequence

Adds a new entry with the specified property and value at the specified entry index.

Specified by:

add in interface Sequence

Parameters:

index - the index at which to add the entry.

property - the property of the entry.

value - the value for the entry.

add

public void add(int index,
                String propertyName,
                Object value)

Description copied from interface: Sequence

Adds a new entry with the specified property name and value at the specified entry index.

Specified by:

add in interface Sequence

Parameters:

index - the index at which to add the entry.

propertyName - the name of the entry's property.

value - the value for the entry.

add

public void add(int index,
                String text)

Specified by:

add in interface Sequence

add

public boolean add(Property property,
                   Object value)

Description copied from interface: Sequence

Adds a new entry with the specified property and value to the end of the entries.

Specified by:

add in interface Sequence

Parameters:

property - the property of the entry.

value - the value for the entry.

add

public boolean add(String propertyName,
                   Object value)

Description copied from interface: Sequence

Adds a new entry with the specified property name and value to the end of the entries.

Specified by:

add in interface Sequence

Parameters:

propertyName - the name of the entry's property.

value - the value for the entry.

add

public void add(String text)

Specified by:

add in interface Sequence

addText

public void addText(int index,
                    String text)

Description copied from interface: Sequence

Adds a new text entry at the given index.

Specified by:

addText in interface Sequence

Parameters:

index - the index at which to add the entry.

text - value of the entry.

addText

public void addText(String text)

Description copied from interface: Sequence

Adds a new text entry to the end of the Sequence.

Specified by:

addText in interface Sequence

Parameters:

text - value of the entry.

getProperty

public SDOProperty getProperty(int index)

Description copied from interface: Sequence

Returns the property for the given entry index. Returns null for mixed text entries.

Specified by:

getProperty in interface Sequence

Parameters:

index - the index of the entry.

Returns:

the property or null for the given entry index.

getProperty

public SDOProperty getProperty(org.eclipse.persistence.oxm.sequenced.Setting setting)

getValue

public Object getValue(int index)

Description copied from interface: Sequence

Returns the property value for the given entry index.

Specified by:

getValue in interface Sequence

Parameters:

index - the index of the entry.

Returns:

the value for the given entry index.

move

public void move(int toIndex,
                 int fromIndex)

Description copied from interface: Sequence

Moves the entry at fromIndex to toIndex.

Specified by:

move in interface Sequence

Parameters:

toIndex - the index of the entry destination.

fromIndex - the index of the entry to move.

remove

public void remove(int index)

Description copied from interface: Sequence

Removes the entry at the given entry index.

Specified by:

remove in interface Sequence

Parameters:

index - the index of the entry.

addValueToSettings

public void addValueToSettings(org.eclipse.persistence.oxm.sequenced.Setting setting)

INTERNAL:

Parameters:

setting -

removeValueToSettings

public void removeValueToSettings(org.eclipse.persistence.oxm.sequenced.Setting setting)

INTERNAL:

Parameters:

setting -

setValue

public Object setValue(int index,
                       Object value)

Description copied from interface: Sequence

Sets the entry at a specified index to the new value.

Specified by:

setValue in interface Sequence

Parameters:

index - the index of the entry.

value - the new value for the entry.

size

public int size()

Description copied from interface: Sequence

Returns the number of entries in the sequence.

Specified by:

size in interface Sequence

Returns:

the number of entries.

copy

public SDOSequence copy()

addSettingWithoutModifyingDataObject

public boolean addSettingWithoutModifyingDataObject(int index,
                                                    Property property,
                                                    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(Property property,
                                                    Object value)

INTERNAL:

addSettingWithoutModifyingDataObject

public boolean addSettingWithoutModifyingDataObject(Property property,
                                                    Object value,
                                                    boolean checkAllowed)

INTERNAL:

updateSettingWithoutModifyingDataObject

public void updateSettingWithoutModifyingDataObject(Property property,
                                                    Object oldValue,
                                                    Object newValue)

INTERNAL:

removeSettingWithoutModifyingDataObject

public void removeSettingWithoutModifyingDataObject(Property property,
                                                    Object value)

INTERNAL:

removeSettingWithoutModifyingDataObject

public void removeSettingWithoutModifyingDataObject(Property property)

INTERNAL:

getIndexForProperty

public int getIndexForProperty(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 org.eclipse.persistence.oxm.sequenced.Setting getRootSetting(org.eclipse.persistence.oxm.sequenced.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