Skip navigation links

Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.7.0)

E17060-04


oracle.odi.interfaces.interactive
Interface IInteractiveInterfaceHelper

All Superinterfaces:
IActionHelper
All Known Subinterfaces:
IInteractiveInterfaceHelperWithActions
All Known Implementing Classes:
InteractiveInterfaceHelperWithActions

public interface IInteractiveInterfaceHelper
extends IActionHelper

Any class implementing this interface is a helper to manipulate Odi interfaces in an interactive way.

Since:
11.1.1.3.0

Method Summary
 boolean areSourceSetsDirty()
          Returns true if the source sets should be recomputed.
 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().
 java.util.Collection<IInterfaceIssue> getAllCurrentIssues()
          Returns the current set of IInterfaceIssue objects associated with the interface.
 java.util.Collection<IInterfaceIssue> getCurrentIssues(IInterfaceSubComponent pSubComponent)
          Returns the current set of IInterfaceIssue objects that are associated with the specified sub-component.
 OdiInterface getOdiInterface()
          Returns the interface associated with this helper.
 void preparePersist()
          Called to inform the ODI persistence layer that this interface will be persisted.

 

Methods inherited from interface oracle.odi.interfaces.interactive.IActionHelper
computeExpression, createTargetMapping, getEntityManager, getExecutionArea, getExecutionAreas, getLanguageForTextHolder, getLookupsManager, getMappingPersistencePolicy, getMissingRefsManager, getOdiInstance, getReferenceManagerToDataStoreAttached, getReferenceManagerToDataStoreFull, getReferenceManagerToDataStoreXRefs, getReferenceManagerToSourceColumn, getSourceSetCreator, getSourceSetNameProvider, removeTargetMapping

 

Method Detail

getOdiInterface

OdiInterface getOdiInterface()
Returns the interface associated with this helper.
Specified by:
getOdiInterface in interface IActionHelper
Returns:
the interface associated with this helper

areSourceSetsDirty

boolean areSourceSetsDirty()
Returns true if the source sets should be recomputed. The source sets will need to be recomputed if some interface objects have been modified since the source sets were last computed.
Returns:
true if source sets should be recomputed using computeSourceSets()

computeSourceSets

IImpacts computeSourceSets()
                           throws InexistentMappingException
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().
Returns:
an IImpacts object which represents the modifications and the undo actions
Throws:
InexistentMappingException

getCurrentIssues

java.util.Collection<IInterfaceIssue> getCurrentIssues(IInterfaceSubComponent pSubComponent)
Returns the current set of 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.
Parameters:
pSubComponent - the interface sub-component used to retrieve the issues
Returns:
a collection of IInterfaceIssue objects which are the current issues

getAllCurrentIssues

java.util.Collection<IInterfaceIssue> getAllCurrentIssues()
Returns the current set of 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.
Returns:
a collection of IInterfaceIssue objects which are the current issues of the interface

preparePersist

void preparePersist()
                    throws OdiInterfaceNotReadyForPersistException
Called to inform the ODI persistence layer that this interface will be persisted. If this is not called, the interface will not be persisted. The ComputeSourceSets method should be called at some point before preparePersist is called.
Throws:
OdiInterfaceNotReadyForPersistException - if the interface is not ready to be persisted

Skip navigation links

Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.7.0)

E17060-04


Copyright © 2010, 2013, Oracle and/or its affiliates. All rights reserved.