oracle.odi.domain.project.interfaces
Class GenericClause

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Filter, Join

public abstract class GenericClause
extends oracle.odi.domain.support.AbstractRepositoryEntity
implements IInterfaceSubComponent

This class represents a generic clause in an interface, which is either a join or a filter. A generic clause has a SQL expression text and can be attached to one or two source data stores. It also defines which location the clause will be executed.

Since:

11.1.1.3.0

See Also:

Join, Filter, OdiInterface.ExecutionLocation, Serialized Form

Constructor Summary

GenericClause(DataSet pDataSet, Expression pSql, OdiInterface.ExecutionLocation pExecutionLocation)
Internal use only Create a new dataset in the specified parent dataset.

GenericClause(DataSet pDataSet, java.lang.String pSql, OdiInterface.ExecutionLocation pExecutionLocation)
Internal use only Create a new dataset in the specified parent dataset.

Method Summary

java.lang.String	getBusinessRule() Returns the business rule description of this clause.
java.lang.Number	getClauseId() Returns the internal ID of this clause.
int	getClauseOrder() Returns the clause order of this clause.
DataSet	getDataSet() Returns the parent dataset of this clause.
OdiInterface.ExecutionLocation	getExecutionLocation() Returns the execution location of this clause.
OdiIndexType	getIndexType1() Returns the temporary index type used for the left side of this clause.
OdiIndexType	getIndexType2() Returns the temporary index type used for the right side of this clause.
java.io.Serializable	getInternalId() The internal ID of this sub component. Returning null from this method will indicate the object has never been persisted in the repository.
Expression	getNonPersistedSql() Returns the SQL expression of this clause.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
SourceSet	getSourceSet() Returns the source set where this clause is executed.
java.lang.String	getSql() Returns the SQL expression text of this clause.
Expression	getSqlExpression() Returns the SQL expression of this clause.
java.lang.Number	getSqlExpressionId() Returns the internal ID of the SQL expression text for this clause.
java.lang.String	getTechnicalDescription() Returns the technical description of the expression text of this clause.
boolean	isEnabled() Returns whether this clause is active and enabled.
void	setBusinessRule(java.lang.String pBusinessRule) Internal use only Set the business rule description of this clause.
void	setClauseOrder(int pClauseOrder) Internal use only Sets the clause order of this clause.
void	setEnabled(boolean pEnabled) Internal use only Sets whether this clause is active and enabled or not.
void	setExecutionLocation(OdiInterface.ExecutionLocation pExecutionLocation) Internal use only Sets the execution location of this clause.
void	setIndexType1(OdiIndexType pIndexType1) Internal use only Set the temporary index type used for the left side of this clause.
void	setIndexType2(OdiIndexType pIndexType2) Internal use only Set the temporary index type used for the right side of this clause.
void	setSourceSet(SourceSet pSourceSet) Internal use only Sets the source set where this clause will be executed.
void	setSqlExpression(Expression pSqlExpression) Internal use only Set the SQL expression for this clause.

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

Methods inherited from interface oracle.odi.domain.project.interfaces.IInterfaceSubComponent

getSubComponentDescription, getSubComponentDescription

Constructor Detail

GenericClause

public GenericClause(DataSet pDataSet,
                     Expression pSql,
                     OdiInterface.ExecutionLocation pExecutionLocation)

Internal use only Create a new dataset in the specified parent dataset.

Parameters:

pDataSet - the dataset in which this generic clause is to be created

pSql - the expression containing the SQL text of the clause

pExecutionLocation - the execution location of the clause

GenericClause

public GenericClause(DataSet pDataSet,
                     java.lang.String pSql,
                     OdiInterface.ExecutionLocation pExecutionLocation)

Internal use only Create a new dataset in the specified parent dataset.

Parameters:

pDataSet - the dataset in which this generic clause is to be created

pSql - the SQL text of the clause

pExecutionLocation - the execution location of the clause

Method Detail

getBusinessRule

public java.lang.String getBusinessRule()

Returns the business rule description of this clause.

Returns:

the business rule description of this clause

See Also:

setBusinessRule(String)

getClauseId

public java.lang.Number getClauseId()

Returns the internal ID of this clause.

Returns:

the internal ID of this clause.

getClauseOrder

public int getClauseOrder()

Returns the clause order of this clause. This is used in specifying the ISO join order of an ordered join clause.

Returns:

the clause order of this clause

See Also:

setClauseOrder(int)

getDataSet

public DataSet getDataSet()

Returns the parent dataset of this clause.

Returns:

