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

E17060-01

oracle.odi.interfaces.interactive.support.actions
Class InterfaceActionSetKM

java.lang.Object
  extended by oracle.odi.interfaces.interactive.support.actions.InterfaceActionSetKM
All Implemented Interfaces:
IInterfaceAction

public class InterfaceActionSetKM
extends java.lang.Object
implements IInterfaceAction

InterfaceActionSetKM is an interface action class used to set a knowledge module (KM).

Since:
11.1.1.3.0
See Also:
InteractiveInterfaceHelperWithActions

Nested Class Summary
static class InterfaceActionSetKM.DetachedOptionValue
          Represents an option value detached from a knowledge module.
static class InterfaceActionSetKM.KMType
          The KMType enumeration defines the knowledge module types for loading, integration, and flow control.
 
Constructor Summary
InterfaceActionSetKM(OdiKM<?> pKM, IInterfaceSubComponent pKMHolder, InterfaceActionSetKM.KMType pKMType, IKMOptionRetainer pKMOptionRetainer)
          Creates an action class instance which will assign a knowledge module to a source set, staging area, or target datastore, when performAction is called.
 
Method Summary
static java.util.List<IOptionValue> buildDetachedOptionValues(java.util.List<IOptionValue> pOptions)
          Gets a list of detached option values, based on the given option value list.
 void performAction(IInterfaceActionListener pInterfaceActionListener, IInterfaceUndoListener pInterfaceUndoListener, IActionHelper pActionHelper)
          For internal use only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InterfaceActionSetKM

public InterfaceActionSetKM(OdiKM<?> pKM,
                            IInterfaceSubComponent pKMHolder,
                            InterfaceActionSetKM.KMType pKMType,
                            IKMOptionRetainer pKMOptionRetainer)
Creates an action class instance which will assign a knowledge module to a source set, staging area, or target datastore, when performAction is called. This constructor should be called directly to create the action class instance. This instance should then be passed to InteractiveInterfaceHelperWithActions.performAction to assign the KM.
Examples:
interactiveHelper.performAction(new InterfaceActionSetKM(ikm, odiInterface.getTargetDataStore(), KMType.IKM, new KMOptionRetainerLazy()));
interactiveHelper.performAction(new InterfaceActionSetKM(lkm, sourceSet, KMType.LKM, new KMOptionRetainerHomonymy()));

Parameters:
pKM - The knowledge module to be assigned
pKMHolder - SourceSet, StagingArea, or TargetDataStore for the KM.
pKMType - The knowledge module type. LKM, IKM, CKM
pKMOptionRetainer - An option retainer class instance used to handle the retaining of existing KM options for the new KM. When performAction is called, the retainOptions method of the retainer is invoked to retain old options for an existing KM, if one is currently set. If an instance of KMOptionRetainerCopy or KMOptionRetainerHomonymy is used, the options are copied. However, KMOptionRetainerLazy may be specified if no option copy is desired.
See Also:
KMOptionRetainerCopy, KMOptionRetainerHomonymy, KMOptionRetainerLazy
Method Detail

buildDetachedOptionValues

public static java.util.List<IOptionValue> buildDetachedOptionValues(java.util.List<IOptionValue> pOptions)
Gets a list of detached option values, based on the given option value list.

Parameters:
pOptions - list of option values
Returns:
new list of detached options.

performAction

public void performAction(IInterfaceActionListener pInterfaceActionListener,
                          IInterfaceUndoListener pInterfaceUndoListener,
                          IActionHelper pActionHelper)
For internal use only.

Specified by:
performAction in interface IInterfaceAction
Parameters:
pInterfaceActionListener - the interface action listener instance
pInterfaceUndoListener - the interface undo listener instance
pActionHelper - the action helper instance

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

E17060-01

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