oracle.rules.sdk2.dictionary

Class DictionaryComponentTable<T extends DictionaryComponent>

java.lang.Object

oracle.rules.sdk2.dictionary.DictionaryObject

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DictionaryLinkTable, ModelComponentTable, RuleComponentTable

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

A dictionary component table is a List of DictionaryComponents.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SORT
static java.lang.String	SORT_ASCEND
static java.lang.String	SORT_DECEND

Method Summary

Methods

Modifier and Type	Method and Description
T	add() Add a new element to the table and return the new element.
abstract T	add(int index) Add a new element to the table at the specified location and return the new element Must be abstract because generics cannot do "new T"
boolean	add(T o) Used internally by subclasses.
void	clear() remove all elements in the table
boolean	contains(java.lang.Object o) return if the the table contains the object
boolean	containsAll(java.util.Collection<?> c) returns true if the table contains all of the components in the Collection argument
T	copyTo(int index, T from)
void	cut(T dc) Cut (remove) the given component from this table.
java.util.List<T>	filter(java.lang.String filterPattern, boolean translate) Get the Dictionary Components in this table that match the given pattern
T	get(int index) retrieve the ith element from the table
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	getByAlias(java.lang.String alias, boolean translate) Get a DictionaryComponent from this table by its (translated) 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.
T	getLast() Get the last entry in the table
DictionaryComponent[]	getMarked() see DictionaryComponentTable.mark(int[])
T	getProtoType() The following prototype related operations do not bump the change count of the dictionary: 1.
int	indexOf(java.lang.Object o) get the index of the Object argument
boolean	isEmpty() return if the table is empty
boolean	isLocked() Whether the table is locked (is readonly)
java.util.Iterator<T>	iterator() Returns an iterator over the elements in this list in proper sequence.
java.util.ListIterator<T>	listIterator() Returns a list iterator over the elements in this list (in proper sequence).
java.util.ListIterator<T>	listIterator(int index) Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
void	mark(int[] index) Mark the rows with the given indexes
T	move(int index, boolean up) Shift the entry defined by index either up or down one entry in the table.
void	move(int fromIndex, int toIndex, boolean replace) Move the DictionaryComponent with the given id from its current location to the location of the second id.
static java.util.List<java.lang.Integer>	ordering(java.util.List<? extends DictionaryComponent> list)
T	paste(T dc) Paste a cut or existing component at the end of this table
T	remove(int index) Remove the DictionaryComponent at the given index from the table
boolean	remove(java.lang.Object o) remove the DictionaryComponent from this table
boolean	removeAll(java.util.Collection<?> c) remove all of the elements in the Collection from this table
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	removeMarked()
void	reorder(java.util.List<java.lang.Integer> ordering) reorder this table according to a list of indexes.
T	set(int index, T element) Used internally by subclasses.
int	size() return the size of the table
static void	sort(java.util.List<? extends DictionaryComponent> list, java.lang.String prop, boolean ascending) Sorts the components in the given list by the property and sort order specified
void	sort(java.lang.String prop)
void	sort(java.lang.String prop, boolean ascending)
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	unMark() Clear marks.
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 each DictionaryObject in the table.

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

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

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List

add, addAll, addAll, equals, hashCode, lastIndexOf, retainAll

Field Detail

SORT_ASCEND

public static final java.lang.String SORT_ASCEND

See Also:

Constant Field Values

SORT_DECEND

public static final java.lang.String SORT_DECEND

See Also:

Constant Field Values

SORT

public static final java.lang.String SORT

See Also:

Constant Field Values

Method Detail

getProtoType

public T getProtoType()

The following prototype related operations do not bump the change count of the dictionary: 1. Getting a prototype from a DictionaryComponentTable. This could be either through getProtoType() or by explicit calls to initProtoType() followed by removeProtoType(). There is an explicit check in initProtoType() to prevent an increment to the change count. There is NO check while removing a prototype since it does not have an effect anyway. We expect this behavior to be retained for proper functioning of Verbal Rules. 2. Operations performed on components marked as a prototype. This is accomplished by a check for isPrototype() in DictionaryObject._makeUpdateable(). 3. Operations on parents tables originating from children marked as a prototype. Currently, these include the following: a. Addition of a fact binding in the parent because an expression is set on a prototype SimpleTest b. Deletion of unreferenced auto patterns in a STT via an explicit call to protoTypeST.getParentComponentTable()).deleteUnreferencedAutoPatternsForPrototype(); This is accomplished by opening a window for a prototype operation on the table and closing it after the operation is complete. These windows are currently used in: a. DictionaryComponentTable.initProtoType() b. SimpleTestTable.addPun(...) c. SimpleTestTable.deleteUnreferencedAutoPatternsForPrototype() 4. DictionaryObject constructor checks if parent is a prototype. if so, sets the current object as prototype. 5. Assume that a prototype object cannot be converted to a non-prototype object and vice versa.

Returns:

a prototype dictionary component to use for getting Choices and Options for the component's properties

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,
           boolean translate)

Get a DictionaryComponent from this table by its (translated) alias.

Parameters:

alias - alias of component

translate - flag

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

Returns:

the removed component

Throws:

DeleteException - if the component cannot be removed (e.g. a Java Method)

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 each DictionaryObject in the table.

Overrides:

validate in class DictionaryObject

Parameters:

errors - validation errors

warnings - validation warnings

modelChangeLowerBound - determines what needs to be re-validated based on changes to the dictionary

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

return the size of the table

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

return if the table is empty

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)

return if the the table contains the object

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

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

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

listIterator

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

Description copied from interface: java.util.List

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

Specified by:

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

Returns:

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

listIterator

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

Description copied from interface: java.util.List

Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list. The specified index indicates the first element that would be returned by an initial call to next. An initial call to previous would return the element with the specified index minus one.

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

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)

Used internally by subclasses.

Specified by:

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

Specified by:

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

Parameters:

o - component to be added, must be of correct type for table.

Returns:

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

containsAll

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

returns true if the table contains all of the components in the Collection argument

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)

removeAll

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

remove all of the elements in the Collection from this table

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)

clear

public void clear()

remove all elements in the table

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)

retrieve the ith element from the table

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)

Used internally by subclasses.

Specified by:

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

Parameters:

index - at which to replace the new row.

element - to replace existing, must be of correct type for table.

Returns:

the element previously at the specified position

remove

public T remove(int index)

Remove the DictionaryComponent at the given index from the table

Specified by:

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

Parameters:

index - the index of the RuleCompoonent in the table.

Returns:

the Object which was removed.

remove

public boolean remove(java.lang.Object o)

remove the DictionaryComponent from this table

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

move

public void move(int fromIndex,
        int toIndex,
        boolean replace)

Move the DictionaryComponent with the given id from its current location to the location of the second id. Shift the row currently at that location up, or replace it.

Parameters:

fromIndex - the index of the row to move

toIndex - move row to this location

replace - if true, replace existing row at toIndex, if false move existing row to next higher index

move

public T move(int index,
     boolean up)

Shift the entry defined by index either up or down one entry in the table. The direction up==true will swap the entry with the one with index -1. The direction up==false will swap the entry with the one with index + 1.

Parameters:

index -

up - boolean

Returns:

the item moved

indexOf

public int indexOf(java.lang.Object o)

get the index of the Object argument

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

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

add

public T add()

Add a new element to the table and return the new element.

Returns:

new table element

Throws:

java.lang.UnsupportedOperationException - if table is locked.

add

public abstract T add(int index)

Add a new element to the table at the specified location and return the new element Must be abstract because generics cannot do "new T"

Returns:

new table element

copyTo

public T copyTo(int index,
       T from)

cut

public void cut(T dc)

Cut (remove) the given component from this table. Use DictionaryComponentTable.paste(T) to paste the component into this or a different table

Parameters:

dc -

paste

public T paste(T dc)

Paste a cut or existing component at the end of this table

Parameters:

dc - the component to paste into the table

Returns:

component pasted

reorder

public void reorder(java.util.List<java.lang.Integer> ordering)

reorder this table according to a list of indexes. e.g. to reverse a list of 3 elements, use ordering (2,1,0).

Parameters:

ordering - a list of indexes the same size as this list.

ordering

public static java.util.List<java.lang.Integer> ordering(java.util.List<? extends DictionaryComponent> list)

getLast

public T getLast()

Get the last entry in the table

Returns:

entry at position size() - 1

mark

public void mark(int[] index)

Mark the rows with the given indexes

Parameters:

index - an Array containing row numbers (not ID's) to be removed

unMark

public void unMark()

Clear marks. Set all rows to unmarked.

getMarked

public DictionaryComponent[] getMarked()

see DictionaryComponentTable.mark(int[])

Returns:

an Array of the marked RuleComponents

removeMarked

public int removeMarked()
                 throws DeleteException

Returns:

the number of rows removed

Throws:

DeleteException

See Also:

DictionaryComponentTable.mark(int[])

sort

public void sort(java.lang.String prop)

sort

public void sort(java.lang.String prop,
        boolean ascending)

sort

public static void sort(java.util.List<? extends DictionaryComponent> list,
        java.lang.String prop,
        boolean ascending)

Sorts the components in the given list by the property and sort order specified

Parameters:

list - Collection of components to be sorted

prop - Property value to be sorted by

ascending - true if ascending sort order, false if descending sort order

filter

public java.util.List<T> filter(java.lang.String filterPattern,
                       boolean translate)

Get the Dictionary Components in this table that match the given pattern

Parameters:

filterPattern - pattern for filtering

translate - boolean value to indicate if the translated value should be used for filtering

Returns:

list of DictionaryComponents filtered based on pattern given

isLocked

public boolean isLocked()

Whether the table is locked (is readonly)

Returns:

whether the table is readonly