Skip navigation links

oracle.odi.domain.model
Class OdiFilter

java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.support.AbstractOdiEntity
oracle.odi.domain.model.OdiFilter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity

public class OdiFilter

extends oracle.odi.domain.support.AbstractOdiEntity

implements IWorkDevelopmentOdiEntity

An OdiFilter allows to define data filter relative to an OdiDataStore.

Those filters can then be used in OdiInterfaces 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.

Since:

11.1.1.3.0

See Also:

Serialized Form

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

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

Maximum length supported for the "name" property.

See Also:

OdiFilter(OdiDataStore, String), Constant Field Values

Constructor Detail

OdiFilter

public OdiFilter(OdiDataStore pDataStore,
                 java.lang.String pName)

Construct a new OdiFilter.

This constructor will also set the parent OdiDataStore on this filter.

Parameters:

pDataStore - the datastore to which this OdiFilter will belong.

pName - the name of this OdiFilter

Throws:

DomainRuntimeException - if the pDataStore parameter is null

DomainRuntimeException - if the pName parameter is null or is longer than 128

Method Detail

getFilterId

public java.lang.Number getFilterId()

Returns the internal ID of this OdiFilter.

Returns:

the internal ID.

isStaticCheckEnabled

public boolean isStaticCheckEnabled()

Returns whether this filter will be applied to restrict the set of data that will be controlled by static check.

Returns:

true if used during static check, false otherwise

See Also:

setStaticCheckEnabled(boolean)

setStaticCheckEnabled

public void setStaticCheckEnabled(boolean pStaticCheckEnabled)

Defines whether this filter will be applied to restrict the set of data that will be controlled by static check.

By default, the filter is used during static check.

Parameters:

pStaticCheckEnabled - true to use during static check, false otherwise

See Also:

isStaticCheckEnabled()

getName

public java.lang.String getName()

Returns the name of this OdiFilter.

Specified by:

getName in interface IOdiEntity

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

the name.

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Specified by:

getSecurityContainer in interface IRepositoryEntity

Returns:

container entity

getDataStore

public OdiDataStore getDataStore()

Returns the OdiDataStore to which this OdiFilter belongs and on which the filter applies.

Returns:

an OdiDataStore

getInternalId

public java.io.Serializable getInternalId()

Returns the internal ID of this OdiFilter.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the internal ID.

getWhereClause

public Expression getWhereClause()

Returns the where clause defining this OdiFilter.

The where clause defines the

Returns:

an Expression representing the where clause.

See Also:

setWhereClause(Expression)

setWhereClause

public void setWhereClause(Expression pClause)

Sets the where clause for this 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%'.

Parameters:

pClause - the where clause that the data have to match to pass the filter.

See Also:

getWhereClause(), OdiDataStore.getDefaultAlias(), Expression

Skip navigation links