the parent dataset of this clause.

See Also:

setDataSet(oracle.odi.domain.project.interfaces.DataSet)

getExecutionLocation

public OdiInterface.ExecutionLocation getExecutionLocation()

Returns the execution location of this clause.

Returns:

the execution location of this clause

See Also:

setExecutionLocation(OdiInterface.ExecutionLocation)

getIndexType1

public OdiIndexType getIndexType1()

Returns the temporary index type used for the left side of this clause.

Returns:

The temporary index type used for the left side of this clause.

See Also:

setIndexType1(OdiIndexType)

getIndexType2

public OdiIndexType getIndexType2()

Returns the temporary index type used for the right side of this clause.

Returns:

The temporary index type used for the right side of this clause.

See Also:

setIndexType2(OdiIndexType)

getInternalId

public java.io.Serializable getInternalId()

Description copied from interface: IInterfaceSubComponent

The internal ID of this sub component.
Returning null from this method will indicate the object has never been persisted in the repository.

Specified by:

getInternalId in interface IRepositoryEntity

Specified by:

getInternalId in interface IInterfaceSubComponent

Returns:

the persistence identity of this instance

getNonPersistedSql

public Expression getNonPersistedSql()

Returns the SQL expression of this clause. If a new SQL expression object is set to this clause using setSqlExpression(Expression), the same Expression object will be returned instead.

Returns:

The SQL expression of this clause.

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

getSourceSet

public SourceSet getSourceSet()

Returns the source set where this clause is executed.

Returns:

the source set where this clause is executed. If null, this clause is executed in the staging area.

See Also:

setSourceSet(SourceSet)

getSql

public java.lang.String getSql()

Returns the SQL expression text of this clause.

Returns:

The SQL expression text of this clause.

getSqlExpression

public Expression getSqlExpression()

Returns the SQL expression of this clause.

Returns:

The SQL expression of this clause.

See Also:

setSqlExpression(Expression)

getSqlExpressionId

public java.lang.Number getSqlExpressionId()

Returns the internal ID of the SQL expression text for this clause.

Returns:

The internal ID of the SQL expression text for this clause.

getTechnicalDescription

public java.lang.String getTechnicalDescription()

Returns the technical description of the expression text of this clause.

Returns:

The technical description of the expressoin text of this clause.

isEnabled

public boolean isEnabled()

Returns whether this clause is active and enabled. A clause is enabled if it is included during interface generation.

Returns:

true if the clause is active and enabled.

See Also:

setEnabled(boolean)

setBusinessRule

public void setBusinessRule(java.lang.String pBusinessRule)

Internal use only Set the business rule description of this clause.

Parameters:

pBusinessRule - the new description of this clause.

See Also:

getBusinessRule()

setClauseOrder

public void setClauseOrder(int pClauseOrder)

Internal use only Sets the clause order of this clause.

Parameters:

pClauseOrder - the new clause order of the clause

See Also:

getClauseOrder()

setEnabled

public void setEnabled(boolean pEnabled)

Internal use only Sets whether this clause is active and enabled or not.

Parameters:

pEnabled - true to enable this clause, false to disable this clause

See Also:

isEnabled()

setExecutionLocation

public void setExecutionLocation(OdiInterface.ExecutionLocation pExecutionLocation)

Internal use only Sets the execution location of this clause.

Parameters:

pExecutionLocation - the new execution location of this clause.

Throws:

java.lang.IllegalArgumentException - if the new execution location is null or OdiInterface.ExecutionLocation.TARGET

See Also:

getExecutionLocation()

setIndexType1

public void setIndexType1(OdiIndexType pIndexType1)

Internal use only Set the temporary index type used for the left side of this clause.

Parameters:

pIndexType1 - The temporary index type used for the left side of this clause.

See Also:

getIndexType1()

setIndexType2

public void setIndexType2(OdiIndexType pIndexType2)

Internal use only Set the temporary index type used for the right side of this clause.

Parameters:

pIndexType2 - The temporary index type used for the right side of this clause.

See Also:

getIndexType2()

setSourceSet

public void setSourceSet(SourceSet pSourceSet)

Internal use only Sets the source set where this clause will be executed.

Parameters:

pSourceSet - the source set where this clause will be executed. null if this clause is to be executed in the staging area.

See Also:

getSourceSet()

setSqlExpression

public void setSqlExpression(Expression pSqlExpression)

Internal use only Set the SQL expression for this clause.

Parameters:

pSqlExpression - The new SQL expression for this clause.

See Also:

getSqlExpression()