ViewCriteria (Oracle Fusion Middleware Java API Reference for Oracle ADF Mobile Client)

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle Fusion Middleware Java API Reference for Oracle ADF Mobile Client
11g Release 1 (11.1.1)
E17503-02

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.jbo
Class ViewCriteria

java.lang.Object
  oracle.adfnmc.java.util.AbstractCollection
      oracle.adfnmc.java.util.AbstractList
          oracle.adfnmc.java.util.Vector
              oracle.jbo.ViewCriteria

All Implemented Interfaces:: Serializable, Cloneable, Iterable, Collection, List, RandomAccess, NavigatableRowIterator, Properties, RowIterator, VariableManagerOwner, VariableManagerOwnerBase, ViewCriteriaComponent

Direct Known Subclasses:: ViewCriteriaImpl

public class ViewCriteria
extends Vector
implements NavigatableRowIterator, ViewCriteriaComponent, Properties, VariableManagerOwner
extends Vector
implements NavigatableRowIterator, ViewCriteriaComponent, Properties, VariableManagerOwner

A list of row criteria for a View Object's WHERE clause.

The lengths of the oracle.jbo.ViewCriteriaRows in the list must all match the number of attributes in the View Object.

The following example of a user-defined function, demoCriteria uses several methods in the ViewCriteria and ViewCriteriaRow classes to create and populate criteria rows and to demonstrate "query-by-example." The printViewObject is a helper function that executes the View Object query and prints the results to the screen.

    public static void demoCriteria(ApplicationModule appMod)
    {
       // Create and populate criteria rows to support query-by-example.
       ViewObject empView = appMod.createViewObject("Emp", "mypackage1.EmpView");
       ViewCriteria vc = empView.createViewCriteria();
       ViewCriteriaRow vcRow = vc.createViewCriteriaRow();
       // ViewCriteriaRow attribute name is case-sensitive.
       // ViewCriteriaRow attribute value requires operator and value.
       // Note also single-quotes around string value.
       vcRow.setAttribute("Job", "= 'MANAGER'");
       vc.addElement(vcRow);
       vcRow = vc.createViewCriteriaRow();
       vcRow.setAttribute("Sal", "> 2500");
       vc.addElement(vcRow);
       empView.applyViewCriteria(vc);
       // Multiple rows are OR-ed in WHERE clause.
       System.out.println("Demo View Criteria");
       // Should print employees that are MANAGER or have Sal > 2500
       QueryDemo.printViewObject(empView);
    }
    public static void printViewObject(ViewObject vo)
    {
       // Execute the query, print results to the screen.
       vo.executeQuery();
       // Print the View Object's query
       System.out.println("Query: " + vo.getQuery());
       while (vo.hasNext())
       {
          Row row = vo.next();\
          String rowDataStr = "";
          // How many attributes (columns) is the View Object using?
          int numAttrs = vo.getAttributeCount();
          // Column numbers start with 0, not 1.
          for (int columnNo = 0; columnNo < numAttrs; columnNo++)
          {
             // See also Row.getAttribute(String name).
             Object attrData = row.getAttribute(columnNo);
             rowDataStr += (attrData + "\t");
          }
          System.out.println(rowDataStr);
       }
    }

In the above code example, note that the View Object's ViewObject.applyViewCriteria(oracle.jbo.ViewCriteria) must be called to apply this ViewCriteria to the View Object.

Since:: JDeveloper 3.0

Nested Class Summary
`static class`	`ViewCriteria.NestedViewCriteriaRow`

Field Summary
`static java.lang.Class`	`CLASS_INSTANCE`
`static int`	`CRITERIA_MODE_CACHE` `CRITERIA_MODE_...` constants are used to specify View Criteria mode.
`static int`	`CRITERIA_MODE_QUERY` `CRITERIA_MODE_...` constants are used to specify View Criteria mode.
`static java.lang.String`	`FIND_MODE`
`protected ArrayList`	`listeners`
`protected java.util.Hashtable`	`mProperties`
`protected ViewCriteria`	`mSavedState`
`protected VariableValueManager`	`mVariableManager`
`static java.lang.String`	`TEMP_VARIABLE`

Fields inherited from class oracle.adfnmc.java.util.Vector
`capacityIncrement, elementCount, elementData`

Fields inherited from class oracle.adfnmc.java.util.AbstractList
`modCount`

Fields inherited from interface oracle.jbo.RowIterator
`ITER_MODE_LAST_PAGE_FULL, ITER_MODE_LAST_PAGE_PARTIAL, SLOT_BEFORE_FIRST, SLOT_BEYOND_LAST, SLOT_DELETED, SLOT_VALID`

Fields inherited from interface oracle.jbo.ViewCriteriaComponent
`VC_CONJ_AND, VC_CONJ_NOT, VC_CONJ_OR, VC_UPPER_COL_DEFAULT, VC_UPPER_COL_FALSE, VC_UPPER_COL_TRUE`

Constructor Summary
`ViewCriteria(StructureDef structureDef)`
`ViewCriteria(ViewCriteria parent, java.lang.String structDefFullName)`
`ViewCriteria(ViewObject viewObject)` Creates an empty view criteria object.

Method Summary
`void`	`add(int index, java.lang.Object element)` Adds the specified object into this Vector at the specified location.
`boolean`	`add(java.lang.Object o)` Adds the specified object at the end of this Vector.
`boolean`	`addAll(Collection c)` Adds the objects in the specified Collection to the end of this Vector.
`boolean`	`addAll(int index, Collection c)` Inserts the objects in the specified Collection at the specified location in this Vector.
`void`	`addElement(java.lang.Object obj)` Adds the specified object at the end of this Vector.
`void`	`addListener(java.lang.Object target)` Adds a `RowSetListener`.
`void`	`addRow(ViewCriteriaRow newRow)`
`void`	`clear()` Removes all elements from this Vector, leaving it empty.
`void`	`copyFrom(ViewCriteria vc)`
`Row`	`createAndInitRow(AttributeList nvp)` Creates a new Row object, but does not insert it into the row set.
`ViewCriteria`	`createCriteria()`
`Key`	`createKey(AttributeList nvp)` Given a list of name-value pairs, creates a Key object.
`ViewCriteriaRow`	`createNestedCriteriaRow(java.lang.String name, ViewCriteria criteria)`
`Row`	`createRow()` Creates a new Row object, but does not insert it into the row set.
`ViewCriteriaRow`	`createSimpleRow(java.lang.String name)`
`ViewCriteriaRow`	`createViewCriteriaRow()` Creates a new `ViewCriteriaRow` for this `ViewCriteria`.
`ViewCriteriaUsage`	`createViewCriteriaUsage()` Creates a View Criteria reference to an existing view criteria
`void`	`criteriaChanged()`
`VariableValueManager`	`ensureVariableManager()` Returns this object's Variable Value Manager.
`java.util.Enumeration`	`enumerateRowsInRange()` Gets an `Enumeration` interface for the row set.
`RowIterator`	`findByAltKey(java.lang.String keyName, Key key, int maxNumOfRows, boolean skipWhere)`
`Row[]`	`findByEntity(int eRowHandle, int maxNumOfRows)` Finds and returns View rows that use the entity row, identified by the entity row handle, `eRowHandle`.
`Row[]`	`findByKey(Key key, int maxNumOfRows)` Finds and returns View rows that match the specified key.
`RowIterator`	`findByViewCriteria(ViewCriteria criteria, int maxNumOfRows, int queryMode)` Finds and returns View rows that match the specified View Criteria.
`java.lang.Object`	`findElementWithRelativeName(java.lang.String compName)` Find a view criteria element given a full path.
`ViewCriteriaItem`	`findViewCriteriaItem(java.lang.String compName)`
`Row`	`first()` Designates the first row of the row set as the current row.
`boolean`	`get1013CompatibilityMode()`
`ArrayList`	`getAllBindVariables()`
`protected void`	`getAllBindVariables(Map map)`
`Row[]`	`getAllRowsInRange()` Returns an array ViewCriteriaRow's in this ViewCriteria.
`int`	`getAttributeIndexOf(java.lang.String name)` Finds the attribute associated with an attribute name.
`CriteriaClauses`	`getClauses()`
`int`	`getConjunction()`
`int`	`getCriteriaMode()` Gets the current View Criteria mode.
`Row`	`getCurrentRow()` Accesses the current row.
`int`	`getCurrentRowIndex()` Gets the absolute index (not range index) of the current row.
`int`	`getCurrentRowSlot()` Gets the slot status of the current row.
`java.lang.String`	`getDisplayName(LocaleContext locale)` Deprecated.
`int`	`getFetchedRowCount()` Counts the number of rows currently fetched in the row set.
`int`	`getIterMode()` Gets the iteration mode.
`protected ArrayList`	`getListenersList()`
`java.util.Hashtable`	`getLocalAndResourceProperties()` Used by the marshaller to get all the properties and resources (on the server side only) that are defined in this view criteria.
`java.lang.String`	`getLocaleName(LocaleContext locale, java.lang.String sName)` * return the ViewCriteriaHints interface implemented by this class
`java.lang.Class`	`getMessageBundleClass()`
`java.lang.String`	`getName()` Returns the name of this Variable Manager Owner.
`HashMap`	`getNestedViewCriteria(HashMap criteriaMap)` Internal use only.
`java.util.Hashtable`	`getProperties()` Gets the table of properties.
`java.util.Hashtable`	`getProperties(LocaleContext context)`
`java.lang.Object`	`getProperty(java.lang.String property)` Retrieves the specified property, if it exists.
`java.lang.Object`	`getProperty(java.lang.String property, LocaleContext locale)`
`int`	`getRangeIndexOf(Row row)` Get the index of the given row relative to the beginning of the range.
`int`	`getRangeSize()` Gets the range size.
`int`	`getRangeStart()` Gets the absolute index of the first row in the row set range.
`ResourceBundleDef`	`getResourceBundleDef()`
`protected void`	`getResourcesFromBundle(LocaleContext locale, HashMap map)` Get all resources from the resource bundle.
`protected void`	`getResourcesFromBundle(LocaleContext locale, java.util.Hashtable map)` Get all resources from the resource bundle.
`java.lang.String`	`getRootCriteriaRelativeName()`
`ViewCriteria`	`getRootViewCriteria()`
`Row`	`getRow(Key key)` Accesses a row through a unique key.
`Row`	`getRowAtRangeIndex(int index)` Accesses a row through its index in the row set.
`int`	`getRowCount()` Counts the total number of rows in the row set.
`int`	`getRowCountInRange()` Gets the size of the row set range.
`List`	`getRows()` Creates a XML representation of the ViewCriteria and appends it to the passed in XMLElement.
`StructureDef`	`getStructureDef()` return StructureDef that this Criteria is based on.
`java.lang.String`	`getStructureDefFullName()`
`int`	`getUpperColumnsValue()`
`java.lang.String[]`	`getUsedAttributeNames()` Finds all the attribute names used in this view criteria.
`AttributeDef[]`	`getUsedViewAttributes()` Finds all the attribute definitions used in this view criteria.
`VariableValueManager`	`getVariableManager()` Returns this object's current Variable Value Manager.
`ViewObject`	`getViewObject()` Gets the View Object that owns the view criteria.
`ViewObject`	`getViewObject(boolean getVoIfNested)` This methods return the View Object that owns this view criteria.
`protected VariableManager`	`getVoVariableManager()`
`boolean`	`hasData()`
`boolean`	`hasNext()` Tests for the existence of a row after the current row.
`boolean`	`hasPrevious()` Tests for the existence of a row before the current row.
`boolean`	`hasVariables()` Returns a flag indicating whether this object has Variables or not.
`void`	`initName(java.lang.String name)`
`void`	`insertElementAt(java.lang.Object obj, int index)` Inserts the specified object into this Vector at the specified location.
`void`	`insertRow(Row row)` Adds a row to the row set, before the current row.
`void`	`insertRowAtRangeIndex(int index, Row row)` Adds a row to the row set at the given index.
`boolean`	`isAppliedIfJoinSatisfied()`
`boolean`	`isCriteriaForQuery()` Returns a flag indicating whether the View Criteria is to be included in database query or be used for in memory row filtering.
`boolean`	`isCriteriaForRowMatch()`
`boolean`	`isDirty()`
`boolean`	`isItemHolder()` For internal use only Find out if this ViewCriteria is an item holder for a compound ViewCriteriaItem.
`boolean`	`isRangeAtBottom()` Tests if the row set range is at the end of the result set.
`boolean`	`isRangeAtTop()` Tests if the row set range is at the beginning of the result set.
`boolean`	`isRowValidation()` Gets the validation flag on this iterator.
`static boolean`	`isTemporaryVariable(Variable var)` Returns true if the variable passed is a temporary bind variable.
`boolean`	`isTemporaryVariableBelongs(Variable var)` Returns true if the variable passed is a temporary bind variable created for this view criteria.
`boolean`	`isUpperColumns()`
`boolean`	`isUseAttributeFormatHint()`
`boolean`	`isUseBindVarsOnly()`
`Row`	`last()` Designates the last row of the row set as the current row.
`void`	`loadVOBindVariables(Map bindVarMap)`
`Row`	`next()` Steps forward, designating the next row as the current row.
`Row`	`previous()` Steps backward, designating the previous row as the current row.
`java.lang.Object`	`refreshProperty(java.lang.String hintName)` Retrieves the specified property, if it exists.
`java.lang.Object`	`remove(int index)` Removes the object at the specified location from this List.
`boolean`	`remove(java.lang.Object o)` Removes the first occurrence, starting at the beginning and moving towards the end, of the specified object from this Vector.
`boolean`	`removeAll(Collection c)` Removes all occurrences in this Vector of each object in the specified Collection.
`void`	`removeAllElements()` Removes all elements from this Vector, leaving the size zero and the capacity unchanged.
`void`	`removeCurrentRow()` Removes the current Row object from the row set.
`Row`	`removeCurrentRowAndRetain()` Removes the current Row object from the collection and retain it for insertion into another location.
`void`	`removeCurrentRowFromCollection()` Removes the current Row object from the collection.
`boolean`	`removeElement(java.lang.Object obj)` Removes the first occurrence, starting at the beginning and moving towards the end, of the specified object from this Vector.
`void`	`removeElementAt(int index)` Removes the element found at index position `location` from this `Vector` and decrements the size accordingly.
`void`	`removeListener(java.lang.Object target)` Removes a `RowSetListener`.
`void`	`removeProperty(java.lang.String hintName)`
`protected void`	`removeRange(int fromIndex, int toIndex)` Removes the objects in the specified range from the start to the, but not including, end index.
`boolean`	`removeRow(ViewCriteriaRow row)`
`void`	`reset()` Clears the "current row" designation and places the iterator in the slot before the first row.
`void`	`resetCriteria()` restore the View Criteria to the state saved by the last call to the saveState method.
`void`	`resolve(ViewCriteriaResolver resolver)`
`boolean`	`retainAll(Collection c)` Removes all objects from this Vector that are not contained in the specified Collection.
`void`	`saveState()` save the current state of the View Criteria which will be restored to when resetCriteria is called.
`int`	`scrollRange(int amount)` Moves the row set range up or down a given number of rows.
`int`	`scrollRangeTo(Row row, int index)` Scrolls the range to place a given row at a given row set index.
`int`	`scrollToRangePage(int pageIndex)` This method is a no-op and returns zero.
`java.lang.Object`	`set(int index, java.lang.Object element)` Replaces the element at the specified location in this Vector with the specified object.
`void`	`set1013CompatibilityMode(boolean mode)` With this flag set to true, SQL fragment is allowed in the value argument in calls calls to ViewCriteriaRow.setAttribute() method.
`void`	`setAppliedIfJoinSatisfied(boolean bApplied)`
`void`	`setClauses(CriteriaClauses clauses)`
`void`	`setConjunction(int conj)`
`void`	`setCriteriaForQuery(boolean b)` Deprecated. Since JDeveloper 10.1.3. Use setCriteriaMode(int) instead
`void`	`setCriteriaMode(int mode)` Sets the criteria mode which controls the manner in which the View Criteria will be used.
`boolean`	`setCurrentRow(Row row)` Designates a given row as the current row.
`boolean`	`setCurrentRowAtRangeIndex(int index)` Designates a given index as the current row.
`void`	`setDirty(boolean isDirty)`
`void`	`setElementAt(java.lang.Object obj, int index)` Replaces the element at the specified location in this Vector with the specified object.
`void`	`setIterMode(int mode)` Modifies the iteration mode.
`void`	`setName(java.lang.String name)`
`void`	`setParent(java.lang.Object parent)`
`void`	`setProperties(java.util.Hashtable properties)`
`void`	`setProperty(java.lang.String hintName, java.lang.Object hintValue)`
`int`	`setRangeSize(int size)` Modifies the size of the row set range.
`int`	`setRangeStart(int start)` Moves the row set range.
`void`	`setRowValidation(boolean flag)` Sets the validation flag on this iterator.
`void`	`setStructureDefFullName(java.lang.String defName)`
`void`	`setUpperColumns(boolean b)`
`void`	`setUseAttributeFormatHint(boolean flag)` Turn this flag off to get the 904 and earlier behavior where attribute formatters are not consulated for equality critiera.
`void`	`setVariableManager(VariableValueManager variableManager)`
`void`	`setViewCriteriaManager(ViewCriteriaManager manager)`
`void`	`setViewObject(ViewObject vo)`
`java.lang.String`	`toString()` Answers the string representation of this Vector.
`void`	`trimNoDataRows()` This method walks through ViewCriteriaRow's in this ViewCriteria and removes those rows that have no data.
`void`	`useBindVarsOnly()`
`void`	`validate()`

Methods inherited from class oracle.adfnmc.java.util.Vector
`capacity, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, isEmpty, lastElement, lastIndexOf, lastIndexOf, setSize, size, subList, toArray, toArray, trimToSize`

Methods inherited from class oracle.adfnmc.java.util.AbstractList
`iterator, listIterator, listIterator`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface oracle.adfnmc.java.util.List
`iterator, listIterator, listIterator`

Field Detail

CLASS_INSTANCE

public static final java.lang.Class CLASS_INSTANCE

mProperties

protected transient java.util.Hashtable mProperties

mSavedState

protected transient ViewCriteria mSavedState

mVariableManager

protected transient VariableValueManager mVariableManager

CRITERIA_MODE_QUERY

public static int CRITERIA_MODE_QUERY

CRITERIA_MODE_... constants are used to specify View Criteria mode. CRITERIA_MODE_QUERY means that the View Criteria will be used to augment the database query's where-clause.

These constants may be OR'ed together. For example, (CRITERIA_MODE_QUERY | CRITERIA_MODE_CACHE) specifies that the View Criteria will be used for the database query, as well as the RowMatch (in-memory row filtering).

CRITERIA_MODE_CACHE

public static int CRITERIA_MODE_CACHE

CRITERIA_MODE_... constants are used to specify View Criteria mode. CRITERIA_MODE_CACHE means that the View Criteria will be used to produce a RowMatch, which is used for in-memory row filtering.

TEMP_VARIABLE

public static final java.lang.String TEMP_VARIABLE

See Also:: Constant Field Values

FIND_MODE

public static final java.lang.String FIND_MODE

See Also:: Constant Field Values

listeners

protected ArrayList listeners

Constructor Detail

ViewCriteria

public ViewCriteria(ViewObject viewObject)

Creates an empty view criteria object.

Parameters:: viewObject - the owner of this ViewCriteria.

ViewCriteria

public ViewCriteria(StructureDef structureDef)

ViewCriteria

public ViewCriteria(ViewCriteria parent,
                    java.lang.String structDefFullName)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: VariableManagerOwner

Returns the name of this Variable Manager Owner.

Specified by:: getName in interface VariableManagerOwner

Returns:: the name.

initName

public void initName(java.lang.String name)

setName

public void setName(java.lang.String name)

setParent

public void setParent(java.lang.Object parent)

hasData

public final boolean hasData()

setViewCriteriaManager

public void setViewCriteriaManager(ViewCriteriaManager manager)

getClauses

public CriteriaClauses getClauses()

setClauses

public void setClauses(CriteriaClauses clauses)

criteriaChanged

public void criteriaChanged()

isDirty

public boolean isDirty()

setDirty

public void setDirty(boolean isDirty)

isCriteriaForQuery

public boolean isCriteriaForQuery()

Returns a flag indicating whether the View Criteria is to be included in database query or be used for in memory row filtering.

If true, when the View Criteria is translated into a row qualification clause, it will use the name of the database column to which the attribute is mapped. If false, the attribute name is used as is.

If the View Criteria is being used for in memory row filtering, it should be used in conjunction with RowQualifier. See oracle.jbo.server.ViewObjectImpl#setRowQualifier(oracle.jbo.server.RowQualifier) for details.

Returns:: the flag indicating whether the View Criteria is for database query (true) or for in memory row filtering (false).

isCriteriaForRowMatch

public boolean isCriteriaForRowMatch()

setCriteriaForQuery

public void setCriteriaForQuery(boolean b)

Deprecated. Since JDeveloper 10.1.3. Use setCriteriaMode(int) instead

Sets the flag indicating whether the View Criteria is to be included in database query or be used for in memory row filtering.

Parameters:: b - the flag indicating whether the View Criteria is for database query (true) or for in memory row filtering (false).

getCriteriaMode

public int getCriteriaMode()

Gets the current View Criteria mode.

See CRITERIA_MODE_... constants for possible mode values.

The returning mode may be a combination (through bit-wise OR) multiple criteria modes.

Returns:: the current View Criteria mode.

setCriteriaMode

public void setCriteriaMode(int mode)

Sets the criteria mode which controls the manner in which the View Criteria will be used.

See CRITERIA_MODE_... constants for possible mode values.

The CRITERIA_MODE_... constants may be OR'ed together. For example, if this method is called with (CRITERIA_MODE_QUERY | CRITERIA_MODE_CACHE), the View Criteria will be used for the database query, as well as the RowMatch (in-memory row filtering).

Parameters:: mode - the new criteria mode.

setAppliedIfJoinSatisfied

public void setAppliedIfJoinSatisfied(boolean bApplied)

isAppliedIfJoinSatisfied

public boolean isAppliedIfJoinSatisfied()

setViewObject

public void setViewObject(ViewObject vo)

resolve

public void resolve(ViewCriteriaResolver resolver)

getViewObject

public ViewObject getViewObject()

Gets the View Object that owns the view criteria.

Returns:: the ViewObject that owns this ViewCriteria.

getViewObject

public ViewObject getViewObject(boolean getVoIfNested)

This methods return the View Object that owns this view criteria. If the getVoIfNested argument is true, and if this view criteria is a view criteria for a compound VC item, this method will return the View Object of the view criteria that contains this nested VC or compound VC item.

Parameters:: getVoIfNested - true if the VO of the owning VC should be retrieved if this VC is a nested VC or an item holder for a VC item. If false, this method returns the owning view object, which could be null for nested VC or item holder.
Returns:: The View Object that owns the view criteria, or that owns the view criteria that owns this nested view criteria or item holder.

getRootViewCriteria

public ViewCriteria getRootViewCriteria()

getRootCriteriaRelativeName

public java.lang.String getRootCriteriaRelativeName()

findViewCriteriaItem

public ViewCriteriaItem findViewCriteriaItem(java.lang.String compName)

findElementWithRelativeName

public java.lang.Object findElementWithRelativeName(java.lang.String compName)

Find a view criteria element given a full path. The path should be a . separated list of view criteria elements from the root criteria. Use

 getRootCriteriaRelativeName 
 to obtain the path and use it later to find the element



Parameters:
compName - The full path to the element relative to the root view criteria
Returns:
a View Criteria element, could be a nested view criteria,
 view criteria row, or an item.





isItemHolder
public boolean isItemHolder()

For internal use only

 Find out if this ViewCriteria is an item holder for a compound ViewCriteriaItem.






Returns:
true if this ViewCriteria is an item holder for a compound ViewCriteriaItem, false
         otherwise.





getStructureDef
public StructureDef getStructureDef()

return StructureDef that this Criteria is based on.











getStructureDefFullName
public java.lang.String getStructureDefFullName()











setStructureDefFullName
public void setStructureDefFullName(java.lang.String defName)











getAttributeIndexOf
public int getAttributeIndexOf(java.lang.String name)

Finds the attribute associated with an attribute name.
 





Parameters:
name - the attribute name.
Returns:
an attribute index (0 based).





getUsedAttributeNames
public java.lang.String[] getUsedAttributeNames()

Finds all the attribute names used in this view criteria.











getUsedViewAttributes
public AttributeDef[] getUsedViewAttributes()

Finds all the attribute definitions used in this view criteria. Assumes that resolve() has
 been called or the mStructureDef has been set.











createViewCriteriaRow
public ViewCriteriaRow createViewCriteriaRow()

Creates a new ViewCriteriaRow for this ViewCriteria. A ViewCriteriaRow
 object is an array for WHERE clause criteria. After setting up the ViewCriteriaRow, call
 add(viewCriteriaRow) or addElement(viewCriteriaRow) to add it to this
 ViewCriteria.
 






Returns:
a ViewCriteriaRow, an array for WHERE clause criteria.
See Also:
ViewCriteriaRow





createViewCriteriaUsage
public ViewCriteriaUsage createViewCriteriaUsage()

Creates a View Criteria reference to an existing view criteria






Returns:
a ViewCriteriaUsaga instance that contains the the information needed
         to resolve the view criteria
See Also:
ViewCriteriaUsage





getConjunction
public int getConjunction()


Specified by:
getConjunction in interface ViewCriteriaComponent








setConjunction
public void setConjunction(int conj)


Specified by:
setConjunction in interface ViewCriteriaComponent








isUpperColumns
public boolean isUpperColumns()


Specified by:
isUpperColumns in interface ViewCriteriaComponent








setUpperColumns
public void setUpperColumns(boolean b)


Specified by:
setUpperColumns in interface ViewCriteriaComponent








getUpperColumnsValue
public int getUpperColumnsValue()


Specified by:
getUpperColumnsValue in interface ViewCriteriaComponent








useBindVarsOnly
public void useBindVarsOnly()











isUseBindVarsOnly
public boolean isUseBindVarsOnly()











set1013CompatibilityMode
public void set1013CompatibilityMode(boolean mode)

With this flag set to true, SQL fragment is allowed in the value argument in calls calls to
 ViewCriteriaRow.setAttribute() method.

 This flag is false by default. Allowing SQL fragment in the value argument of setAttribute
 should be done only if the risk of SQL injection has been carefully considered.





Parameters:
mode - true to allow SQL fragment in value argument of ViewCriteriaRow.setAttribute(), false
          to unset.





get1013CompatibilityMode
public boolean get1013CompatibilityMode()











loadVOBindVariables
public void loadVOBindVariables(Map bindVarMap)











getAllBindVariables
public ArrayList getAllBindVariables()











getAllBindVariables
protected void getAllBindVariables(Map map)











next
public Row next()

Steps forward, designating the next row as the current row.
 


Specified by:
next in interface RowIterator



Returns:
a Row object, or null if there is no next row.





previous
public Row previous()

Steps backward, designating the previous row as the current row.
 


Specified by:
previous in interface RowIterator



Returns:
a Row object, or null if there is no previous row.





first
public Row first()

Designates the first row of the row set as the current row.
 


Specified by:
first in interface RowIterator



Returns:
a Row object, or null if the row set is empty.





last
public Row last()

Designates the last row of the row set as the current row.
 


Specified by:
last in interface RowIterator



Returns:
a Row object, or null if the row set is empty.





reset
public void reset()

Clears the "current row" designation and places the iterator in the slot before the first row.
 
 A subsequent invocation of next() will cause the first row to become the
 current row.


Specified by:
reset in interface RowIterator








hasNext
public boolean hasNext()

Tests for the existence of a row after the current row.
 


Specified by:
hasNext in interface RowIterator



Returns:
true if there is next row.





hasPrevious
public boolean hasPrevious()

Tests for the existence of a row before the current row.
 


Specified by:
hasPrevious in interface RowIterator



Returns:
true if there is previous row.





getFetchedRowCount
public int getFetchedRowCount()

Counts the number of rows currently fetched in the row set.
 


Specified by:
getFetchedRowCount in interface RowIterator



Returns:
the number of fetched rows.





getRowCount
public int getRowCount()

Counts the total number of rows in the row set.
 


Specified by:
getRowCount in interface RowIterator



Returns:
the number of rows.





getRowAtRangeIndex
public Row getRowAtRangeIndex(int index)

Accesses a row through its index in the row set.
 


Specified by:
getRowAtRangeIndex in interface RowIterator


Parameters:
index - an integer in the range 0 to getRangeSize() - 1.
Returns:
a Row object, or null if the index is out of range.





getCurrentRow
public Row getCurrentRow()

Accesses the current row.
 


Specified by:
getCurrentRow in interface RowIterator



Returns:
the Row object designated as the current row.





getCurrentRowIndex
public int getCurrentRowIndex()

Gets the absolute index (not range index) of the current row.
 


Specified by:
getCurrentRowIndex in interface RowIterator



Returns:
a row index (0 based).





getCurrentRowSlot
public int getCurrentRowSlot()

Gets the slot status of the current row.
 


Specified by:
getCurrentRowSlot in interface RowIterator



Returns:
one of the class constants prefixed by SLOT_. See SLOT_
         constants in RowIterator.





setCurrentRow
public boolean setCurrentRow(Row row)

Designates a given row as the current row.
 


Specified by:
setCurrentRow in interface RowIterator


Parameters:
row - the new current row.
Returns:
true if the operation succeeded.





createAndInitRow
public Row createAndInitRow(AttributeList nvp)

Creates a new Row object, but does not insert it into the row set. For
 ViewCriteria, this method works just like createRow().
 


Specified by:
createAndInitRow in interface RowIterator


Parameters:
nvp - not used.
Returns:
a new Row object.





createRow
public Row createRow()

Creates a new Row object, but does not insert it into the row set.
 


Specified by:
createRow in interface RowIterator



Returns:
a new Row object.





insertRow
public void insertRow(Row row)

Adds a row to the row set, before the current row. This method sets the current row to the row
 just inserted. With respect to eventing, this method call will generate two events (of
 oracle.jbo.RowSetListener): rowInserted, followed by navigated.
 


Specified by:
insertRow in interface RowIterator


Parameters:
row - the Row object to be added.





removeCurrentRow
public void removeCurrentRow()

Removes the current Row object from the row set.


Specified by:
removeCurrentRow in interface RowIterator








removeCurrentRowFromCollection
public void removeCurrentRowFromCollection()

Description copied from interface: RowIterator
Removes the current Row object from the collection.
 

 It does not cause the row to be deleted from the database table. It just removes the row from
 the row collection. However, once the row is removed, it cannot be used any more. If you want
 to remove the current row from collection and insert it elsewhere, call
 RowIterator.removeCurrentRowAndRetain(), change currency to the
 desired location, and then call RowIterator.insertRow(oracle.jbo.Row) with that
 row.


Specified by:
removeCurrentRowFromCollection in interface RowIterator








removeCurrentRowAndRetain
public Row removeCurrentRowAndRetain()

Description copied from interface: RowIterator
Removes the current Row object from the collection and retain it for insertion into another
 location.
 

 It does not cause the row to be deleted from the database table. It just removes the row from
 the row collection.
 


 This method differs from RowIterator.removeCurrentRowFromCollection() in that
 after the current row is removed from the collection, it can be inserted back into the
 collection at another location.
 


 To do so, call RowIterator.removeCurrentRowAndRetain(), and get the returning
 row. Then, change currency to the desired location, and call
 RowIterator.insertRow(oracle.jbo.Row) with that row.


Specified by:
removeCurrentRowAndRetain in interface RowIterator



Returns:
the current row which was just removed from collection.





setRangeSize
public int setRangeSize(int size)

Modifies the size of the row set range.
 

 This method is a no-op for ViewCriteria. For a ViweCriteria, the range size is always -1.
 



Specified by:
setRangeSize in interface RowIterator


Parameters:
size - this parameter is not used.
Returns:
-1, which means that the range contains all rows.
See Also:
RowIterator.setRangeStart(int)





getRangeSize
public int getRangeSize()

Gets the range size. For ViewCriteria, the range size is always -1 (all rows).
 


Specified by:
getRangeSize in interface RowIterator



Returns:
-1, which means that the range contains all rows.





getRangeStart
public int getRangeStart()

Gets the absolute index of the first row in the row set range.
 

 The absolute index is 0-based, and is the row's index relative to the entire result set.
 



Specified by:
getRangeStart in interface RowIterator



Returns:
an index.





setRangeStart
public int setRangeStart(int start)

Moves the row set range.
 

 Note that the index is 0-based. When you call setRangeStart(1), the range start
 will be positioned at the second table row.
 


 Another behavior of setRangeStart (and also setRangeSize) is that it
 tries to position the range, so as to fill up the range as much as possible. For example,
 assume you have View Object vo focused on a table with four rows (A, B, C, D), and
 you execute the following code:
 


 
 vo.setRangeStart(4);
 vo.setRangeSize(3);
 Row[] rows = vo.getAllRowsInRange();
 

 

 In this case, rows contains the last 3 rows (B, C, D). When you call
 setRangeStart(4), it will try to position you at row 4. Since the index is
 0-based, it finds that there is no row. Since the default range size is 1, it will position
 you to the last row (row index 3).
 


 Then, when you call getRangeSize(3), it tries to fill up the range from the
 bottom. This is why you get (B, C, D).
 



Specified by:
setRangeStart in interface RowIterator


Parameters:
start - the absolute index of the new first row in the row set range.





scrollRange
public int scrollRange(int amount)

Moves the row set range up or down a given number of rows.
 


Specified by:
scrollRange in interface RowIterator


Parameters:
amount - the number of rows to scroll. A negative value scrolls upward.
Returns:
the number of rows actually scrolled.





scrollToRangePage
public int scrollToRangePage(int pageIndex)

This method is a no-op and returns zero.











scrollRangeTo
public int scrollRangeTo(Row row,
                         int index)

Scrolls the range to place a given row at a given row set index.
 


Specified by:
scrollRangeTo in interface RowIterator


Parameters:
row - the row.
index - the row's new index.
Returns:
the actual number of rows scrolled. A negative number indicates that the scroll was
         scrolled upward.





setCurrentRowAtRangeIndex
public boolean setCurrentRowAtRangeIndex(int index)

Designates a given index as the current row.
 


Specified by:
setCurrentRowAtRangeIndex in interface RowIterator


Parameters:
index - the index of the new current row.
Returns:
true if the operation succeeded.





insertRowAtRangeIndex
public void insertRowAtRangeIndex(int index,
                                  Row row)

Adds a row to the row set at the given index. The index is relative to the
 range, i.e., index of 0 would mean to insert before the first row of the range.
 Allowed values for index is 0 to range size. If index equals
 range size, the row is inserted right after the last row in the range. This method call does
 not alter the current position of the iterator, nor does it affect the range position.
 


Specified by:
insertRowAtRangeIndex in interface RowIterator


Parameters:
index - the point where row is to be added.
row - the Row object to be added.





getRangeIndexOf
public int getRangeIndexOf(Row row)

Get the index of the given row relative to the beginning of the range.
 


Specified by:
getRangeIndexOf in interface RowIterator


Parameters:
row - a Row object. or -1 if the row is not in range.
Returns:
the range index of row (0 based).





getRowCountInRange
public int getRowCountInRange()

Gets the size of the row set range.
 


Specified by:
getRowCountInRange in interface RowIterator



Returns:
the number of rows in the range.





isRangeAtBottom
public boolean isRangeAtBottom()

Tests if the row set range is at the end of the result set.
 


Specified by:
isRangeAtBottom in interface RowIterator



Returns:
true if the last row of the range is the last row of the result set.





isRangeAtTop
public boolean isRangeAtTop()

Tests if the row set range is at the beginning of the result set.
 


Specified by:
isRangeAtTop in interface RowIterator



Returns:
true if the first row of the range is the first row of the result set.





enumerateRowsInRange
public java.util.Enumeration enumerateRowsInRange()

Gets an Enumeration interface for the row set.
 


Specified by:
enumerateRowsInRange in interface RowIterator



Returns:
an Enumeration interface.





getAllRowsInRange
public Row[] getAllRowsInRange()

Returns an array ViewCriteriaRow's in this ViewCriteria.
 


Specified by:
getAllRowsInRange in interface RowIterator



Returns:
an array of ViewCriteriaRow's.





getRow
public Row getRow(Key key)

Accesses a row through a unique key.
 

 This operation is not supported by ViewCriteria. Calling this method will throw
 InvalidOperException.
 



Specified by:
getRow in interface RowIterator


Parameters:
key - a key.
Returns:
none.
Throws:
InvalidOperException - is thrown. ViewCriteria does not support this operation.





findByKey
public Row[] findByKey(Key key,
                       int maxNumOfRows)

Finds and returns View rows that match the specified key.
 

 This operation is not supported by ViewCriteria. Calling this method will throw
 InvalidOperException.
 



Specified by:
findByKey in interface RowIterator


Parameters:
key - the key to match.
maxNumOfRows - the maximum size of the array to return, or -1 to return all rows.
Returns:
none.
Throws:
InvalidOperException - is thrown. ViewCriteria does not support this operation.





findByAltKey
public RowIterator findByAltKey(java.lang.String keyName,
                                Key key,
                                int maxNumOfRows,
                                boolean skipWhere)











findByViewCriteria
public RowIterator findByViewCriteria(ViewCriteria criteria,
                                      int maxNumOfRows,
                                      int queryMode)

Description copied from interface: RowIterator
Finds and returns View rows that match the specified View Criteria. See
 ViewCriteria for details on how to build and use a View Criteria.
 

 The queryMode parameter controls the manner in which the qualifying View rows
 are searched. See the QUERY_MODE_... constants in
 ViewObject for different contants that can be specified
 (they can be OR'ed together).
 


 If QUERY_MODE_SCAN_VIEW_ROWS is specified, the existing View rows in the
 current Row Set are scanned for matching rows.
 


 If QUERY_MODE_SCAN_ENTITY_ROWS is specified, the Entity cache is searched for
 qualifying rows. If qualifying rows are found, they are added to the current Row Set. I.e.,
 they become part of the current row collection. Internally, a finder View Object is created to
 search the Entity cache and to produce View rows from the Entity cache.
 


 If QUERY_MODE_SCAN_DATABASE_TABLES is specified, a database query is issued to
 find matching rows. The View Criteria is converted into a where-clause.
 ViewObject.applyViewCriteria(ViewCriteria) on the finder
 View Object is invoked and the query executed.
 


 Upon completion of this operation, the finder View Object is closed and removed.
 



Specified by:
findByViewCriteria in interface RowIterator


Parameters:
criteria - the View Criteria to be used to qualify View rows.
maxNumOfRows - the maximum size of the array to return, or -1 to return all rows. If a
          value other than -1 is specified and if the specified number of rows is
          reached, the method returns without performing any further operation.
queryMode - the mode in which qualify View rows are scanned. See above for further info.
Returns:
a RowSet (parented by the same View Object as this RowIterator) that contains
         qualifying rows. For convenience, this RowSet's range size is initialized to -1 (all
         rows).





createKey
public Key createKey(AttributeList nvp)

Given a list of name-value pairs, creates a Key object.
 

 This operation is not supported by ViewCriteria. Calling this method will throw
 InvalidOperException.
 



Specified by:
createKey in interface RowIterator


Parameters:
nvp - the name value pair array.
Returns:
none.
Throws:
InvalidOperException - is thrown. ViewCriteria does not support this operation.





findByEntity
public Row[] findByEntity(int eRowHandle,
                          int maxNumOfRows)

Finds and returns View rows that use the entity row, identified by the entity row handle,
 eRowHandle.
 

 This operation is not supported by ViewCriteria. Calling this method will throw
 InvalidOperException.
 



Specified by:
findByEntity in interface RowIterator


Parameters:
eRowHandle - the entity row handle.
maxNumOfRows - the maximum size of the row array to return, or -1 to return all rows.
Returns:
none.
Throws:
InvalidOperException - is thrown. ViewCriteria does not support this operation.





setRowValidation
public void setRowValidation(boolean flag)

Sets the validation flag on this iterator.
 

 This operation is not supported by ViewCriteria. Calling this method will throw
 InvalidOperException.
 



Specified by:
setRowValidation in interface RowIterator


Parameters:
flag - whether to turn row validation off or not.
Throws:
InvalidOperException - is thrown. ViewCriteria does not support this operation.





isRowValidation
public boolean isRowValidation()

Description copied from interface: RowIterator
Gets the validation flag on this iterator. By default a RowIterator validates the current row
 when navigating to another row. This method returns TRUE if this row-validation is turned off.


Specified by:
isRowValidation in interface RowIterator








getIterMode
public int getIterMode()

Gets the iteration mode.
 

 As ViewCriteria always works with full range (range size -1), iteration mode is meaningless.
 



Specified by:
getIterMode in interface RowIterator



Returns:
the iteration mode. It is always
         RowIterator.ITER_MODE_LAST_PAGE_FULL.





setIterMode
public void setIterMode(int mode)

Modifies the iteration mode.
 

 This method is a no-op for ViewCriteria. For a ViweCriteria, the range size is always -1, and
 thus iteration mode is meaningless.
 



Specified by:
setIterMode in interface RowIterator


Parameters:
mode - this parameter is not used.





getListenersList
protected ArrayList getListenersList()











addListener
public void addListener(java.lang.Object target)

Adds a RowSetListener.
 


Specified by:
addListener in interface NavigatableRowIterator


Parameters:
target - the listener to add.





removeListener
public void removeListener(java.lang.Object target)

Removes a RowSetListener.


Specified by:
removeListener in interface NavigatableRowIterator


Parameters:
target - the listener to remove.





trimNoDataRows
public void trimNoDataRows()

This method walks through ViewCriteriaRow's in this ViewCriteria and removes those rows that
 have no data.
 











setUseAttributeFormatHint
public void setUseAttributeFormatHint(boolean flag)

Turn this flag off to get the 904 and earlier behavior where attribute formatters are not
 consulated for equality critiera.











isUseAttributeFormatHint
public boolean isUseAttributeFormatHint()











copyFrom
public void copyFrom(ViewCriteria vc)











