Package 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:
Serializable, Cloneable, Iterable<T>, Collection<T>, List<T>
Direct Known Subclasses:
DictionaryLinkTable, ModelComponentTable, RuleComponentTable
public abstract class DictionaryComponentTable<T extends DictionaryComponent> extends DictionaryObject implements List<T>
A dictionary component table is a List of DictionaryComponents.
See Also:

  • Field Details

  • Method Details

    • 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

    • initProtoType

      public T initProtoType()

    • removeProtoType

      public void removeProtoType()

    • getByName

      public T getByName(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(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(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(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(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(List<SDKException> errors, 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(List<SDKException> errors, 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:

    • size

      public int size()
      return the size of the table
      Specified by:
      size in interface Collection<T extends DictionaryComponent>
      Specified by:
      size in interface List<T extends DictionaryComponent>

    • isEmpty

      public boolean isEmpty()
      return if the table is empty
      Specified by:
      isEmpty in interface Collection<T extends DictionaryComponent>
      Specified by:
      isEmpty in interface List<T extends DictionaryComponent>

    • contains

      public boolean contains(Object o)
      return if the the table contains the object
      Specified by:
      contains in interface Collection<T extends DictionaryComponent>
      Specified by:
      contains in interface List<T extends DictionaryComponent>

    • getAEReferences

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

    • getExprParserReferences

      public List<ExprParser> getExprParserReferences()
      Description copied from class: DictionaryObject
      Get all ExprParsers that are directly or Indirectly referenced by this dictionary Object and its descendants
      Specified by:
      getExprParserReferences in class DictionaryObject
      Returns:
      Collection of Expression Parsers

    • iterator

      public Iterator<T> iterator()
      Specified by:
      iterator in interface Collection<T extends DictionaryComponent>
      Specified by:
      iterator in interface Iterable<T extends DictionaryComponent>
      Specified by:
      iterator in interface List<T extends DictionaryComponent>

    • listIterator

      public ListIterator<T> listIterator()
      Specified by:
      listIterator in interface List<T extends DictionaryComponent>

    • listIterator

      public ListIterator<T> listIterator(int index)
      Specified by:
      listIterator in interface List<T extends DictionaryComponent>

    • toArray

      public Object[] toArray()
      Specified by:
      toArray in interface Collection<T extends DictionaryComponent>
      Specified by:
      toArray in interface List<T extends DictionaryComponent>

    • toArray

      public <U> U[] toArray(U[] a)
      Specified by:
      toArray in interface Collection<T extends DictionaryComponent>
      Specified by:
      toArray in interface List<T extends DictionaryComponent>

    • add

      public boolean add(T o)
      Used internally by subclasses.
      Specified by:
      add in interface Collection<T extends DictionaryComponent>
      Specified by:
      add in interface List<T extends DictionaryComponent>
      Parameters:
      o - component to be added, must be of correct type for table.

    • add

      public void add(int index, T element)
      Used internally by subclasses.
      Specified by:
      add in interface List<T extends DictionaryComponent>
      Parameters:
      index - at which to place the new row.
      element - to be added, must be of correct type for table.

    • containsAll

      public boolean containsAll(Collection<?> c)
      returns true if the table contains all of the components in the Collection argument
      Specified by:
      containsAll in interface Collection<T extends DictionaryComponent>
      Specified by:
      containsAll in interface List<T extends DictionaryComponent>

    • addAll

      public boolean addAll(Collection<? extends T> c)
      Used internally by subclasses.
      Specified by:
      addAll in interface Collection<T extends DictionaryComponent>
      Specified by:
      addAll in interface List<T extends DictionaryComponent>

    • addAll

      public boolean addAll(int index, Collection<? extends T> c)
      Specified by:
      addAll in interface List<T extends DictionaryComponent>

    • removeAll

      public boolean removeAll(Collection<?> c)
      remove all of the elements in the Collection from this table
      Specified by:
      removeAll in interface Collection<T extends DictionaryComponent>
      Specified by:
      removeAll in interface List<T extends DictionaryComponent>

    • retainAll

      public boolean retainAll(Collection<?> c)
      Specified by:
      retainAll in interface Collection<T extends DictionaryComponent>
      Specified by:
      retainAll in interface List<T extends DictionaryComponent>

    • _clear

      public final void _clear()

    • clear

      public void clear()
      remove all elements in the table
      Specified by:
      clear in interface Collection<T extends DictionaryComponent>
      Specified by:
      clear in interface List<T extends DictionaryComponent>

    • get

      public T get(int index)
      retrieve the ith element from the table
      Specified by:
      get in interface List<T extends DictionaryComponent>

    • set

      public T set(int index, T element)
      Used internally by subclasses.
      Specified by:
      set in interface List<T extends DictionaryComponent>
      Parameters:
      index - at which to replace the new row.
      element - to replace existing, must be of correct type for table.

    • remove

      public T remove(int index)
      Remove the DictionaryComponent at the given index from the table
      Specified by:
      remove in interface List<T extends DictionaryComponent>
      Parameters:
      index - the index of the RuleCompoonent in the table.
      Returns:
      the Object which was removed.

    • remove

      public boolean remove(Object o)
      remove the DictionaryComponent from this table
      Specified by:
      remove in interface Collection<T extends DictionaryComponent>
      Specified by:
      remove in interface List<T extends DictionaryComponent>

    • _remove

      public T _remove(int index)

    • _remove

      public final boolean _remove(Object o)

    • 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(Object o)
      get the index of the Object argument
      Specified by:
      indexOf in interface List<T extends DictionaryComponent>

    • lastIndexOf

      public int lastIndexOf(Object o)
      Specified by:
      lastIndexOf in interface List<T extends DictionaryComponent>

    • subList

      public List<T> subList(int fromIndex, int toIndex)
      Not Supported
      Specified by:
      subList in interface List<T extends DictionaryComponent>
      Throws:
      UnsupportedOperationException

    • add

      public T add()
      Add a new element to the table and return the new element.
      Returns:
      new table element
      Throws:
      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(T from)
      Copy "from" object component of type T to this component table that holds components of type T. The copy is a deep copy. The two objects may be in different dictionaries.
      Parameters:
      from - component to copy to this table
      Returns:
      copy of component

    • copyTo

      public T copyTo(int index, T from)

    • cut

      public void cut(T dc)
      Cut (remove) the given component from this table. Use 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(List<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 List<Integer> ordering(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 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:

    • sort

      public void sort(String prop)

    • sort

      public void sort(String prop, boolean ascending)

    • sort

      public static void sort(List<? extends DictionaryComponent> list, 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 List<T> filter(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