oracle.odi.dataservices.fwk

Class QueryFilter

java.lang.Object

oracle.odi.dataservices.fwk.QueryFilter

public class QueryFilter
extends java.lang.Object

A data service parameter used to define filters and ordering when accessing a datastore via a ManagedEntity. This class can be used as an input parameter for a data service method.

Filtering is managed in two ways:

• by using a reference ManagedEntity, for which certain fields are defined. The filter will reject all ManagedEntity objects for which at least one field value does not match the corresponding value defined in the reference ManagedEntity.
• by using an expression in SQL syntax that will be applied in a WHERE clause.

Operations on datastores such as UPDATE, DELETE and SELECT can be applied to a subset of the datastore using such filters.

Ordering the managed entities returned when retrieving information from the datastore is managed through an expression in SQL syntax that will be applied in an ORDER BY clause when reading data from the datastore.

Constructor Summary

Constructors

Constructor and Description
QueryFilter(ManagedEntity pWhereEntity, java.lang.String pAdditionalWhereExpression, java.lang.String pOrderByExpression, java.lang.Integer pMaxRowCount) Constructs a new QueryFilter.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdditionalWhereExpression() Returns the additional WHERE expression, or null if this expression is not set.
java.lang.Integer	getMaxRowCount() Returns the maximum number of rows to retrieve.
java.lang.String	getOrderByExpression() Returns the ORDER BY expression, or null if this expression is not set.
ManagedEntity	getWhereEntity() Returns the reference ManagedEntity used for filtering.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryFilter

public QueryFilter(ManagedEntity pWhereEntity,
                   java.lang.String pAdditionalWhereExpression,
                   java.lang.String pOrderByExpression,
                   java.lang.Integer pMaxRowCount)

Constructs a new QueryFilter.

Parameters:

pWhereEntity - The reference ManagedEntity used for filtering the datastore information.

pAdditionalWhereExpression - SQL Clause for filtering data from the datastore. This clause should not include the WHERE keyword. If it is not specified, the clause will not be generated.

pOrderByExpression - SQL Clause for ordering data from the datastore. This clause should not include the ORDER BY keyword. If it is not specified, the ORDER BY clause will not be generated.

pMaxRowCount - maximum number of rows to retrieve.

Method Detail

getMaxRowCount

public java.lang.Integer getMaxRowCount()

Returns the maximum number of rows to retrieve. This parameter should be used only for SELECT queries.

Returns:

maximum number of rows to retrieve

getOrderByExpression

public java.lang.String getOrderByExpression()

Returns the ORDER BY expression, or null if this expression is not set. This parameter should be used only for SELECT queries.

Returns:

the ORDER BY expression without the ORDER BY keyword.

getAdditionalWhereExpression

public java.lang.String getAdditionalWhereExpression()

Returns the additional WHERE expression, or null if this expression is not set. This parameter should be used only for SELECT queries.

Returns:

the additional WHERE expression without the WHERE keyword.

getWhereEntity

public ManagedEntity getWhereEntity()

Returns the reference ManagedEntity used for filtering.

Returns:

the reference ManagedEntity