createCriteria
public ViewCriteria createCriteria()











saveState
public void saveState()

save the current state of the View Criteria which will be restored to when resetCriteria is
 called.











resetCriteria
public void resetCriteria()

restore the View Criteria to the state saved by the last call to the saveState method.











getRows
public List getRows()

Creates a XML representation of the ViewCriteria and appends it to the passed in XMLElement.





Parameters:
node - 





addRow
public void addRow(ViewCriteriaRow newRow)











removeRow
public boolean removeRow(ViewCriteriaRow row)











createSimpleRow
public ViewCriteriaRow createSimpleRow(java.lang.String name)











createNestedCriteriaRow
public ViewCriteriaRow createNestedCriteriaRow(java.lang.String name,
                                               ViewCriteria criteria)











validate
public void validate()











toString
public java.lang.String toString()

Description copied from class: Vector
Answers the string representation of this Vector.


Overrides:
toString in class Vector



Returns:
the string representation of this Vector
See Also:
Vector.elements()





isTemporaryVariable
public static boolean isTemporaryVariable(Variable var)

Returns true if the variable passed is a temporary bind variable.





Parameters:
var - The variable to be checked
Returns:
true if the variable passed is a temporary variable, false otherwise.





isTemporaryVariableBelongs
public boolean isTemporaryVariableBelongs(Variable var)

Returns true if the variable passed is a temporary bind variable created for this view
 criteria.





Parameters:
var - The variable to be checked
Returns:
true if the variable passed is a temporary variable that is created for this view
         criteria, false if it is not a temporary variable or it is a temporary variable
         created for a different view criteria.





getNestedViewCriteria
public HashMap getNestedViewCriteria(HashMap criteriaMap)

Internal use only. Returns a map of nested view criteria within this object.











hasVariables
public boolean hasVariables()

Description copied from interface: VariableManagerOwner
Returns a flag indicating whether this object has Variables or not.


Specified by:
hasVariables in interface VariableManagerOwner
Specified by:
hasVariables in interface VariableManagerOwnerBase



Returns:
the flag indicating whether this object has Variables.





getVariableManager
public VariableValueManager getVariableManager()

Description copied from interface: VariableManagerOwner
Returns this object's current Variable Value Manager. It will return null if
 Variable Value Manager has been initialized.
 

 When a framework object is first created, its Variable Value Manager may be null. This method
 does not initialize (create) the Variable Value Manager.
 


 VariableManagerOwner.ensureVariableManager() in contrast, ensures that the Variable Value
 Manager is initialized (created).


Specified by:
getVariableManager in interface VariableManagerOwner
Specified by:
getVariableManager in interface VariableManagerOwnerBase



Returns:
this object's current Variable Value Manager. May return null if one
         was not yet initialized.





ensureVariableManager
public VariableValueManager ensureVariableManager()

Description copied from interface: VariableManagerOwner
Returns this object's Variable Value Manager. If this object current has no Variable Value
 Manager, it will initialize (create) one.


Specified by:
ensureVariableManager in interface VariableManagerOwner
Specified by:
ensureVariableManager in interface VariableManagerOwnerBase



Returns:
this object's Variable Value Manager. Will create a Variable Value Manager if this
         object had no Variable Value Manager.





getMessageBundleClass
public java.lang.Class getMessageBundleClass()


Specified by:
getMessageBundleClass in interface VariableManagerOwner
Specified by:
getMessageBundleClass in interface VariableManagerOwnerBase








getResourceBundleDef
public ResourceBundleDef getResourceBundleDef()


Specified by:
getResourceBundleDef in interface VariableManagerOwner








add
public void add(int index,
                java.lang.Object element)

Description copied from class: Vector
Adds the specified object into this Vector at the specified location. The
 object is inserted before any previous element at the specified location.
 If the location is equal to the size of this Vector, the object is added
 at the end.


Specified by:
add in interface List
Overrides:
add in class Vector


Parameters:
index - the index at which to insert the element
element - the object to insert in this Vector
See Also:
Vector.addElement(java.lang.Object), 
Vector.size()





add
public boolean add(java.lang.Object o)

Description copied from class: Vector
Adds the specified object at the end of this Vector.


Specified by:
add in interface Collection
Specified by:
add in interface List
Overrides:
add in class Vector


Parameters:
o - the object to add to the Vector
Returns:
true





addAll
public boolean addAll(Collection c)

Description copied from class: Vector
Adds the objects in the specified Collection to the end of this Vector.


Specified by:
addAll in interface Collection
Specified by:
addAll in interface List
Overrides:
addAll in class Vector


Parameters:
c - the Collection of objects
Returns:
true if this Vector is modified, false otherwise





addAll
public boolean addAll(int index,
                      Collection c)

Description copied from class: Vector
Inserts the objects in the specified Collection at the specified location
 in this Vector. The objects are inserted in the order in which they are
 returned from the Collection iterator.


Specified by:
addAll in interface List
Overrides:
addAll in class Vector


Parameters:
index - the location to insert the objects
c - the Collection of objects
Returns:
true if this Vector is modified, false otherwise





addElement
public void addElement(java.lang.Object obj)

Description copied from class: Vector
Adds the specified object at the end of this Vector.


Overrides:
addElement in class Vector


Parameters:
obj - the object to add to the Vector





clear
public void clear()

Description copied from class: Vector
Removes all elements from this Vector, leaving it empty.


Specified by:
clear in interface Collection
Specified by:
clear in interface List
Overrides:
clear in class Vector


See Also:
Vector.isEmpty(), 
Vector.size()





insertElementAt
public void insertElementAt(java.lang.Object obj,
                            int index)

Description copied from class: Vector
Inserts the specified object into this Vector at the specified location.
 This object is inserted before any previous element at the specified
 location. If the location is equal to the size of this Vector, the object
 is added at the end.


Overrides:
insertElementAt in class Vector


Parameters:
obj - the object to insert in this Vector
index - the index at which to insert the element
See Also:
Vector.addElement(java.lang.Object), 
Vector.size()





remove
public java.lang.Object remove(int index)

Description copied from class: AbstractList
Removes the object at the specified location from this List.


Specified by:
remove in interface List
Overrides:
remove in class Vector


Parameters:
index - the index of the object to remove
Returns:
the removed object





remove
public boolean remove(java.lang.Object o)

Description copied from class: Vector
Removes the first occurrence, starting at the beginning and moving
 towards the end, of the specified object from this Vector.


Specified by:
remove in interface Collection
Specified by:
remove in interface List
Overrides:
remove in class Vector


Parameters:
o - the object to remove from this Vector
Returns:
true if the specified object was found, false otherwise
See Also:
Vector.removeAllElements(), 
Vector.removeElementAt(int), 
Vector.size()





removeAll
public boolean removeAll(Collection c)

Description copied from class: Vector
Removes all occurrences in this Vector of each object in the specified
 Collection.


Specified by:
removeAll in interface Collection
Specified by:
removeAll in interface List
Overrides:
removeAll in class Vector


Parameters:
c - the Collection of objects to remove
Returns:
true if this Vector is modified, false otherwise





removeAllElements
public void removeAllElements()

Description copied from class: Vector
Removes all elements from this Vector, leaving the size zero and the
 capacity unchanged.


