|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IActionHelper
This interface provides the generic helper methods for various actions on ODI interface objects.
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
SourceDataStore s 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 |
---|
Expression computeExpression(java.lang.String pSql, IExecutableTextHolder pExecutableTextHolder, OdiInterface.ExecutionLocation pExecutionLocation, DataSet pDataSet)
pDataSet
is optional (can be null
when
pExecutionLocation
is TARGET.
pSql
- the SQL text string to be computedpExecutableTextHolder
- the executable text holder of which this expression is forpExecutionLocation
- the execution location of which this expression is forpDataSet
- (optional) the data set of which this expression is associated with
TargetMapping createTargetMapping(DataSet pDataSet, TargetColumn pColumn, OdiInterface.ExecutionLocation pLocation, java.lang.Object pText)
pDataSet
- the data set of this new target mappingpColumn
- the column of this new target mappingpLocation
- the execution location of this new target mappingpText
- the expression of this new target mapping
IOdiEntityManager getEntityManager()
IOdiEntityManager
instance that is used to control object persistence and
synchronization for this helper.
getEntityManager()
IExecutionArea getExecutionArea(IInterfaceSubComponent pInterfaceSubComponent) throws InexistentMappingException
IExecutionArea
interface instance that represents the location where the
specified interface sub-component will be executed.
pInterfaceSubComponent
- the sub-component
InexistentMappingException
- if one LogicalSchema mapping is missing for the current
Contextjava.util.Collection<IExecutionArea> getExecutionAreas(DataSet pDataSet) throws InexistentMappingException
IExecutionArea
instances that represent the locations where
all interface sub-components belonging to the specified data set are located.
pDataSet
- the data set for which we want the list of execution areas
InexistentMappingException
- if one LogicalSchema mapping is missing for the current
Contextcom.sunopsis.language.SnpsLanguage getLanguageForTextHolder(IExecutableTextHolder pExecutableTextHolder)
IExecutableTextHolder
object. The text
holder contains a particular interface object that uses a language, for example a join or
filter object.
pExecutableTextHolder
- The executable text holder
ReferenceManagerLookups getLookupsManager()
IReferenceManager
instance that can be used to get lookup references (i.e.
lookup Join
to its attached lookup SourceDataStore
and vice-versa).
IMappingPersistencePolicy getMappingPersistencePolicy()
IMappingPersistencePolicy
object that is used to set the
persistence policy for the interface mappings and target columns.
com.sunopsis.versioning.SnpsMissingRefsManager getMissingRefsManager()
OdiInstance getOdiInstance()
OdiInstance
OdiInterface getOdiInterface()
IReferenceManager getReferenceManagerToDataStoreAttached()
IReferenceManager
instance that can be used to get data store references
from the interface, for attached data stores.Join.getAttachedDataStore1()
.
IReferenceManager getReferenceManagerToDataStoreFull()
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).
SourceDataStore
sIReferenceManager getReferenceManagerToDataStoreXRefs()
IReferenceManager
instance that can be used to get references to
SourceDataStore
s from cross-references in expressions.
IReferenceManager
instance that can be used to get references to
SourceDataStore
s from cross-references in expressionsIReferenceManager getReferenceManagerToSourceColumn()
IReferenceManager
instance that can be used to get SourceColumn
references from cross-references in the interface.
SourceColumn
sISourceSetCreator getSourceSetCreator()
ISourceSetCreator
interface instance object that is used to
create the source sets.
ISourceSetCreator
used to create source sets while computing source setsISourceSetNameProvider getSourceSetNameProvider()
InteractiveInterfaceHelperWithActions.getSourceSetNameProvider()
void removeTargetMapping(TargetMapping pMapping)
pMapping
- the target mapping to be removed
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |