oracle.odi.interfaces.interactive.support
Interface IExecutableTextHolder

All Known Implementing Classes:

ExecutableTextHolderFilter, ExecutableTextHolderGenericClause, ExecutableTextHolderJoin, ExecutableTextHolderTargetColumn, ExecutableTextHolderTargetMapping

public interface IExecutableTextHolder

Classes implementing this interface contain texts that can be executed on a location, thus enabling to access in a generic way any object containing an expression.
It has a Sql Expression and an OdiInterface.ExecutionLocation, some potential attached SourceDataStores, may be located in a DataSet, and may be part of a SourceSet.
The number of attached source datastores depends on the type of the object (target columns have 0, filters and mappings have 1, joins have 2...).
As all implementations have protected constructors, use ExecutableTextHolderFactory to instantiate text holders.

Since:

11.1.1.3.0

See Also:

ExecutableTextHolderFactory

Method Summary

SourceDataStore[]	getAttachedSourceDataStores() Gets the attached source datastores of this TextHolder.
DataSet	getDataSet() Basic getter.
OdiInterface.ExecutionLocation	getExecutionLocation() Basic getter.
IInterfaceSubComponent	getInterfaceSubComponent() Basic getter.
int	getNumberOfDataStores() Gets the number of source datastores.
SourceSet	getSourceSet() Returns the source set in which this TextHolder is located.
java.lang.String	getSql() Gets the String representation of the expression.
Expression	getSqlExpressionForPersistence() Gets the exrpession of this TextHolder as it will be persisted.
java.lang.Number	getSqlExpressionId() Basic getter of the repository ID of the text expression held by this text holder.
Expression	getSqlExpressionInMemory() Gets the expression of this TextHolder as it is in memory.
boolean	isAttachedSourceDataStoreSettable(int pDataStoreNumber) Returns whether it is possible to set this particular datastore number.
void	setAttachedSourceDataStore(int pDataStoreNumber, SourceDataStore pSourceDataStore) Sets one attached SourceDataStore.
void	setSourceSet(SourceSet pSourceSet) Sets the source set in which this TextHolder is located.
void	setSqlExpression(Expression pExpression) Sets the expression on the TextHolder.

Method Detail

getAttachedSourceDataStores

SourceDataStore[] getAttachedSourceDataStores()

Gets the attached source datastores of this TextHolder.

Returns:

the attached datastores

getDataSet

DataSet getDataSet()

Basic getter.

Returns:

the DataSet on which this TextHolder is located. May be null

getExecutionLocation

OdiInterface.ExecutionLocation getExecutionLocation()

Basic getter.

Returns:

the OdiInterface.ExecutionLocation of this textHolder

getInterfaceSubComponent

IInterfaceSubComponent getInterfaceSubComponent()

Basic getter.

Returns:

the underlying IInterfaceSubComponent

getNumberOfDataStores

int getNumberOfDataStores()

Gets the number of source datastores. This should be equal to getAttachedSourceDataStores().length.

Returns:

the number of attached datastores

getSourceSet

SourceSet getSourceSet()

Returns the source set in which this TextHolder is located.

Returns:

The source set in which this textHolder is located. May be null.

See Also:

setSourceSet(SourceSet)

getSql

java.lang.String getSql()

Gets the String representation of the expression.

Returns:

the expression as a String

getSqlExpressionForPersistence

Expression getSqlExpressionForPersistence()

Gets the exrpession of this TextHolder as it will be persisted.

Returns:

the expression as it will be persisted

getSqlExpressionId

java.lang.Number getSqlExpressionId()

Basic getter of the repository ID of the text expression held by this text holder.

Returns:

the ID of the expression held by this text holder

getSqlExpressionInMemory

Expression getSqlExpressionInMemory()

Gets the expression of this TextHolder as it is in memory. The big difference with the persisted one is that some cross references might not exist in the persisted version (journalized columns, language elements...).

Returns:

the expression as it is in memory

isAttachedSourceDataStoreSettable

boolean isAttachedSourceDataStoreSettable(int pDataStoreNumber)

Returns whether it is possible to set this particular datastore number.

Parameters:

pDataStoreNumber - the position of the datastore

Returns:

true if it is possible to call setAttachedSourceDataStore(pDataStoreNumber, aSourceDataStore)

setAttachedSourceDataStore

void setAttachedSourceDataStore(int pDataStoreNumber,
                                SourceDataStore pSourceDataStore)

Sets one attached SourceDataStore. Please make sure that the pDataStoreNumber is settable by using isAttachedSourceDataStoreSettable().

Parameters:

pDataStoreNumber - the number of the attached SourceDataStore to be set

pSourceDataStore - the source datastore to attach

setSourceSet

void setSourceSet(SourceSet pSourceSet)

Sets the source set in which this TextHolder is located.

Parameters:

pSourceSet - the source set to be set

See Also:

getSourceSet()

setSqlExpression

void setSqlExpression(Expression pExpression)

Sets the expression on the TextHolder.

Parameters:

pExpression - the new expression for this TextHolder