Overrides:
removeAllElements in class Vector


See Also:
Vector.isEmpty(), 
Vector.size()





removeElement
public boolean removeElement(java.lang.Object obj)

Description copied from class: Vector
Removes the first occurrence, starting at the beginning and moving
 towards the end, of the specified object from this Vector.


Overrides:
removeElement in class Vector


Parameters:
obj - the object to remove from this Vector
Returns:
true if the specified object was found, false otherwise
See Also:
Vector.removeAllElements(), 
Vector.removeElementAt(int), 
Vector.size()





removeElementAt
public void removeElementAt(int index)

Description copied from class: Vector
Removes the element found at index position location from
 this Vector and decrements the size accordingly.


Overrides:
removeElementAt in class Vector


Parameters:
index - the index of the element to remove
See Also:
Vector.removeElement(java.lang.Object), 
Vector.removeAllElements(), 
Vector.size()





removeRange
protected void removeRange(int fromIndex,
                           int toIndex)

Description copied from class: Vector
Removes the objects in the specified range from the start to the, but not
 including, end index.


Overrides:
removeRange in class Vector


Parameters:
fromIndex - the index at which to start removing
toIndex - the index one past the end of the range to remove





retainAll
public boolean retainAll(Collection c)

Description copied from class: Vector
Removes all objects from this Vector that are not contained in the
 specified Collection.


Specified by:
retainAll in interface Collection
Specified by:
retainAll in interface List
Overrides:
retainAll in class Vector


Parameters:
c - the Collection of objects to retain
Returns:
true if this Vector is modified, false otherwise





set
public java.lang.Object set(int index,
                            java.lang.Object element)

Description copied from class: Vector
Replaces the element at the specified location in this Vector with the
 specified object.


Specified by:
set in interface List
Overrides:
set in class Vector


Parameters:
index - the index at which to put the specified object
element - the object to add to this Vector
Returns:
the previous element at the location
See Also:
Vector.size()





setElementAt
public void setElementAt(java.lang.Object obj,
                         int index)

Description copied from class: Vector
Replaces the element at the specified location in this Vector with the
 specified object.


Overrides:
setElementAt in class Vector


Parameters:
obj - the object to add to this Vector
index - the index at which to put the specified object
See Also:
Vector.size()





getLocaleName
public java.lang.String getLocaleName(LocaleContext locale,
                                      java.lang.String sName)

* return the ViewCriteriaHints interface implemented by this class











getResourcesFromBundle
protected void getResourcesFromBundle(LocaleContext locale,
                                      HashMap map)

Get all resources from the resource bundle. Adopted from
 NamedObjectImpl.getResourcesFromBundle





Parameters:
locale - locale of the resources to be retrieved.
map - the retrieved resources will be added to the map.





getResourcesFromBundle
protected void getResourcesFromBundle(LocaleContext locale,
                                      java.util.Hashtable map)

Get all resources from the resource bundle. Adopted from
 NamedObjectImpl.getResourcesFromBundle





Parameters:
locale - locale of the resources to be retrieved.
map - the retrieved resources will be added to the map.





getProperty
public java.lang.Object getProperty(java.lang.String property,
                                    LocaleContext locale)


Specified by:
getProperty in interface Properties








getProperty
public java.lang.Object getProperty(java.lang.String property)

Description copied from interface: Properties
Retrieves the specified property, if it exists.


Specified by:
getProperty in interface Properties


Parameters:
property - Property name.
Returns:
the value of the property, if any, otherwise null.





refreshProperty
public java.lang.Object refreshProperty(java.lang.String hintName)

Description copied from interface: Properties
Retrieves the specified property, if it exists. If the application running in a 3 tier
 environment, it retrieves the property from the middle-tier server, refreshing the value on
 the client side. If the application is running in a 2 tier environment, it is equivalent to
 getProperty. As there is no notion of a 3-tier environment in ADF-nmc, this
 never has any effect.


Specified by:
refreshProperty in interface Properties


Parameters:
hintName - Property name.
Returns:
the value of the property, if any, otherwise null.





getLocalAndResourceProperties
public java.util.Hashtable getLocalAndResourceProperties()

Used by the marshaller to get all the properties and resources (on the server side only) that
 are defined in this view criteria.

 This method is overriden by ViewCriteriaImpl to return the resource properties as well.






Returns:
A table containing the properties





getProperties
public java.util.Hashtable getProperties()

Description copied from interface: Properties
Gets the table of properties.


Specified by:
getProperties in interface Properties



Returns:
a hashtable of properties.





getProperties
public java.util.Hashtable getProperties(LocaleContext context)











setProperty
public void setProperty(java.lang.String hintName,
                        java.lang.Object hintValue)











removeProperty
public void removeProperty(java.lang.String hintName)











setProperties
public void setProperties(java.util.Hashtable properties)











setVariableManager
public void setVariableManager(VariableValueManager variableManager)











getDisplayName
public final java.lang.String getDisplayName(LocaleContext locale)

Deprecated. 

Retrieves the label to be used in any attribute prompts





Parameters:
locale - 
Returns:
display name for the given locale.





getVoVariableManager
protected VariableManager getVoVariableManager()




















  
      Overview 
      Package 
    Class 
      Tree 
      Deprecated 
      Index 
      Help 
  



Oracle Fusion Middleware Java API Reference for Oracle ADF Mobile Client
11g Release 1 (11.1.1)
E17503-02





 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 







  SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD






Copyright © 2011, Oracle and/or its affiliates. All rights reserved.

oracle.jbo Class ViewCriteria

CLASS_INSTANCE

mProperties

mSavedState

mVariableManager

CRITERIA_MODE_QUERY

CRITERIA_MODE_CACHE

TEMP_VARIABLE

FIND_MODE

listeners

ViewCriteria

ViewCriteria

ViewCriteria

getName

initName

setName

setParent

hasData

setViewCriteriaManager

getClauses

setClauses

criteriaChanged

isDirty

setDirty

isCriteriaForQuery

isCriteriaForRowMatch

setCriteriaForQuery

getCriteriaMode

setCriteriaMode

setAppliedIfJoinSatisfied

isAppliedIfJoinSatisfied

setViewObject

resolve

getViewObject

getViewObject

getRootViewCriteria

getRootCriteriaRelativeName

findViewCriteriaItem

findElementWithRelativeName

isItemHolder

getStructureDef

getStructureDefFullName

setStructureDefFullName

getAttributeIndexOf

getUsedAttributeNames

getUsedViewAttributes

createViewCriteriaRow

createViewCriteriaUsage

getConjunction

setConjunction

isUpperColumns

setUpperColumns

getUpperColumnsValue

useBindVarsOnly

isUseBindVarsOnly

set1013CompatibilityMode

get1013CompatibilityMode

loadVOBindVariables

getAllBindVariables

getAllBindVariables

next

previous

first

last

reset

hasNext

hasPrevious

getFetchedRowCount

getRowCount

getRowAtRangeIndex

getCurrentRow

getCurrentRowIndex

getCurrentRowSlot

setCurrentRow

createAndInitRow

createRow

insertRow

removeCurrentRow

removeCurrentRowFromCollection

removeCurrentRowAndRetain

oracle.jbo
Class ViewCriteria