oracle.rules.sdk2.dictionary

Class IDTable<T extends DictionaryComponent>

java.lang.Object

oracle.rules.sdk2.dictionary.DictionaryObject

oracle.rules.sdk2.dictionary.IDTable<T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>

public class IDTable<T extends DictionaryComponent>
extends DictionaryObject
implements java.util.List<T>

An ID table is a List of DictionaryComponent IDs that provides a List<DictionaryComponent> interface similar to DictionaryComponentTable but does not contain the DictionaryComponents.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IDTable(DictionaryObject parent)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, T element) Inserts the specified element at the specified position in this list (optional operation).
boolean	add(T o) Appends the specified element to the end of this list (optional operation).
boolean	addAll(java.util.Collection<? extends T> c) Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation).
boolean	addAll(int index, java.util.Collection<? extends T> c) Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
void	clear() Removes all of the elements from this list (optional operation).
boolean	contains(java.lang.Object o) Returns true if this list contains the specified element.
boolean	containsAll(java.util.Collection<?> c) Returns true if this list contains all of the elements of the specified collection.
T	get(int index) Returns the element at the specified position in this list.
java.util.List<DOID>	getAEReferences() Get DOIDs referenced by this Object and descendants.
java.util.List<DOID>	getAllReferences() Get all DOIDs referenced by this Object and descendants.
T	getByAlias(java.lang.String alias) Get a DictionaryComponent from this table by its alias.
T	getByID(DOID id) Get a DictionaryComponent from this table by its ID.
T	getByName(java.lang.String name) Get a DictionaryComponent from this table by its name.
java.util.List<DOID>	getReferences() Get all DOIDs referenced by this Component and IDTable properties, but does not include contained dictionary components.
int	indexOf(java.lang.Object o) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
boolean	isEmpty() Returns true if this list contains no elements.
java.util.Iterator<T>	iterator() Returns an iterator over the elements in this list in proper sequence.
int	lastIndexOf(java.lang.Object o) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
java.util.ListIterator<T>	listIterator() Not Supported
java.util.ListIterator<T>	listIterator(int index) Not Supported
T	remove(int index) Removes the element at the specified position in this list (optional operation).
boolean	remove(java.lang.Object o) Removes the first occurrence of the specified element from this list, if it is present (optional operation).
boolean	removeAll(java.util.Collection<?> c) Removes from this list all of its elements that are contained in the specified collection (optional operation).
T	removeByAlias(java.lang.String alias) Remove the DictionaryComponent with the given alias from the table
T	removeByID(DOID id) Remove the DictionaryComponent with the given id from the table
T	removeByName(java.lang.String name) Remove the DictionaryComponent with the given name from the table
int	removeNulls() TODO - Ganesh Commented out as this requires further changes in DimensionNode Bump change count when the ID Table is modified to invalidate caches
boolean	retainAll(java.util.Collection<?> c) Retains only the elements in this list that are contained in the specified collection (optional operation).
T	set(int index, T element) Replaces the element at the specified position in this list with the specified element (optional operation).
int	size() Returns the number of elements in this list.
java.util.List<T>	subList(int fromIndex, int toIndex) Not Supported
java.lang.Object[]	toArray() Returns an array containing all of the elements in this list in proper sequence (from first to last element).
<U> U[]	toArray(U[] a) Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.
void	validate(java.util.List<SDKException> errors, java.util.List<SDKWarning> warnings) Validate the entire dictionary object and its decendants.
void	validate(java.util.List<SDKException> errors, java.util.List<SDKWarning> warnings, int modelChangeLowerBound, int ruleChangeLowerBound) Validate does nothing

Methods inherited from class oracle.rules.sdk2.dictionary.DictionaryObject

equals, exists, getCombinedDataModel, getContainedIDs, getContainedIDs, getDataModel, getDictionary, getID, getObjectPath, getObjectType, getParentByClass, getParentComponent, getParentComponentTable, getParentObject, getRuleSet, getState, getWarnings, hashCode, isModified, validate

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List

equals, hashCode

Constructor Detail

IDTable

public IDTable(DictionaryObject parent)

Method Detail

getByName

public T getByName(java.lang.String name)

Get a DictionaryComponent from this table by its name.

Parameters:

name - name of component

Returns:

the component

getByID

public T getByID(DOID id)

Get a DictionaryComponent from this table by its ID.

Parameters:

id - ID of component

Returns:

the component

getByAlias

public T getByAlias(java.lang.String alias)

Get a DictionaryComponent from this table by its alias.

Parameters:

alias - alias of component

Returns:

the component

removeByID

public T removeByID(DOID id)
                                         throws DeleteException

Remove the DictionaryComponent with the given id from the table

Parameters:

id - the id returned by DictionaryComponent.getId()

Throws:

DeleteException

removeByName

public T removeByName(java.lang.String name)
                                           throws DeleteException

Remove the DictionaryComponent with the given name from the table

Parameters:

name - the name returned by DictionaryComponent.getName()

Throws:

DeleteException

removeByAlias

public T removeByAlias(java.lang.String alias)
                                            throws DeleteException

Remove the DictionaryComponent with the given alias from the table

Parameters:

alias - the alias returned by DictionaryComponent.getAlias()

Throws:

DeleteException

validate

public void validate(java.util.List<SDKException> errors,
            java.util.List<SDKWarning> warnings,
            int modelChangeLowerBound,
            int ruleChangeLowerBound)

Validate does nothing

Overrides:

validate in class DictionaryObject

Parameters:

errors - validation errors

warnings - validation warnings

modelChangeLowerBound - smallest ModelComponent.CreationUpdateNumber modified in thix tx.

ruleChangeLowerBound - smallest RuleComponent.CreationUpdateNumber modified in thix tx. Rulesets and rules with UpdateNumber >= modelChangeLowerBound will be revalidated. a value of 0 will force revalidation of all rulesets. A value of Integer.MAX_VALUE will skip validation of all rulesets.

validate

public void validate(java.util.List<SDKException> errors,
            java.util.List<SDKWarning> warnings)

Description copied from class: DictionaryObject

Validate the entire dictionary object and its decendants. Not incremental.

Specified by:

validate in class DictionaryObject

Parameters:

errors - a List of error exceptions to append to.

warnings - a List of warning exceptions to append to.

See Also:

DictionaryObject.validate(List,List,int,int)

size

public int size()

Description copied from interface: java.util.List

Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface java.util.Collection<T extends DictionaryComponent>

Specified by:

size in interface java.util.List<T extends DictionaryComponent>

Returns:

the number of elements in this list

isEmpty

public boolean isEmpty()

Description copied from interface: java.util.List

Returns true if this list contains no elements.

Specified by:

isEmpty in interface java.util.Collection<T extends DictionaryComponent>

Specified by:

isEmpty in interface java.util.List<T extends DictionaryComponent>

Returns:

true if this list contains no elements

contains

public boolean contains(java.lang.Object o)

Description copied from interface: java.util.List

Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface java.util.Collection<T extends DictionaryComponent>

Specified by:

contains in interface java.util.List<T extends DictionaryComponent>

Parameters:

o - element whose presence in this list is to be tested

Returns:

true if this list contains the specified element

iterator

public java.util.Iterator<T> iterator()

Description copied from interface: java.util.List

Returns an iterator over the elements in this list in proper sequence.

Specified by:

iterator in interface java.lang.Iterable<T extends DictionaryComponent>

Specified by:

iterator in interface java.util.Collection<T extends DictionaryComponent>

Specified by:

iterator in interface java.util.List<T extends DictionaryComponent>

Returns:

an iterator over the elements in this list in proper sequence

toArray

public java.lang.Object[] toArray()

Description copied from interface: java.util.List

Returns an array containing all of the elements in this list in proper sequence (from first to last element).

The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array even if this list is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Specified by:

toArray in interface java.util.Collection<T extends DictionaryComponent>

Specified by:

toArray in interface java.util.List<T extends DictionaryComponent>

Returns:

an array containing all of the elements in this list in proper sequence

See Also:

Arrays.asList(Object[])

toArray

public <U> U[] toArray(U[] a)

Description copied from interface: java.util.List

Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the list fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this list.

If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the list is set to null. (This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements.)

Like the List.toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a list known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:

     String[] y = x.toArray(new String[0]);

Note that toArray(new Object[0]) is identical in function to toArray().

Specified by:

toArray in interface java.util.Collection<T extends DictionaryComponent>

Specified by:

toArray in interface java.util.List<T extends DictionaryComponent>

Parameters:

a - the array into which the elements of this list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing the elements of this list

add

public boolean add(T o)

Description copied from interface: java.util.List

Appends the specified element to the end of this list (optional operation).

Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added.

Specified by:

add in interface java.util.Collection<T extends DictionaryComponent>

Specified by:

add in interface java.util.List<T extends DictionaryComponent>

Parameters:

o - element to be appended to this list

Returns:

true (as specified by Collection.add(E))

remove

public boolean remove(java.lang.Object o)

Description copied from interface: java.util.List

Removes the first occurrence of the specified element from this list, if it is present (optional operation). If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))) (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).

Specified by:

remove in interface java.util.Collection<T extends DictionaryComponent>

Specified by:

remove in interface java.util.List<T extends DictionaryComponent>

Parameters:

o - element to be removed from this list, if present

Returns:

true if this list contained the specified element

containsAll

public boolean containsAll(java.util.Collection<?> c)

Description copied from interface: java.util.List

Returns true if this list contains all of the elements of the specified collection.

Specified by:

containsAll in interface java.util.Collection<T extends DictionaryComponent>

Specified by:

containsAll in interface java.util.List<T extends DictionaryComponent>

Parameters:

c - collection to be checked for containment in this list

Returns:

true if this list contains all of the elements of the specified collection

See Also:

List.contains(Object)

addAll

public boolean addAll(java.util.Collection<? extends T> c)

Description copied from interface: java.util.List

Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Specified by:

addAll in interface java.util.Collection<T extends DictionaryComponent>

Specified by:

addAll in interface java.util.List<T extends DictionaryComponent>

Parameters:

c - collection containing elements to be added to this list

Returns:

true if this list changed as a result of the call

See Also:

List.add(Object)

addAll

public boolean addAll(int index,
             java.util.Collection<? extends T> c)

Description copied from interface: java.util.List

Inserts all of the elements in the specified collection into this list at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Specified by:

addAll in interface java.util.List<T extends DictionaryComponent>

Parameters:

index - index at which to insert the first element from the specified collection

c - collection containing elements to be added to this list

Returns:

true if this list changed as a result of the call

removeAll

public boolean removeAll(java.util.Collection<?> c)

Description copied from interface: java.util.List

Removes from this list all of its elements that are contained in the specified collection (optional operation).

Specified by:

removeAll in interface java.util.Collection<T extends DictionaryComponent>

Specified by:

removeAll in interface java.util.List<T extends DictionaryComponent>

Parameters:

c - collection containing elements to be removed from this list

Returns:

true if this list changed as a result of the call

See Also:

List.remove(Object), List.contains(Object)

retainAll

public boolean retainAll(java.util.Collection<?> c)

Description copied from interface: java.util.List

Retains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all of its elements that are not contained in the specified collection.

Specified by:

retainAll in interface java.util.Collection<T extends DictionaryComponent>

Specified by:

retainAll in interface java.util.List<T extends DictionaryComponent>

Parameters:

c - collection containing elements to be retained in this list

Returns:

