|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.7.0) E17060-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.odi.interfaces.interactive.support.InteractiveInterfaceHelperWithActions
public class InteractiveInterfaceHelperWithActions
InterfaceInterfaceHelperWithActions is a helper class that works in conjunction with the interactive interface action classes found in package oracle.odi.interfaces.interactive.support.actions
in order to create or modify the ODI interface objects that define the execution behavior of the interface. The objects that can be created or modified include sources, targets, mappings, filter, joins, and other clauses that define an ETL operation.
General Concepts: The general usage of the interactive interface helper and action classes is as follows: First create instance of this interface helper class. Then create an action class by calling it's constructor. Then call this helper's performAction
method with a reference to the action class as one of the calling parameters.
Performing the action: Though the action classes themselves have a performAction
method, it is for internal use only. The creation or modification action should be performed using the performAction
method in this helper class. Here is an example of creating a join object between two sources:
InteractiveInterfaceHelperWithActions interactiveHelper = new InteractiveInterfaceHelperWithActions(odiInterface, myOdiInstance, myOdiInstance.getTransactionalEntityManager(), new SourceSetComputerEraser(odiInterface), new SourceSetCreatorNew(), new SourceSetNameProviderBasicIncrement(), new MappingPersistencePolicyDefault());
InterfaceActionAddJoin addJoinAction = new InterfaceActionAddJoin(myDataSet, mySQLJoinCondition, OdiInterface.ExecutionLocation.SOURCE);
interactiveHelper.performAction(addJoinAction);
Expression Strings: Many of the action class constructors require an expression string as a calling parameter. The expression strings may refer to objects that can be used in the interface, such as source table columns, variables, sequences, etc.
When referring to source table columns in an expression string, the source table alias must be used. For example, if two join sources EMP and DEPT have aliases "EMP_ALIAS" and "DEPT_ALIAS", then the passed-in SQL join condition string might be "EMP_ALIAS.DEPTNO = DEPT_ALIAS.DEPTNO".
A reliable way to create the join condition string is to create an Expression
object by calling ExpressionStringBuilder
class methods, then call method getAsString
on the resultant Expression
object. Here is an example of creating the expression string "<mySrcDataStore1_alias>.DEPT_ID = <mySrcDataStore2_alias>.DEPT_ID":
ExpressionStringBuilder stringBuilder = new ExpressionStringBuilder(getLanguageProvider().getSnpsLanguageByTechnologyName(mySourceDataStore1.getModel().getTechnology().getInternalName()));
stringBuilder.append(mySourceDataStore1.getColumn("DEPT_ID"), mySourceDataStore1.getDefaultAlias()).append("=").append(mySourceDataStore2.getColumn("DEPT_ID"), mySourceDataStore2.getDefaultAlias());
Expression myExpression = stringBuilder.toExpression();
String mySQLJoinCondition = myExpression.getAsString();
The advantage of creating it this way is that the actual string values of the data store aliases and columns do not need to be known when the code is written, and the code will remain accurate even if the alias names are later changed.
Reverse Actions: Most action classes will call an undo listener to add a reverse or undo action that can be performed to undo the action itself.
Auto-fix manager: This helper can contain an instance of the <@link IAutoFixManager> interface. Depending on the functionality of the particular auto-fix manager implementation, it may cause problems or issues to be automatically fixed after an action is performed.
Source Set Computer/Creator: This helper also contains a ISourceSetComputer
and a ISourceSetCreator
interface instance object. Each interface contains a set of SourceSet
objects, which group the executable objects (e.g. joins and mappings) according to their execution location. The source sets must be created according to some strategy, after the interface objects have all been added. For the SDK, the source set computer and creator do this work. The source set computer determines the strategy for creating source sets based on the interface objects, settings, and KMs. The source set creator actually creates each source set, and is called by the source set computer. A common source set computer implementation that can be used for many generic cases is SourceSetComputerRetainer
. The source set computer and creator implementation instance can be passed to the helper in it's constructor.
Retrieving the created object: When an action is performed that creates a new object, for example InterfaceActionAddFilter
, then it may be useful at some point to retrieve a reference to the newly created object or objects. The <@link IImpacts> interface instance that is returned from the performAction
call can be used to retrieve the object. Here is a sample method that could be used to retrieve the objects.
protected <T extends IInterfaceSubComponent> T findAddedObject(IImpacts impacts, Class<T> clazz) { for (InterfaceObjectModification modif : impacts.getModifications()) if (clazz.isInstance(modif.getModifiedObject()) && modif.getModification().equals(InterfaceObjectModification.Modification.OBJECT_ADDED)) return (T) modif.getModifiedObject(); System.out.println("Could not find new object of type " + clazz.getName()); return null; }
The key to this method is the use of the getModifiedObject()
in the IImpacts
interface.
Field Summary | |
---|---|
static java.util.logging.Logger |
JAVA_LOGGER |
Constructor Summary | |
---|---|
InteractiveInterfaceHelperWithActions(OdiInterface pInterface, OdiInstance pOdiInstance, IOdiEntityManager pOdiEntityManager) Constructor for this helper class, that takes an entity manager instance reference. |
|
InteractiveInterfaceHelperWithActions(OdiInterface pInterface, OdiInstance pOdiInstance, IOdiEntityManager pOdiEntityManager, IInterfaceActionListener pActionListenerForChangesAtOpenTime) Constructor for this helper class, that takes an entity manager and an action listener interface instance reference. |
|
InteractiveInterfaceHelperWithActions(OdiInterface pInterface, OdiInstance pOdiInstance, IOdiEntityManager pOdiEntityManager, ISourceSetComputer pSourceSetComputer, ISourceSetCreator pSourceSetCreator, ISourceSetNameProvider pSourceSetNameProvider, IMappingPersistencePolicy pMappingPersistencePolicy) Constructor for this helper class, that takes an entity manager and an action listener interface instance reference. |
|
InteractiveInterfaceHelperWithActions(OdiInterface pInterface, OdiInstance pOdiInstance, IOdiEntityManager pOdiEntityManager, ISourceSetComputer pSourceSetComputer, ISourceSetCreator pSourceSetCreator, ISourceSetNameProvider pSourceSetNameProvider, IMappingPersistencePolicy pMappingPersistencePolicy, IAutoFixManager pAutoFixManager) Constructor for this helper class, that allows more specialized creator and provider classes to be specified. |
|
InteractiveInterfaceHelperWithActions(OdiInterface pInterface, OdiInstance pOdiInstance, IOdiEntityManager pOdiEntityManager, ISourceSetComputer pSourceSetComputer, ISourceSetCreator pSourceSetCreator, ISourceSetNameProvider pSourceSetNameProvider, IMappingPersistencePolicy pMappingPersistencePolicy, IAutoFixManager pAutoFixManager, IInterfaceActionListener pActionListenerForChangesAtOpenTime) Constructor for this helper class, that allows more specialized creator and provider classes to be specified. |
|
InteractiveInterfaceHelperWithActions(OdiInterface pInterface, OdiInstance pOdiInstance, IOdiEntityManager pOdiEntityManager, ISourceSetComputer pSourceSetComputer, ISourceSetCreator pSourceSetCreator, ISourceSetNameProvider pSourceSetNameProvider, IMappingPersistencePolicy pMappingPersistencePolicy, IAutoFixManager pAutoFixManager, IInterfaceActionListener pActionListenerForChangesAtOpenTime, boolean pGarbagedDestroyedObject) A detailed constructor for this helper class, allowing for many specialized settings. |
Method Summary | |
---|---|
boolean |
areSourceSetsDirty() Returns true if the source sets should be recomputed. |
static boolean |
checkAcceptsKMTechnologies(OdiKM<?> pOdiKM, java.lang.Boolean pMultiConnection, OdiTechnology pSourceTechnology, OdiTechnology pTargetTechnology) Returns true if the specified KM supports the given source and target technology, and multiple connection setting. |
static void |
checkSubInterfaceValid(OdiInterface pSubInterface) A static method to check for validity of a sub-interface. |
static OdiKM<?> |
chooseKM(OdiTechnology pSourceTechnology, OdiTechnology pDestinationTechnology, java.util.Collection<? extends OdiKM> pKMs) Deprecated. Use chooseKM(String pProjectCode, final IOdiEntityManager pEntityManager, final OdiTechnology pSourceTechnology, final OdiTechnology pDestinationTechnology, Class pKMClass, boolean pMultiConnexion) instead |
static OdiKM<?> |
chooseKM(OdiTechnology pSourceTechnology, OdiTechnology pDestinationTechnology, java.util.Collection<? extends OdiKM> pKMs, boolean pToFilter, java.lang.Boolean pMultiConnexion) Deprecated. Use chooseKM(String pProjectCode, final IOdiEntityManager pEntityManager, final OdiTechnology pSourceTechnology, final OdiTechnology pDestinationTechnology, Class pKMClass, boolean pMultiConnexion) instead |
static OdiKM<?> |
chooseKM(java.lang.String pProjectCode, IOdiEntityManager pEntityManager, OdiTechnology pSourceTechnology, OdiTechnology pDestinationTechnology, java.lang.Class pKMClass, boolean pMultiConnexion) A static method used to pick a KM from among the available KMs. |
static OdiInterface.ExecutionLocation |
computeExecutionLocationForDatastores(SourceDataStore pSrcDataStore1, SourceDataStore pSrcDataStore2) For internal use only Computes the default exection location of an expression between two specfied data stores. |
Expression |
computeExpression(java.lang.String pSql, IExecutableTextHolder pExecutableTextHolder, OdiInterface.ExecutionLocation pExecutionLocation, DataSet pDataSet) For internal use only Computes the expression object of the specified SQL expression text for the given text holder in the desired data set and execution location. |
Expression |
computeExpression(java.lang.String pSql, OdiInterface.ExecutionLocation pExecutionLocation, DataSet pDataSet, IExpressionContext pExpressionContext) This method computes an expression from a Sql text that would be executed on a DataSet and in the specified Location. |
IImpacts |
computeSourceSets() Recomputes the SourceSet objects for the associated interface.Should be called at some point after source data stores are added to or removed from the interface, or some mappings/joins/filters have been added or had their locations changed, to create the correct source sets. Typically called before setting the KMs for the interface source set, or before calling preparePersist .The current source set computer (which can be passed to the constructor for this helper instance) will be used to compute the source sets. To know whether you should call this method, use areSourceSetsDirty() . |
TargetMapping |
createTargetMapping(DataSet pDataSet, TargetColumn pColumn, OdiInterface.ExecutionLocation pLocation, java.lang.Object pText) For internal use only Create a new target mapping. |
java.util.Collection<IInterfaceIssue> |
getAllCurrentIssues() Returns the current set of IInterfaceIssue objects associated with the interface. |
ContextManager |
getContextManager() Returns the context manager for this helper. |
java.util.Collection<IInterfaceIssue> |
getCurrentIssues(IInterfaceSubComponent pSubComponent) Returns the current set of IInterfaceIssue objects that are associated with the specified sub-component. |
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. |
static com.sunopsis.language.SnpsLanguage |
getLanguageForTechnology(OdiTechnology pTechnology, OdiInstance pOdiInstance) A static convenience method to retrieve the SnpsLanguage object that is associated with the given technology. |
com.sunopsis.language.SnpsLanguage |
getLanguageForTextHolder(IExecutableTextHolder pExecutableTextHolder) Retrieves the language for a specified IExecutableTextHolder object. |
static OdiLogicalSchema |
getLogicalSchemaForTextHolder(OdiInterface pOdiInterface, IExecutableTextHolder pExecutableTextHolder) A static convenience method to retrieve the logical schema associated with the specified text holder. |
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 used to retrieve languages and global objects (Variables, Sequence, User functions). |
OdiInterface |
getOdiInterface() Returns the interface associated with this helper. |
static OdiPhysicalSchema |
getPhysicalSchema(OdiLogicalSchema pLogicalSchema, OdiContext pContext) A static convenience method to return the associated physical schema for the specified logical schema, in the specified context. |
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() .This implementation returns an instance of ReferenceManagerLightDataStores . |
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.This implementation returns an instance of ReferenceManagerHeavyDataStores . |
IReferenceManager |
getReferenceManagerToSourceColumn() Returns an IReferenceManager instance that can be used to get SourceColumn references from cross-references in the interface.This implementation returns an instance of ReferenceManagerLookups . |
static OdiPhysicalSchema |
getSourceDataStorePhysicalSchema(SourceDataStore pSourceDataStore) A static convenience method to retrieve the physical schema associated with the specified source data store. |
ISourceSetCreator |
getSourceSetCreator() Returns the current ISourceSetCreator interface instance object that is used to create the source sets. |
ISourceSetNameProvider |
getSourceSetNameProvider() Returns the current ISourceSetNameProvider interface instance object that is used to generate source set names. |
static OdiPhysicalSchema |
getStagingAreaPhysicalSchema(OdiInterface pInterface) A static convenience method to get the staging area physical schema for the specified interface. |
static OdiPhysicalSchema |
getTargetDataStorePhysicalSchema(OdiInterface pInterface) A static convenience method to get the target datastore's physical schema for the specified interface. |
static boolean |
isNativeSequenceInDerivedSelect(IInterfaceSubComponent pJoin) used to check whether a derived sub-interfaces includes a native sequence or not |
IImpacts |
performAction(IInterfaceAction pAction) Performs the specified action, using the default autofix manager that was provided when creating this InteractiveInterfaceHelperWithActions . |
IImpacts |
performAction(IInterfaceAction pAction, IAutoFixManager pAutoFixManager) Performs the specified action, and uses the specified auto fix manager to do automatic fixing of interface issues. |
void |
performRefreshDataStores() Refresh TargetDataStore and SourceDataStore, according to update done on the underlying datastore. |
void |
preparePersist() Called to inform the ODI persistence layer that this interface will be persisted. |
void |
refreshCrossReferences() For internal use only Refresh the context manager for global and project references, and recompute all cross references. |
void |
removeTargetMapping(TargetMapping pMapping) For internal use only Remove the specified targe tmapping. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.util.logging.Logger JAVA_LOGGER
Constructor Detail |
---|
public InteractiveInterfaceHelperWithActions(OdiInterface pInterface, OdiInstance pOdiInstance, IOdiEntityManager pOdiEntityManager)
pInterface
- The interface that the helper will modify.pOdiInstance
- Reference to the ODI instance that is currently open.pOdiEntityManager
- The entity manager that will be used to manage persistence.public InteractiveInterfaceHelperWithActions(OdiInterface pInterface, OdiInstance pOdiInstance, IOdiEntityManager pOdiEntityManager, IInterfaceActionListener pActionListenerForChangesAtOpenTime)
pInterface
- The interface that the helper will modify.pOdiInstance
- Reference to the ODI instance that is currently open.pOdiEntityManager
- The entity manager that will be used to manage persistence.pActionListenerForChangesAtOpenTime
- An action listener instance that will be notified of interface changes.public InteractiveInterfaceHelperWithActions(OdiInterface pInterface, OdiInstance pOdiInstance, IOdiEntityManager pOdiEntityManager, ISourceSetComputer pSourceSetComputer, ISourceSetCreator pSourceSetCreator, ISourceSetNameProvider pSourceSetNameProvider, IMappingPersistencePolicy pMappingPersistencePolicy)
pInterface
- The interface that the helper will modify.pOdiInstance
- Reference to the ODI instance that is currently open.pOdiEntityManager
- The entity manager that will be used to manage persistence.pSourceSetComputer
- The source set computer used to recompute the SourceSet
object for the interface.pSourceSetCreator
- The source set creator used to create the SourceSet
object for the interface.pSourceSetNameProvider
- The source set name provider used to generate source set names for the interface.pMappingPersistencePolicy
- The mapping persistence policy interface instance used to determine the persistence policy.public InteractiveInterfaceHelperWithActions(OdiInterface pInterface, OdiInstance pOdiInstance, IOdiEntityManager pOdiEntityManager, ISourceSetComputer pSourceSetComputer, ISourceSetCreator pSourceSetCreator, ISourceSetNameProvider pSourceSetNameProvider, IMappingPersistencePolicy pMappingPersistencePolicy, IAutoFixManager pAutoFixManager)
pInterface
- The interface that the helper will modify.pOdiInstance
- Reference to the ODI instance that is currently open.pOdiEntityManager
- The entity manager that will be used to manage persistence.pSourceSetComputer
- The source set computer used to recompute the SourceSet
object for the interface.pSourceSetCreator
- The source set creator used to create the SourceSet
object for the interface.pSourceSetNameProvider
- The source set name provider used to generate source set names for the interface.pMappingPersistencePolicy
- Reference to an object which specifies persistence policy for the interface.pAutoFixManager
- Reference to an object which calculates and performs automated fixes for issues in the interface.public InteractiveInterfaceHelperWithActions(OdiInterface pInterface, OdiInstance pOdiInstance, IOdiEntityManager pOdiEntityManager, ISourceSetComputer pSourceSetComputer, ISourceSetCreator pSourceSetCreator, ISourceSetNameProvider pSourceSetNameProvider, IMappingPersistencePolicy pMappingPersistencePolicy, IAutoFixManager pAutoFixManager, IInterfaceActionListener pActionListenerForChangesAtOpenTime)
pInterface
- The interface that the helper will modify.pOdiInstance
- Reference to the ODI instance that is currently open.pOdiEntityManager
- The entity manager that will be used to manage persistence.pSourceSetComputer
- The source set computer used to recompute the SourceSet
object for the interface.pSourceSetCreator
- The source set creator used to create the SourceSet
object for the interface.pSourceSetNameProvider
- The source set name provider used to generate source set names for the interface.pMappingPersistencePolicy
- Reference to an object which specifies persistence policy for the interface.pAutoFixManager
- Reference to an object which calculates and performs automated fixes for issues in the interface.pActionListenerForChangesAtOpenTime
- An action listener instance that will be notified of interface changes.public InteractiveInterfaceHelperWithActions(OdiInterface pInterface, OdiInstance pOdiInstance, IOdiEntityManager pOdiEntityManager, ISourceSetComputer pSourceSetComputer, ISourceSetCreator pSourceSetCreator, ISourceSetNameProvider pSourceSetNameProvider, IMappingPersistencePolicy pMappingPersistencePolicy, IAutoFixManager pAutoFixManager, IInterfaceActionListener pActionListenerForChangesAtOpenTime, boolean pGarbagedDestroyedObject)
pInterface
- The interface that the helper will modify.pOdiInstance
- Reference to the ODI instance that is currently open.pOdiEntityManager
- The entity manager that will be used to manage persistence.pSourceSetComputer
- The source set computer used to recompute the SourceSet
object for the interface.pSourceSetCreator
- The source set creator used to create the SourceSet
object for the interface.pSourceSetNameProvider
- The source set name provider used to generate source set names for the interface.pMappingPersistencePolicy
- Reference to an object which specifies persistence policy for the interface.pAutoFixManager
- Reference to an object which calculates and performs automated fixes for issues in the interface.pActionListenerForChangesAtOpenTime
- An action listener instance that will be notified of interface changes.pGarbagedDestroyedObject
- Unused.Method Detail |
---|
public static boolean checkAcceptsKMTechnologies(OdiKM<?> pOdiKM, java.lang.Boolean pMultiConnection, OdiTechnology pSourceTechnology, OdiTechnology pTargetTechnology)
true
if the specified KM supports the given source and target technology, and multiple connection setting.pOdiKM
- The KM to checkpMultiConnection
- The multiple connections allowed settingpSourceTechnology
- The source technologypTargetTechnology
- The target technologytrue
if the KM is suitable for the corresponding source and target technologies, false
otherwisepublic IImpacts performAction(IInterfaceAction pAction) throws UnknownActionException
InteractiveInterfaceHelperWithActions
.performAction
in interface IInteractiveInterfaceHelperWithActions
pAction
- The action interface instance to perform.VetoActionException
- if the action couldn't be performedUnknownActionException
- this implementation doesn't throw this exception which can be safely caughtpublic IImpacts performAction(IInterfaceAction pAction, IAutoFixManager pAutoFixManager) throws UnknownActionException
performAction
in interface IInteractiveInterfaceHelperWithActions
pAction
- The action interface instance to perform.pAutoFixManager
- The auto-fix manager instance used to fix issues.VetoActionException
- if the action couldn't be performedUnknownActionException
- this implementation doesn't throw this exception which can be safely caughtpublic Expression computeExpression(java.lang.String pSql, IExecutableTextHolder pExecutableTextHolder, OdiInterface.ExecutionLocation pExecutionLocation, DataSet pDataSet)
computeExpression
in interface IActionHelper
pSql
- the SQL expression textpExecutableTextHolder
- the text holder to contain this expressionpExecutionLocation
- the execution location for the expressionpDataSet
- the parent data set for this expressionpublic Expression computeExpression(java.lang.String pSql, OdiInterface.ExecutionLocation pExecutionLocation, DataSet pDataSet, IExpressionContext pExpressionContext)
pSql
- the text for which we want to compute cross-referencespExecutionLocation
- the location on which this text would be executedpDataSet
- the dataset in which the text will be addedpExpressionContext
- an additional expression contextpublic void refreshCrossReferences()
public static OdiPhysicalSchema getPhysicalSchema(OdiLogicalSchema pLogicalSchema, OdiContext pContext) throws InexistentMappingException
pLogicalSchema
- The logical schema, or null if no association is defined.pContext
- The context to use when finding the associated logical schema.InexistentMappingException
public static OdiPhysicalSchema getStagingAreaPhysicalSchema(OdiInterface pInterface) throws InexistentMappingException
pInterface
- the interfaceInexistentMappingException
public static OdiPhysicalSchema getTargetDataStorePhysicalSchema(OdiInterface pInterface) throws InexistentMappingException
pInterface
- the interfaceInexistentMappingException
- if the LogicalSchema and Context on the TargetDataStore do not point to any PhysicalSchemapublic static OdiPhysicalSchema getSourceDataStorePhysicalSchema(SourceDataStore pSourceDataStore) throws InexistentMappingException
pSourceDataStore
- the source data storeInexistentMappingException
public static OdiLogicalSchema getLogicalSchemaForTextHolder(OdiInterface pOdiInterface, IExecutableTextHolder pExecutableTextHolder)
pOdiInterface
- the interfacepExecutableTextHolder
- the text holder to retrieve its logical schemapublic static void checkSubInterfaceValid(OdiInterface pSubInterface) throws InvalidSubInterfaceException
pSubInterface
- the interfaceInvalidSubInterfaceException
- Throws this exception if the sub-interface is not valid.public static boolean isNativeSequenceInDerivedSelect(IInterfaceSubComponent pJoin)
pJoin
-public IImpacts computeSourceSets() throws InexistentMappingException
SourceSet
objects for the associated interface.preparePersist
.areSourceSetsDirty()
.computeSourceSets
in interface IInteractiveInterfaceHelper
InexistentMappingException
- if some LogicalSchemas have no mapping for the current Contextpublic java.util.Collection<IInterfaceIssue> getAllCurrentIssues()
IInterfaceIssue
objects associated with the interface. Calling this method may cause the issues to be computed, depending on whether it has already been called since the last changes were made to the interface.getAllCurrentIssues
in interface IInteractiveInterfaceHelper
public OdiInterface getOdiInterface()
getOdiInterface
in interface IActionHelper
getOdiInterface
in interface IInteractiveInterfaceHelper
public java.util.Collection<IInterfaceIssue> getCurrentIssues(IInterfaceSubComponent pSubComponent)
IInterfaceIssue
objects that are associated with the specified sub-component. Calling this method may cause the issues to be computed, depending on whether they have already been computed since the last change.getCurrentIssues
in interface IInteractiveInterfaceHelper
pSubComponent
- The sub-component of the interface for which to retrieve issuespublic void preparePersist() throws OdiInterfaceNotReadyForPersistException
ComputeSourceSets
method should be called at some point before preparePersist
is called.preparePersist
in interface IInteractiveInterfaceHelper
OdiInterfaceNotReadyForPersistException
- if the interface is not ready to be persistedpublic boolean areSourceSetsDirty()
areSourceSetsDirty
in interface IInteractiveInterfaceHelper
true
if the method computeSourceSets()
should be calledpublic IReferenceManager getReferenceManagerToDataStoreXRefs()
IReferenceManager
instance that can be used to get references to SourceDataStore
s from cross-references in expressions.ReferenceManagerHeavyDataStores
.getReferenceManagerToDataStoreXRefs
in interface IActionHelper
IReferenceManager
instance that can be used to get references to SourceDataStore
s from cross-references in expressionspublic IReferenceManager getReferenceManagerToDataStoreAttached()
IReferenceManager
instance that can be used to get data store references from the interface, for attached data stores.Join.getAttachedDataStore1()
.ReferenceManagerLightDataStores
.getReferenceManagerToDataStoreAttached
in interface IActionHelper
public IReferenceManager getReferenceManagerToSourceColumn()
IReferenceManager
instance that can be used to get SourceColumn
references from cross-references in the interface.ReferenceManagerLookups
.getReferenceManagerToSourceColumn
in interface IActionHelper
SourceColumn
spublic 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).ReferenceManagerToDataStoresFull
.getReferenceManagerToDataStoreFull
in interface IActionHelper
SourceDataStore
spublic ReferenceManagerLookups getLookupsManager()
IReferenceManager
instance that can be used to get lookup references (i.e. lookup Join
to its attached lookup SourceDataStore
and vice-versa).getLookupsManager
in interface IActionHelper
public ISourceSetCreator getSourceSetCreator()
ISourceSetCreator
interface instance object that is used to create the source sets.getSourceSetCreator
in interface IActionHelper
ISourceSetCreator
used to create source sets while computing source setspublic ISourceSetNameProvider getSourceSetNameProvider()
ISourceSetNameProvider
interface instance object that is used to generate source set names.getSourceSetNameProvider
in interface IActionHelper
ISourceSetNameProvider
used to create names for the new source setsgetSourceSetNameProvider()
public static com.sunopsis.language.SnpsLanguage getLanguageForTechnology(OdiTechnology pTechnology, OdiInstance pOdiInstance)
SnpsLanguage
object that is associated with the given technology.pTechnology
- The technologypOdiInstance
- The current open OdiInstance object.public com.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.getLanguageForTextHolder
in interface IActionHelper
pExecutableTextHolder
- The executable text holderpublic IMappingPersistencePolicy getMappingPersistencePolicy()
IMappingPersistencePolicy
object that is used to set the persistence policy for the interface mappings and target columns.getMappingPersistencePolicy
in interface IActionHelper
public OdiInstance getOdiInstance()
getOdiInstance
in interface IActionHelper
OdiInstance
public IExecutionArea getExecutionArea(IInterfaceSubComponent pInterfaceSubComponent) throws InexistentMappingException
IExecutionArea
interface instance that represents the location where the specified interface sub-component will be executed.getExecutionArea
in interface IActionHelper
pInterfaceSubComponent
- the sub-componentInexistentMappingException
- if one LogicalSchema mapping is missing for the current Contextpublic java.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.getExecutionAreas
in interface IActionHelper
pDataSet
- the data set for which we want the list of execution areasInexistentMappingException
- if one LogicalSchema mapping is missing for the current Contextpublic static OdiKM<?> chooseKM(OdiTechnology pSourceTechnology, OdiTechnology pDestinationTechnology, java.util.Collection<? extends OdiKM> pKMs)
pSourceTechnology
- the source technologypDestinationTechnology
- the target technologypKMs
- all available KMspKMs
for the couple of technologies.public static OdiKM<?> chooseKM(OdiTechnology pSourceTechnology, OdiTechnology pDestinationTechnology, java.util.Collection<? extends OdiKM> pKMs, boolean pToFilter, java.lang.Boolean pMultiConnexion)
pSourceTechnology
- the source technologypDestinationTechnology
- the destination technologypKMs
- the list of available KMspToFilter
- If true, then the list of available KMs will be filtered to only those that are allowed for the specified parameters.pMultiConnexion
- If true, then multiple connections will be allowed.public static OdiKM<?> chooseKM(java.lang.String pProjectCode, IOdiEntityManager pEntityManager, OdiTechnology pSourceTechnology, OdiTechnology pDestinationTechnology, java.lang.Class pKMClass, boolean pMultiConnexion)
pProjectCode
- the project code in which we want to look for KMspEntityManager
- the entity manager to use to find KMspSourceTechnology
- the source technologypDestinationTechnology
- the destination technologypKMClass
- the KM class we wish to havepMultiConnexion
- If true, then multiple connections will be allowed.public ContextManager getContextManager()
public static OdiInterface.ExecutionLocation computeExecutionLocationForDatastores(SourceDataStore pSrcDataStore1, SourceDataStore pSrcDataStore2)
pSrcDataStore1
- the source data storepSrcDataStore2
- the target data storepublic IOdiEntityManager getEntityManager()
IOdiEntityManager
instance that is used to control object persistence and synchronization for this helper.getEntityManager
in interface IActionHelper
IActionHelper.getEntityManager()
public void removeTargetMapping(TargetMapping pMapping)
removeTargetMapping
in interface IActionHelper
pMapping
- the target mapping to be removedIActionHelper.removeTargetMapping(oracle.odi.domain.project.interfaces.TargetMapping)
public TargetMapping createTargetMapping(DataSet pDataSet, TargetColumn pColumn, OdiInterface.ExecutionLocation pLocation, java.lang.Object pText)
createTargetMapping
in interface IActionHelper
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 mappingIActionHelper.createTargetMapping(oracle.odi.domain.project.interfaces.DataSet, oracle.odi.domain.project.interfaces.TargetColumn, oracle.odi.domain.project.OdiInterface.ExecutionLocation, java.lang.Object)
public void performRefreshDataStores()
OdiDataStore
object in the ODI repository.public com.sunopsis.versioning.SnpsMissingRefsManager getMissingRefsManager()
IActionHelper
getMissingRefsManager
in interface IActionHelper
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.7.0) E17060-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |