oracle.odi.domain.project.interfaces
Class Filter

java.lang.Object
  oracle.odi.domain.support.BusinessObject
      oracle.odi.domain.support.AbstractRepositoryEntity
          oracle.odi.domain.project.interfaces.GenericClause
              oracle.odi.domain.project.interfaces.Filter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRepositoryEntity, IInterfaceSubComponent

public class Filter
extends GenericClause

This class represents a filter in an interface.

Since:

11.1.1.3.0

See Also:

Serialized Form

Nested Class Summary

static class

Filter.FilterType Types of filter for a filter clause.

Constructor Summary

Filter(DataSet pDataSet, java.lang.String pSql, Filter.FilterType pFilterType, OdiInterface.ExecutionLocation pExecutionLocation)
Internal use only Builds a filter clause in the parent dataset using the specified SQL expression text, clause type (normal or journalized) and the desired execution location.

Method Summary

SourceDataStore	getAttachedDataStore() Returns the source data store that this filter is attached to.
Filter.FilterType	getFilterType() Returns the clause type of this filter.
java.lang.String	getSubComponentDescription() Returns the sub component's description in a human-readable way.
java.lang.String	getSubComponentDescription(java.util.Locale pLocale) Returns the sub component's description in a human-readable way for the given Locale.
void	setAttachedDataStore(SourceDataStore pAttachedDataStore) Internal use only Sets the source data store that this filter is attached to.

Methods inherited from class oracle.odi.domain.project.interfaces.GenericClause

getBusinessRule, getClauseId, getClauseOrder, getDataSet, getExecutionLocation, getIndexType1, getIndexType2, getInternalId, getNonPersistedSql, getSecurityContainer, getSourceSet, getSql, getSqlExpression, getSqlExpressionId, getTechnicalDescription, isEnabled, setBusinessRule, setClauseOrder, setEnabled, setExecutionLocation, setIndexType1, setIndexType2, setSourceSet, setSqlExpression

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

public Filter(DataSet pDataSet,
              java.lang.String pSql,
              Filter.FilterType pFilterType,
              OdiInterface.ExecutionLocation pExecutionLocation)

Internal use only Builds a filter clause in the parent dataset using the specified SQL expression text, clause type (normal or journalized) and the desired execution location.

Parameters:

pDataSet - the parent dataset for this filter.

pSql - the SQL expression text for this filter.

pFilterType - the clause type.

pExecutionLocation - the execution location of this filter.

Method Detail

getAttachedDataStore

public SourceDataStore getAttachedDataStore()

Returns the source data store that this filter is attached to.

Returns:

The source data store that this filter is attached to.

See Also:

setAttachedDataStore(oracle.odi.domain.project.interfaces.SourceDataStore)

getFilterType

public Filter.FilterType getFilterType()

Returns the clause type of this filter.

Returns:

the clause type of this clause.

See Also:

setFilterType(oracle.odi.domain.project.interfaces.Filter.FilterType)

getSubComponentDescription

public java.lang.String getSubComponentDescription()

Description copied from interface: IInterfaceSubComponent

Returns the sub component's description in a human-readable way.

Returns:

a human-readable String giving all necessary information to identify this component

getSubComponentDescription

public java.lang.String getSubComponentDescription(java.util.Locale pLocale)

Description copied from interface: IInterfaceSubComponent

Returns the sub component's description in a human-readable way for the given Locale.

Parameters:

pLocale - the Locale for which the description should be returned

Returns:

a human-readable String giving all necessary information to identify this component in the given Locale

setAttachedDataStore

public void setAttachedDataStore(SourceDataStore pAttachedDataStore)

Internal use only Sets the source data store that this filter is attached to.

Parameters:

pAttachedDataStore - The new source data store that this filter is attached to.

See Also:

getAttachedDataStore()