oracle.odi.interfaces.interactive
Interface IActionHelper

All Known Subinterfaces:

IInteractiveInterfaceHelper, IInteractiveInterfaceHelperWithActions

All Known Implementing Classes:

InteractiveInterfaceHelperWithActions

public interface IActionHelper

This interface provides the generic helper methods for various actions on ODI interface objects.

Since:

11.1.1.3.0

Method Summary

Expression	computeExpression(java.lang.String pSql, IExecutableTextHolder pExecutableTextHolder, OdiInterface.ExecutionLocation pExecutionLocation, DataSet pDataSet) Computes the expression of the SQL text. Note that pDataSet is optional (can be null when pExecutionLocation is TARGET.
TargetMapping	createTargetMapping(DataSet pDataSet, TargetColumn pColumn, OdiInterface.ExecutionLocation pLocation, java.lang.Object pText) For internal use only Create a new target mapping.
IOdiEntityManager	getEntityManager() Return the IOdiEntityManager instance that is used to control object persistence and synchronization for this helper.
IExecutionArea	getExecutionArea(IInterfaceSubComponent pInterfaceSubComponent) Returns the IExecutionArea interface instance that represents the location where the specified interface sub-component will be executed. This is mainly for internal use.
java.util.Collection<IExecutionArea>	getExecutionAreas(DataSet pDataSet) Returns a collection of IExecutionArea instances that represent the locations where all interface sub-components belonging to the specified data set are located.
com.sunopsis.language.SnpsLanguage	getLanguageForTextHolder(IExecutableTextHolder pExecutableTextHolder) Retrieves the language for a specified IExecutableTextHolder object.
ReferenceManagerLookups	getLookupsManager() Returns an IReferenceManager instance that can be used to get lookup references (i.e.
IMappingPersistencePolicy	getMappingPersistencePolicy() Returns the current IMappingPersistencePolicy object that is used to set the persistence policy for the interface mappings and target columns.
com.sunopsis.versioning.SnpsMissingRefsManager	getMissingRefsManager() Returns the missing references manager for this helper.
OdiInstance	getOdiInstance() Returns the current open OdiInstance object on which this interface is persisted.
OdiInterface	getOdiInterface() Returns the interface associated with this helper.
IReferenceManager	getReferenceManagerToDataStoreAttached() Returns an IReferenceManager instance that can be used to get data store references from the interface, for attached data stores. Attached data stores are those data stores that are indirectly associated with an interface object by a reference, for instance via Join.getAttachedDataStore1().
IReferenceManager	getReferenceManagerToDataStoreFull() Returns an IReferenceManager instance that can be used to get data store references from the interface.
IReferenceManager	getReferenceManagerToDataStoreXRefs() Returns an IReferenceManager instance that can be used to get references to SourceDataStores from cross-references in expressions.
IReferenceManager	getReferenceManagerToSourceColumn() Returns an IReferenceManager instance that can be used to get SourceColumn references from cross-references in the interface.
ISourceSetCreator	getSourceSetCreator() Returns the current ISourceSetCreator interface instance object that is used to create the source sets.
ISourceSetNameProvider	getSourceSetNameProvider() Please refer to InteractiveInterfaceHelperWithActions.
void	removeTargetMapping(TargetMapping pMapping) For internal use only Remove the specified target mapping.

Method Detail

computeExpression

Expression computeExpression(java.lang.String pSql,
                             IExecutableTextHolder pExecutableTextHolder,
                             OdiInterface.ExecutionLocation pExecutionLocation,
                             DataSet pDataSet)

Computes the expression of the SQL text.
Note that pDataSet is optional (can be null when pExecutionLocation is TARGET.

Parameters:

pSql - the SQL text string to be computed

pExecutableTextHolder - the executable text holder of which this expression is for

pExecutionLocation - the execution location of which this expression is for

pDataSet - (optional) the data set of which this expression is associated with

Returns:

the Expression object of the computed expression from SQL text

createTargetMapping

TargetMapping createTargetMapping(DataSet pDataSet,
                                  TargetColumn pColumn,
                                  OdiInterface.ExecutionLocation pLocation,
                                  java.lang.Object pText)

For internal use only Create a new target mapping.

Parameters:

pDataSet - the data set of this new target mapping

pColumn - the column of this new target mapping

pLocation - the execution location of this new target mapping

pText - the expression of this new target mapping

Returns:

the TargetMapping object for this new target mapping

getEntityManager

IOdiEntityManager getEntityManager()

Return the IOdiEntityManager instance that is used to control object persistence and synchronization for this helper.

Returns:

the entity manager used to persist this interface

See Also:

getEntityManager()

getExecutionArea

IExecutionArea getExecutionArea(IInterfaceSubComponent pInterfaceSubComponent)
                                throws InexistentMappingException

Returns the IExecutionArea interface instance that represents the location where the specified interface sub-component will be executed.
This is mainly for internal use.

Parameters:

pInterfaceSubComponent - the sub-component

Returns:

the execution area in which this sub-component is located

Throws:

InexistentMappingException - if one LogicalSchema mapping is missing for the current Context

getExecutionAreas

java.util.Collection<IExecutionArea> getExecutionAreas(DataSet pDataSet)
                                                       throws InexistentMappingException

Returns a collection of IExecutionArea instances that represent the locations where all interface sub-components belonging to the specified data set are located.

Parameters:

pDataSet - the data set for which we want the list of execution areas

Returns:

a collection of IExecutionArea which are the execution locations of interface sub-components

Throws:

InexistentMappingException - if one LogicalSchema mapping is missing for the current Context

getLanguageForTextHolder

com.sunopsis.language.SnpsLanguage getLanguageForTextHolder(IExecutableTextHolder pExecutableTextHolder)

Retrieves the language for a specified IExecutableTextHolder object. The text holder contains a particular interface object that uses a language, for example a join or filter object.

Parameters:

pExecutableTextHolder - The executable text holder

Returns:

The language in which this text holder should be computed

getLookupsManager

ReferenceManagerLookups getLookupsManager()

Returns an IReferenceManager instance that can be used to get lookup references (i.e. lookup Join to its attached lookup SourceDataStore and vice-versa).

Returns:

a reference manager that returns lookup references

getMappingPersistencePolicy

IMappingPersistencePolicy getMappingPersistencePolicy()

Returns the current IMappingPersistencePolicy object that is used to set the persistence policy for the interface mappings and target columns.

Returns:

the mapping persistence policy

getMissingRefsManager

com.sunopsis.versioning.SnpsMissingRefsManager getMissingRefsManager()

Returns the missing references manager for this helper. It contains all missing references for all objects of this interface.

Returns:

the SnpsMissingRefsManager object

getOdiInstance

OdiInstance getOdiInstance()

Returns the current open OdiInstance object on which this interface is persisted.

Returns:

the OdiInstance

getOdiInterface

OdiInterface getOdiInterface()

Returns the interface associated with this helper.

Returns:

the interface associated with this helper

getReferenceManagerToDataStoreAttached

IReferenceManager getReferenceManagerToDataStoreAttached()

Returns an IReferenceManager instance that can be used to get data store references from the interface, for attached data stores.
Attached data stores are those data stores that are indirectly associated with an interface object by a reference, for instance via Join.getAttachedDataStore1().

Returns:

a reference manager giving references for attached source datastores

getReferenceManagerToDataStoreFull

IReferenceManager getReferenceManagerToDataStoreFull()

Returns an IReferenceManager instance that can be used to get data store references from the interface. This method returns all data store references, direct and indirect (i.e. it is the union of both cross-references and attached references).

Returns:

a reference manager giving all references to SourceDataStores

getReferenceManagerToDataStoreXRefs

IReferenceManager getReferenceManagerToDataStoreXRefs()

Returns an IReferenceManager instance that can be used to get references to SourceDataStores from cross-references in expressions.

Returns:

an IReferenceManager instance that can be used to get references to SourceDataStores from cross-references in expressions

getReferenceManagerToSourceColumn

IReferenceManager getReferenceManagerToSourceColumn()

Returns an IReferenceManager instance that can be used to get SourceColumn references from cross-references in the interface.

Returns:

a reference manager giving references to SourceColumns

getSourceSetCreator

ISourceSetCreator getSourceSetCreator()

Returns the current ISourceSetCreator interface instance object that is used to create the source sets.

Returns:

the ISourceSetCreator used to create source sets while computing source sets

getSourceSetNameProvider

ISourceSetNameProvider getSourceSetNameProvider()

Please refer to InteractiveInterfaceHelperWithActions.

Returns:

the ISourceSetNameProvider object that is used for generating source set names

See Also:

InteractiveInterfaceHelperWithActions.getSourceSetNameProvider()

removeTargetMapping

void removeTargetMapping(TargetMapping pMapping)

For internal use only Remove the specified target mapping.

Parameters:

pMapping - the target mapping to be removed