|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.odi.domain.support.BusinessObject oracle.odi.domain.support.AbstractRepositoryEntity oracle.odi.domain.support.AbstractOdiEntity oracle.odi.domain.model.OdiFilter
public class OdiFilter
An OdiFilter
allows to define data filter relative to an
OdiDataStore
.
Those filters can then be used in OdiInterface
s to restrict the data
in the source data stores or they can be used during static control to
restrict the set of data on which the control is made.
Field Summary | |
---|---|
static int |
NAME_MAX_LENGTH
Maximum length supported for the "name" property. |
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Constructor Summary | |
---|---|
OdiFilter(OdiDataStore pDataStore,
java.lang.String pName)
Construct a new OdiFilter . |
Method Summary | |
---|---|
OdiDataStore |
getDataStore()
Returns the OdiDataStore to which this OdiFilter belongs
and on which the filter applies. |
java.lang.Number |
getFilterId()
Returns the internal ID of this OdiFilter . |
java.io.Serializable |
getInternalId()
Returns the internal ID of this OdiFilter . |
java.lang.String |
getName()
Returns the name of this OdiFilter . |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities. |
Expression |
getWhereClause()
Returns the where clause defining this OdiFilter . |
boolean |
isStaticCheckEnabled()
Returns whether this filter will be applied to restrict the set of data that will be controlled by static check. |
void |
setStaticCheckEnabled(boolean pStaticCheckEnabled)
Defines whether this filter will be applied to restrict the set of data that will be controlled by static check. |
void |
setWhereClause(Expression pClause)
Sets the where clause for this OdiFilter . |
Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isInstanceLevelSecurityNeeded, isNew, toString |
Methods inherited from class oracle.odi.domain.support.BusinessObject |
---|
clone |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.odi.domain.IOdiEntity |
---|
getFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeeded |
Field Detail |
---|
public static final int NAME_MAX_LENGTH
OdiFilter(OdiDataStore, String)
,
Constant Field ValuesConstructor Detail |
---|
public OdiFilter(OdiDataStore pDataStore, java.lang.String pName)
OdiFilter
.
This constructor will also set the parent OdiDataStore
on this
filter.
pDataStore
- the datastore to which this OdiFilter
will belong.pName
- the name of this OdiFilter
oracle.as.scheduler.IllegalArgumentException
- if the pDataStore parameter is null
oracle.as.scheduler.IllegalArgumentException
- if the pName parameter is null or is longer than 128Method Detail |
---|
public OdiDataStore getDataStore()
OdiDataStore
to which this OdiFilter
belongs
and on which the filter applies.
OdiDataStore
public java.lang.Number getFilterId()
OdiFilter
.
public java.io.Serializable getInternalId()
OdiFilter
.
getInternalId
in interface IRepositoryEntity
public java.lang.String getName()
OdiFilter
.
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public Expression getWhereClause()
OdiFilter
.
The where clause defines the
Expression
representing the where clause.setWhereClause(Expression)
public boolean isStaticCheckEnabled()
true
if used during static check, false
otherwisesetStaticCheckEnabled(boolean)
public void setStaticCheckEnabled(boolean pStaticCheckEnabled)
By default, the filter is used during static check.
pStaticCheckEnabled
- true
to use during static check,
false
otherwiseisStaticCheckEnabled()
public void setWhereClause(Expression pClause)
OdiFilter
.
SQL WHERE-type expression defining the filter. This expression must use
the default datastore alias (defined on the OdiDataStore
to which
this filter belongs) before each column. An example of an expression on
the datastore CLIENT with the alias CLI: CLI.TYPE_CLIENT like 'A%'.
pClause
- the where clause that the data have to match to pass the filter.getWhereClause()
,
OdiDataStore.getDefaultAlias()
,
Expression
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |