public class OdiFilter extends oracle.odi.domain.support.AbstractOdiEntity implements IWorkDevelopmentOdiEntity, IFilter
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.
Modifier and Type | Field and Description |
---|---|
static int |
NAME_MAX_LENGTH
Maximum length supported for the "name" property.
|
Constructor and Description |
---|
OdiFilter(OdiDataStore pDataStore,
java.lang.String pName)
Construct a new
OdiFilter . |
Modifier and Type | Method and Description |
---|---|
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 . |
java.lang.String |
getWhereClauseString()
Returns the expression text representing the where clause defined on this filter condition.
|
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 . |
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isInstanceLevelSecurityNeeded, isNew, toString
getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor
getFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeeded
getGlobalId
getGlobalId, getNumericId
public static final int NAME_MAX_LENGTH
public OdiFilter(OdiDataStore pDataStore, java.lang.String pName)
OdiFilter
.
This constructor will also set the parent OdiDataStore
on this
filter.
public java.lang.Number getFilterId()
OdiFilter
.public boolean isStaticCheckEnabled()
isStaticCheckEnabled
in interface IFilter
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 java.lang.String getName()
OdiFilter
.getName
in interface IModelObject
getName
in interface IFilter
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public OdiDataStore getDataStore()
OdiDataStore
to which this OdiFilter
belongs
and on which the filter applies.OdiDataStore
public java.io.Serializable getInternalId()
OdiFilter
.getInternalId
in interface IRepositoryEntity
public Expression getWhereClause()
OdiFilter
.
The where clause defines the
Expression
representing the where clause.setWhereClause(Expression)
public java.lang.String getWhereClauseString()
IFilter
getWhereClauseString
in interface IFilter
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