oracle.odi.domain.adapter.project

Interface IKnowledgeModule

All Superinterfaces:

IModelObject, IModelObjectBase, IProcedure

All Known Implementing Classes:

AbstractComponentKM, ComponentKM, OdiCKM, OdiIKM, OdiJKM, OdiKM, OdiLKM, OdiRKM, OdiXKM

public interface IKnowledgeModule
extends IProcedure

An interface for knowledge module.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IKnowledgeModule.KMType Enumeration type for KM types.
static class	IKnowledgeModule.LKMType Enumeration type for loading KM type.
static class	IKnowledgeModule.ProcessingType Enumeration type for KM processing type.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INTG_TYPE_CONTROL_APPEND Integration type for target: control append.
static java.lang.String	INTG_TYPE_INCREMENTAL_UPDATE Integration type for target: incremental update.
static java.lang.String	INTG_TYPE_INTERMEDIATE_COMPONENT Integration type for target: intermediate component.
static java.lang.String	INTG_TYPE_NONE Integration type for target: no operation on target.
static java.lang.String	INTG_TYPE_SCD Integration type for target: slowly changing dimension.
static java.lang.String	LOCAL_VARIABLES_GROOVY_SCRIPT

Method Summary

Modifier and Type	Method and Description
IProcedureOption	addProcedureOption(java.lang.String pOptionName, java.lang.Enum pType, java.lang.Object pDefaultValue) Adds a procedure option to this KM.
IProcedureOption	addProcedureOption(java.lang.String pOptionName, java.lang.Enum pType, java.lang.Object pDefaultValue, java.util.Set optionValueSet) Adds procedure option to this KM .
java.lang.String	getDescription() Gets the description for this KM.
java.lang.String	getIntegrationType() Gets the integration type associated with this KM.
IKnowledgeModule.KMType	getKMType() Gets a string name of the KM type, e.g.
IKnowledgeModule.LKMType	getLKMType() Gets the LKM type.
java.util.List	getProcedureLines() Gets the list of procedure lines for this KM.
IProcedureOption	getProcedureOption(java.lang.String name) Gets the procedure option with the specified name.
java.util.List	getProcedureOptions() Gets a list of the procedure options owned by this KM.
IKnowledgeModule.ProcessingType	getProcessingType() Gets the processing type (SOURCE or TARGET or BOTH) for which this KM is intended.
java.lang.String	getProducedASTClassName() Gets the abstract syntax tree class name that is produced by this KM, if any, else null.
ILanguage	getSourceLanguage() Get the source language associated with this KM, or null if no source language is set.
ILanguage	getTargetLanguage() Get the target language associated with this KM, or null if no target language is set.
boolean	isMultiConnectionSupported() Checks if this KM supports both source and target connection.

Methods inherited from interface oracle.odi.domain.adapter.project.IProcedure

addOptionGroup, addProcedureLine, addProcedureLine, addProcedureOption, getOptionGroup, removeProcedureLine

Methods inherited from interface oracle.odi.domain.adapter.IModelObject

getName

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Field Detail

LOCAL_VARIABLES_GROOVY_SCRIPT

static final java.lang.String LOCAL_VARIABLES_GROOVY_SCRIPT

See Also:

Constant Field Values

INTG_TYPE_NONE

static final java.lang.String INTG_TYPE_NONE

Integration type for target: no operation on target.

See Also:

Constant Field Values

INTG_TYPE_CONTROL_APPEND

static final java.lang.String INTG_TYPE_CONTROL_APPEND

Integration type for target: control append.

See Also:

Constant Field Values

INTG_TYPE_INCREMENTAL_UPDATE

static final java.lang.String INTG_TYPE_INCREMENTAL_UPDATE

Integration type for target: incremental update.

See Also:

Constant Field Values

INTG_TYPE_SCD

static final java.lang.String INTG_TYPE_SCD

Integration type for target: slowly changing dimension.

See Also:

Constant Field Values

INTG_TYPE_INTERMEDIATE_COMPONENT

static final java.lang.String INTG_TYPE_INTERMEDIATE_COMPONENT

Integration type for target: intermediate component. That is: the target is not a real user target. Instead, it is an intermediate target created during ODI processing.

See Also:

Constant Field Values

Method Detail

getDescription

java.lang.String getDescription()

Gets the description for this KM.

Returns:

the description of this KM.

getKMType

IKnowledgeModule.KMType getKMType()

Gets a string name of the KM type, e.g. "IKM", "EKM" etc.

Returns:

the String representation of the KM type.

getProcedureLines

java.util.List getProcedureLines()

Gets the list of procedure lines for this KM.

Returns:

the list of procedure lines.

addProcedureOption

IProcedureOption addProcedureOption(java.lang.String pOptionName,
                                    java.lang.Enum pType,
                                    java.lang.Object pDefaultValue)

Adds a procedure option to this KM.

Parameters:

pOptionName - The name of the new option.

pType - The type of the new option.

pDefaultValue - The default value for the new option.

Returns:

a procedure option instance.

addProcedureOption

IProcedureOption addProcedureOption(java.lang.String pOptionName,
                                    java.lang.Enum pType,
                                    java.lang.Object pDefaultValue,
                                    java.util.Set optionValueSet)

Adds procedure option to this KM . In case OptionType is Choice , optionValueSet should contain the Set of possible option values . For any other OptionType , optionValueSet should be null

Parameters:

pOptionName -

pType -

pDefaultValue -

optionValues -

Returns:

getProcedureOptions

java.util.List getProcedureOptions()

Gets a list of the procedure options owned by this KM.

Specified by:

getProcedureOptions in interface IProcedure

Returns:

the list of procedure options.

getProcedureOption

IProcedureOption getProcedureOption(java.lang.String name)

Gets the procedure option with the specified name. Return null if no option with this name exists.

Specified by:

getProcedureOption in interface IProcedure

Parameters:

name - the option name.

Returns:

the procedure option with the specified name.

getIntegrationType

java.lang.String getIntegrationType()

Gets the integration type associated with this KM.

Returns:

the String representation of the integration type of this KM.

getProcessingType

IKnowledgeModule.ProcessingType getProcessingType()

Gets the processing type (SOURCE or TARGET or BOTH) for which this KM is intended.

Returns:

the String representation for the processing type.

getLKMType

IKnowledgeModule.LKMType getLKMType()

Gets the LKM type.

Returns:

the LKM type if this KM is an LKM, or null if otherwise.

isMultiConnectionSupported

boolean isMultiConnectionSupported()

Checks if this KM supports both source and target connection.

Returns:

true if this KM supports both a source and a target connection.

getProducedASTClassName

java.lang.String getProducedASTClassName()

Gets the abstract syntax tree class name that is produced by this KM, if any, else null.

Returns:

the class name for the abstract syntax tree produced by this KM.

getSourceLanguage

ILanguage getSourceLanguage()

Get the source language associated with this KM, or null if no source language is set.

getTargetLanguage

ILanguage getTargetLanguage()

Get the target language associated with this KM, or null if no target language is set.