true if this list changed as a result of the call

See Also:

List.remove(Object), List.contains(Object)

clear

public void clear()

Description copied from interface: java.util.List

Removes all of the elements from this list (optional operation). The list will be empty after this call returns.

Specified by:

clear in interface java.util.Collection<T extends DictionaryComponent>

Specified by:

clear in interface java.util.List<T extends DictionaryComponent>

get

public T get(int index)

Description copied from interface: java.util.List

Returns the element at the specified position in this list.

Specified by:

get in interface java.util.List<T extends DictionaryComponent>

Parameters:

index - index of the element to return

Returns:

the element at the specified position in this list

set

public T set(int index,
    T element)

Description copied from interface: java.util.List

Replaces the element at the specified position in this list with the specified element (optional operation).

Specified by:

set in interface java.util.List<T extends DictionaryComponent>

Parameters:

index - index of the element to replace

element - element to be stored at the specified position

Returns:

the element previously at the specified position

add

public void add(int index,
       T element)

Description copied from interface: java.util.List

Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Specified by:

add in interface java.util.List<T extends DictionaryComponent>

Parameters:

index - index at which the specified element is to be inserted

element - element to be inserted

remove

public T remove(int index)

Description copied from interface: java.util.List

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

Specified by:

remove in interface java.util.List<T extends DictionaryComponent>

Parameters:

index - the index of the element to be removed

Returns:

the element previously at the specified position

indexOf

public int indexOf(java.lang.Object o)

Description copied from interface: java.util.List

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:

indexOf in interface java.util.List<T extends DictionaryComponent>

Parameters:

o - element to search for

Returns:

the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Description copied from interface: java.util.List

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:

lastIndexOf in interface java.util.List<T extends DictionaryComponent>

Parameters:

o - element to search for

Returns:

the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element

listIterator

public java.util.ListIterator<T> listIterator()

Not Supported

Specified by:

listIterator in interface java.util.List<T extends DictionaryComponent>

Returns:

a list iterator over the elements in this list (in proper sequence)

Throws:

java.lang.UnsupportedOperationException

listIterator

public java.util.ListIterator<T> listIterator(int index)

Not Supported

Specified by:

listIterator in interface java.util.List<T extends DictionaryComponent>

Parameters:

index - index of the first element to be returned from the list iterator (by a call to next)

Returns:

a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list

Throws:

java.lang.UnsupportedOperationException

subList

public java.util.List<T> subList(int fromIndex,
                        int toIndex)

Not Supported

Specified by:

subList in interface java.util.List<T extends DictionaryComponent>

Parameters:

fromIndex - low endpoint (inclusive) of the subList

toIndex - high endpoint (exclusive) of the subList

Returns:

a view of the specified range within this list

Throws:

java.lang.UnsupportedOperationException

getReferences

public java.util.List<DOID> getReferences()

Description copied from class: DictionaryObject

Get all DOIDs referenced by this Component and IDTable properties, but does not include contained dictionary components.

Overrides:

getReferences in class DictionaryObject

Returns:

list of the DOIDs

getAEReferences

public java.util.List<DOID> getAEReferences()

Description copied from class: DictionaryObject

Get DOIDs referenced by this Object and descendants. By convention, properties of type DOID and DOID[] are not considered. This basically makes this useful for finding DOIDs referenced in IDTables and in Expressions and Actions. Note that a parent contains its children but (usually) does not reference them.

Specified by:

getAEReferences in class DictionaryObject

Returns:

list of the DOIDs

getAllReferences

public java.util.List<DOID> getAllReferences()

Description copied from class: DictionaryObject

Get all DOIDs referenced by this Object and descendants.

Specified by:

getAllReferences in class DictionaryObject

Returns:

list of the DOIDs

removeNulls

public int removeNulls()

TODO - Ganesh Commented out as this requires further changes in DimensionNode Bump change count when the ID Table is modified to invalidate caches