oracle.odi.domain.project

Class AbstractComponentKM

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.support.AbstractOdiEntity

oracle.odi.domain.project.OdiProcedure

oracle.odi.domain.project.OdiKM

oracle.odi.domain.project.AbstractComponentKM

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, oracle.odi.core.audit.support.IAuditableFirstClassObject, IFlexFieldUser, IModelObject, IModelObjectBase, IKnowledgeModule, IProcedure, oracle.odi.domain.impexp.IExportable, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, oracle.odi.impexp.smartie.ISmartExportable

Direct Known Subclasses:

ComponentKM

public abstract class AbstractComponentKM
extends OdiKM
implements IKnowledgeModule

Represents Extract Knowledge Module OdiXKM class is defined to only use ComponentKMLine as ProcedureLine.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.odi.domain.adapter.project.IKnowledgeModule

IKnowledgeModule.KMType, IKnowledgeModule.LKMType, IKnowledgeModule.ProcessingType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SUBTYPE_ALL_LINES Deprecated. A subtype value that will pull in all lines defined by the KM, regardless of the subtype of each line.
static java.lang.String	SUBTYPE_UNDEFINED A subtype value that indicates that the KM generator delegate AST-producing method is not defined.

Fields inherited from class oracle.odi.domain.project.OdiProcedure

NAME_MAX_LENGTH

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity

STARTING_INTERNAL_VERSION

Fields inherited from interface oracle.odi.domain.adapter.project.IKnowledgeModule

INTG_TYPE_CONTROL_APPEND, INTG_TYPE_INCREMENTAL_UPDATE, INTG_TYPE_INTERMEDIATE_COMPONENT, INTG_TYPE_NONE, INTG_TYPE_SCD, LOCAL_VARIABLES_GROOVY_SCRIPT

Method Summary

Modifier and Type	Method and Description
void	addClassDeclarationText(java.lang.String text) Appends some text to the class declaration text.
OdiKMTemplateJoin	addOdiKMTemplate(OdiKMTemplate odiKMTemplate) Adds the {link OdiKMTemplate}'s reference to this AbstractComponentKM.
void	addOdiKMTemplateList(java.util.List odiKMTemplateList) Adds the list of {link OdiKMTemplate}'s to this AbstractComponentKM.
IProcedureLine	addProcedureLine(java.lang.Class pLineClass, java.lang.String pName) Adds a new procedure line to this procedure.
IProcedureLine	addProcedureLine(java.lang.String pName) Adds a new procedure line to this procedure.
IProcedureOption	addProcedureOption(java.lang.String pOptionName, java.lang.Enum pType, java.lang.Object pDefaultValue) Adds a procedure option to this KM.
void	addVariableDefScriptText(java.lang.String text) Appends some texts to the KM-local groovy substitution variable definition script.
ProcedureOption	duplicateOption(ProcedureOption pOption) Duplicates specified option and adds the new option to the end of list of options.
IProcedureLine	findLine(java.lang.String nameText) Finds the first KM line contained by this KM, whose name contains the specified text.
java.util.List	getAllLines(boolean resolved) Retrieves all the lines held by this AbstractComponentKM along with the non overridden lines from the base KM if any.
java.util.List	getAllLines(boolean resolved, IProcedureLine.LineType lineType) Retrieves all the lines held by this AbstractComponentKM along with the non overridden lines from the base KM if any.
java.util.List	getAllOptionGroups() Returns a List of ProcedureOptionGroup of this KM along with those of base KMs, eliminating groups with same name.
java.util.List	getAllOptions() Returns a List of ProcedureOptions containing all the options which belong to the KM and also all the options of base KM.
java.util.List	getAllOptionsWithNoGroup() Returns a List of all options from this KM and base KMs which does not belong to any group.
java.lang.String	getASTClassName() Gets the abstract syntax tree class name that is produced by this KM, if any, else null.
AbstractComponentKM	getBaseComponentKM() Returns the base component KM for this AbstractComponentKM
java.lang.String	getClassDeclarationText() Gets class declaration text.
java.lang.String	getComponentType() Returns the ComponentType of this AbstractComponentKM
OdiTechnology	getDefaultSourceTechnology() Gets the default source technology of this OdiProcedure.
OdiTechnology	getDefaultTargetTechnology() Gets the default target technology of this OdiProcedure.
OdiIKMLine	getDerivedSubSelectLine() Returns the predefined component KM line with derived subselect property set to true, if any, else return null.
java.lang.String	getDerivedSubSelectTemplate() Returns the derived subselect template that is defined in an IKM line owned by this AbstractComponentKM, if any, else return null.
java.lang.String	getExpectedUpstreamASTClassName() Returns the expected upstream AST class name
boolean	getGenerateMTI() Returns true if this EKM is set up for the generation of multi-insert statements.
boolean	getIndExcludeExUnitBegin()
boolean	getIndExcludeExUnitEnd()
boolean	getIndExcludeExUnitMain()
boolean	getIndExcludeMapBegin()
boolean	getIndExcludeMapCleanUp()
boolean	getIndExcludeMapEnd()
java.util.List	getInsertionLines(java.lang.String subtype) Returns all the lines held by this AbstractComponentKM that match the subtype.
java.lang.String	getIntegrationType() Gets the integration type for this KM.
IKnowledgeModule.KMType	getKMType() Gets a string name of the KM type, e.g.
java.lang.Class	getLineType()
IKnowledgeModule.LKMType	getLKMType() Gets the LKM type for this KM.
java.lang.String	getName() Returns the name of the procedure.
java.util.List	getOdiKMTemplateList() Returns the list of OdiKMTemplate's that are referred by this AbstractComponentKM.
OdiProject	getOdiProject() Returns the parent OdiProject
ProcedureOption	getOption(java.lang.String pName) Retrieves the procedure option which name is the parameter name.
java.util.List	getOwnedLines() Return all the lines that are directly owned by this AbstractComponentKM.
java.util.List	getOwnedLines(IProcedureLine.LineType lineType) Returns all the lines that are directly owned by this AbstractComponentKM, of the specified line type.
java.util.List	getProcedureLines() Gets the list of procedure lines for this KM.
java.util.List	getProcedureOptions() Gets the list of procedure options for this procedure.
IKnowledgeModule.ProcessingType	getProcessingType() Gets the intended code generation processing type for this AbstractComponentKM.
java.lang.String	getProducedASTClassName() Gets the abstract syntax tree class name that is produced by this KM, if any, else null.
oracle.odi.domain.topology.language.OdiLanguage	getSourceLanguage() Gets the source language for this KM.
ITechnology	getSourceTechnology() Gets the source technology for this KM, or null if source technology is not supported.
java.lang.String	getStaticBaseClassName() Deprecated. Use getDelegateClassName, it will return the base static delegate class name if this one doesn't have one, if enableInheritance parameter is true.
java.lang.String	getSubtype() Get the subtype value for this AbstractComponentKM, for the processing type (SOURCE/TARGET/BOTH) of this KM.
java.lang.String	getSubtype(IKnowledgeModule.ProcessingType procType) Gets the subtype of this KM, for the specified processing type.
oracle.odi.domain.topology.language.OdiLanguage	getTargetLanguage() Gets the target language for this KM.
ITechnology	getTargetTechnology() Gets the target technology for this KM.
java.lang.String	getVariableDefScriptText() Gets the KM-local groovy substitution variable definition script text.
java.lang.String	getVariableDefScriptText(boolean includeBaseText) Gets the KM-local groovy substitution variable definition script text.
boolean	hasGeneratorDelegate() Returns true if this KM has an explicit java or groovy generation delegate.
boolean	is11gKM() Returns true if this is a 11g-style KM.
boolean	isBaseKMLine(OdiProcedureLine line) Returns true if the specified line is a baseKM line
boolean	isBaseOnlyKM() Returns if this AbstractComponentKM is pure base KM.
boolean	isHidden() If true, indicates that this KM is a 12.1-style KM that is not converted to the newer format, and if seeded, it should not be visible in the KM tree.
boolean	isMultiConnectIKM() Returns true if this is a IKM and supports multiConnection
boolean	isMultiConnectLKM() Returns true if this is a LKM and supports multiConnection
boolean	isProcedureLine(OdiProcedureLine line) Returns true if the specified line is a procedure line or a baseKM line
boolean	isSeeded() Return true if this KM is a shipped, seeded 12c (or later) KM.
boolean	isSourceSupported() Return true if this KM allows source technology and language to be set and retrieved.
boolean	isTransparentLKM() Returns true if this KM is a transparent LKM Transparent means LKM can access to source/target attributes as if local
void	moveLineAfter(ComponentKMLine pSource, ComponentKMLine pAfter) Moves the given OdiProcedureLine after the line specified.
void	moveLineBefore(ComponentKMLine pSource, ComponentKMLine pBefore) Moves the given Procedure Moves the given OdiProcedureLine before the line specified.
void	moveLineToBottom(ComponentKMLine pLine) Moves the given OdiProcedureLine to the bottom of the list of lines.
void	moveLineToTop(ComponentKMLine pLine) Moves the given OdiProcedureLine to the top of the list of lines.
ComponentKMLine	overrideLine(ComponentKMLine line) Overrides the specified base KM line by copying the line into this KM, and remove the existing reference line, if any.
OdiKMTemplateJoin	removeOdiKMTemplate(OdiKMTemplate odiKMTemplate) Removes the {link OdiKMTemplate}'s reference from this AbstractComponentKM.
void	removeProcedureLine(IProcedureLine line) Removes an existing procedure line.
void	setBaseComponentKM(AbstractComponentKM base) Sets the base component KM for this AbstractComponentKM
void	setClassDeclarationText(java.lang.String text) Sets class declaration text
void	setComponentType(java.lang.String compType) Sets the ComponentType for this AbstractComponentKM
void	setDefaultsFromBaseKM() Sets this AbstractComponentKM's flags's value (MultiConnectionSupported, LKMType and GenerateMTI), from its base KM.
void	setDefaultSourceTechnology(OdiTechnology pTechnology) Sets the default source technology of this OdiProcedure.
void	setExpectedUpstreamASTClassName(java.lang.String className) Sets the expected upstream AST class name
void	setGenerateMTI(boolean pGenerateMTI) Sets the flag to indicate whether this EKM is set up for the generation of multi-insert statements.
void	setIndExcludeExUnitBegin(boolean value) set IndExcludeExUnitBegin flag for Abstract ComponentKM
void	setIndExcludeExUnitEnd(boolean value) set IndExcludeExUnitEnd flag for Abstract ComponentKM
void	setIndExcludeExUnitMain(boolean value) set IndExcludeExUnitMain flag for Abstract ComponentKM
void	setIndExcludeMapBegin(boolean value) set IndExcludeMapBegin flag for Abstract ComponentKM
void	setIndExcludeMapCleanUp(boolean value) set IndExcludeMapCleanUp flag for Abstract ComponentKM
void	setIndExcludeMapEnd(boolean value) set IndExcludeMapEnd flag for Abstract ComponentKM
void	setIntegrationType(java.lang.String type) Sets the integration type for this KM.
void	setLKMType(IKnowledgeModule.LKMType type) Sets the LKM type for this KM.
void	setMultiConnectionSupported(boolean pMultiConnectionSupported) Defines whether this OdiProcedure supports mulitConnection or not.
void	setProcessingType(IKnowledgeModule.ProcessingType type) Sets the intended code generation processing type for this AbstractComponentKM.
void	setProducedASTClassName(java.lang.String name) Sets the abstract syntax tree class name, that is produced by this KM
void	setSourceLanguage(oracle.odi.domain.topology.language.OdiLanguage sourceLanguage) Sets source language for this AbstractComponentKM
void	setSourceTechnology(ITechnology techno) Sets the source technology for this KM
void	setSubtype(IKnowledgeModule.ProcessingType processingType, java.lang.String subtype) Set the subtype for this KM, for the specified processing type.
void	setSubtype(java.lang.String subtype) Set the value of the subtype field for this KM.
void	setTargetLanguage(oracle.odi.domain.topology.language.OdiLanguage targetLanguage) Sets target language for this AbstractComponentKM
void	setTargetTechnology(ITechnology techno) Sets the target technology for this KM
void	setVariableDefScriptText(java.lang.String text) Sets the KM-local groovy substitution variable definition script text.

Methods inherited from class oracle.odi.domain.project.OdiKM

getChecksum, getCustomizationStatus, getKMBuildNumber, getProject, isDefaultKM, isGlobal, isInstanceLevelSecurityNeeded, isSetBasedOperatorSupported, setChecksum, setDefaultKM, setKMBuildNumber, setProject, setSetBasedOperatorSupported, toString

Methods inherited from class oracle.odi.domain.project.OdiProcedure

addLine, addLine, addLine, addLine, addOption, addOption, addOptionGroup, addProcedureOption, dumpLineOrder, duplicateLine, getDescription, getFlexFieldsValues, getInternalId, getLines, getOptionGroup, getOptionGroups, getOptionNames, getOptions, getOptionsWithNoGroup, getProcedureId, getProcedureOption, getTopLevelLines, initFlexFields, isMultiConnectionSupported, moveGroupAfterGroup, moveGroupBeforeGroup, moveOptionAfter, moveOptionBefore, moveOptionToBottom, moveOptionToTop, removeLine, removeOption, removeOptionGroup, setDefaultTargetTechnology, setDescription, setName

Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity

getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, isNew, preCommit

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

equals, getBigNumericId, getGlobalId, getNumericId, getParent, hashCode

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

addProcedureOption, getDescription, getProcedureOption, isMultiConnectionSupported

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

addOptionGroup, addProcedureOption, getOptionGroup

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

getBigNumericId, getGlobalId, getNumericId

Methods inherited from interface oracle.odi.domain.IOdiEntity

getFirstDate, getFirstUser, getLastDate, getLastUser

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Field Detail

SUBTYPE_ALL_LINES

public static final java.lang.String SUBTYPE_ALL_LINES

Deprecated. A subtype value that will pull in all lines defined by the KM, regardless of the subtype of each line.

See Also:

Constant Field Values

SUBTYPE_UNDEFINED

public static final java.lang.String SUBTYPE_UNDEFINED

A subtype value that indicates that the KM generator delegate AST-producing method is not defined.

See Also:

Constant Field Values

Method Detail

setDefaultsFromBaseKM

public void setDefaultsFromBaseKM()

Sets this AbstractComponentKM's flags's value (MultiConnectionSupported, LKMType and GenerateMTI), from its base KM.

setBaseComponentKM

public void setBaseComponentKM(AbstractComponentKM base)

Sets the base component KM for this AbstractComponentKM

Parameters:

base -

getOdiProject

public OdiProject getOdiProject()

Returns the parent OdiProject

Returns:

OdiProject, a top level workbench object in ODI.

getComponentType

public java.lang.String getComponentType()

Returns the ComponentType of this AbstractComponentKM

Returns:

component type

setComponentType

public void setComponentType(java.lang.String compType)

Sets the ComponentType for this AbstractComponentKM

Parameters:

compType -

isSeeded

public boolean isSeeded()

Description copied from class: OdiKM

Return true if this KM is a shipped, seeded 12c (or later) KM. In this case it should not be edited.

Overrides:

isSeeded in class OdiKM

Returns:

isHidden

public boolean isHidden()

If true, indicates that this KM is a 12.1-style KM that is not converted to the newer format, and if seeded, it should not be visible in the KM tree.

Returns:

true if this KM is hidden

setIndExcludeMapBegin

public void setIndExcludeMapBegin(boolean value)

set IndExcludeMapBegin flag for Abstract ComponentKM

Parameters:

value -

getIndExcludeMapBegin

public boolean getIndExcludeMapBegin()

Returns:

true if IndExcludeMapBegin relative lineType need to be excluded for Component KM and false by default which means lines are included for KM

setIndExcludeExUnitBegin

public void setIndExcludeExUnitBegin(boolean value)

set IndExcludeExUnitBegin flag for Abstract ComponentKM

Parameters:

value -

getIndExcludeExUnitBegin

public boolean getIndExcludeExUnitBegin()

Returns:

true if IndExcludeExUnitBegin relative linetype need to be excluded for Component KM and false by default where lines are included for KM

setIndExcludeExUnitMain

public void setIndExcludeExUnitMain(boolean value)

set IndExcludeExUnitMain flag for Abstract ComponentKM

Parameters:

value -

getIndExcludeExUnitMain

public boolean getIndExcludeExUnitMain()

Returns:

true if IndExcludeExUnitMain relative linetype need to be excluded for Component KM and false by default where lines are included for KM

setIndExcludeExUnitEnd

public void setIndExcludeExUnitEnd(boolean value)

set IndExcludeExUnitEnd flag for Abstract ComponentKM

Parameters:

value -

getIndExcludeExUnitEnd

public boolean getIndExcludeExUnitEnd()

Returns:

true if IndExcludeExUnitEnd relative linetype need to be excluded for Component KM and false by default which means lines are included for KM

setIndExcludeMapEnd

public void setIndExcludeMapEnd(boolean value)

set IndExcludeMapEnd flag for Abstract ComponentKM

Parameters:

value -

getIndExcludeMapEnd

public boolean getIndExcludeMapEnd()

Returns:

true if IndExcludeMapEnd relative linetype need to be excluded for Component KM and false by default which means lines are included for KM

setIndExcludeMapCleanUp

public void setIndExcludeMapCleanUp(boolean value)

set IndExcludeMapCleanUp flag for Abstract ComponentKM

Parameters:

value -

getIndExcludeMapCleanUp

public boolean getIndExcludeMapCleanUp()

Returns:

true if IndExcludeMapCleanUp relative linetype need to be excluded for Component KM and false by default which means lines are included for KM

getBaseComponentKM

public AbstractComponentKM getBaseComponentKM()

Returns the base component KM for this AbstractComponentKM

Returns:

the base Component KM

getStaticBaseClassName

public java.lang.String getStaticBaseClassName()

Deprecated. Use getDelegateClassName, it will return the base static delegate class name if this one doesn't have one, if enableInheritance parameter is true.

Returns:

setProducedASTClassName

public void setProducedASTClassName(java.lang.String name)

Sets the abstract syntax tree class name, that is produced by this KM

Parameters:

name -

getProducedASTClassName

public java.lang.String getProducedASTClassName()

Description copied from interface: IKnowledgeModule

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

Specified by:

getProducedASTClassName in interface IKnowledgeModule

Overrides:

getProducedASTClassName in class OdiKM

Returns:

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

setExpectedUpstreamASTClassName

public void setExpectedUpstreamASTClassName(java.lang.String className)

Sets the expected upstream AST class name

Parameters:

name -

getExpectedUpstreamASTClassName

public java.lang.String getExpectedUpstreamASTClassName()

Returns the expected upstream AST class name

Returns:

a string representing the expected upstream AST class name

setSubtype

public void setSubtype(java.lang.String subtype)

Set the value of the subtype field for this KM. The subtype field specifies the name of the delegate class method that is called during code generation, to produce the AST object for this KM. For LKM, the subtype field value is two values separated by a ":" character. The first value specifies the target subtype, and the second value specifies the source subtype.

Parameters:

subtype - The new subtype field value to be set.

setSubtype

public void setSubtype(IKnowledgeModule.ProcessingType processingType,
                       java.lang.String subtype)

Set the subtype for this KM, for the specified processing type. A KM can have a source subtype and a target subtype. The subtype is the method name that gets called for the KM generator delegate, to produce the AST object that will be used for rendering text.

Parameters:

processingType - The processing type (SOURCE or TARGET) for which to set the subtype.

subtype - The subtype to set.

getSubtype

public java.lang.String getSubtype()

Get the subtype value for this AbstractComponentKM, for the processing type (SOURCE/TARGET/BOTH) of this KM. If the subtype value for this KM is null, the KM inheritance tree will be navigated to find a subtype value.

Returns:

The subtype value for this KM.

getSubtype

public java.lang.String getSubtype(IKnowledgeModule.ProcessingType procType)

Gets the subtype of this KM, for the specified processing type. If the processing type is BOTH, then the TARGET subtype will be returned. The subtype returned from this method is used to find the AST producer method (or methods, for LKM) in this KM's generator delegate class that will be called by this KM when generating code for a component. It is exposed in the UI as source or target generation style.

Parameters:

procType -

Returns:

the subtype of this KM

setLKMType

public void setLKMType(IKnowledgeModule.LKMType type)

Sets the LKM type for this KM. Possible values are:
The LKM type specifies the basic functionality of the LKM. The possible values are:
PERSISTENT: This LKM will store data from the source server in some persistent storage such as a staging table, on the target server.
TRANSPARENT_SOURCE: This LKM will make the source data available from the target server, using some transparent access method such as an Oracle dblink.
TRANSPARENT_TARGET: This LKM will make the target server and visible and loadable from the source, using some transparent access method such as an Oracle dblink.
TRANSPARENT_BOTH: This LKM will generate code on some server where both the source data and the target datastores are somehow made transparently available to the generated code. This setting should be used when the LKM will be responsible for doing all the source data gathering and the target loading, with no help from the target IKM.

Parameters:

type -

getLKMType

public IKnowledgeModule.LKMType getLKMType()

Gets the LKM type for this KM. Possible values are:
The LKM type specifies the basic functionality of the LKM. The possible values are:
PERSISTENT: This LKM will store data from the source server in some persistent storage such as a staging table, on the target server.
TRANSPARENT_SOURCE: This LKM will make the source data available from the target server, using some transparent access method such as an Oracle dblink.
TRANSPARENT_TARGET: This LKM will make the target server and visible and loadable from the source, using some transparent access method such as an Oracle dblink.
TRANSPARENT_BOTH: This LKM will generate code on some server where both the source data and the target datastores are somehow made transparently available to the generated code. This setting should be used when the LKM will be responsible for doing all the source data gathering and the target loading, with no help from the target IKM. If this is not an LKM, NONE will be returned.

Specified by:

getLKMType in interface IKnowledgeModule

Returns:

LKM type

setProcessingType

public void setProcessingType(IKnowledgeModule.ProcessingType type)

Sets the intended code generation processing type for this AbstractComponentKM. The possible values are:
SOURCE: Means that this KM does only source processing. This is the typical setting for a XKM. The KM is responsible for producing an extract AST tree that contains metadata to describe the source extraction.
TARGET: Means that this KM does only target processing. This is the typical setting for a IKM. The KM is responsible for producing a loading AST tree that contains metadata to describe the target loading.
BOTH: Means that this KM does both source and target processing. This is the typical setting for a LKM. The KM is responsible for producing a loading AST tree that contains metadata to describe the stage table loading (or the transparent access), and is also responsible to produce an extract AST tree to describe the extract from the staging table (or transparent access).
NONE: Means that this KM does not generate any source or target code. This is the setting used in 11g KMs that do not produce any AST tree. In that case a seeded component KM is used as a helper to produce the AST tree.
BASE_ONLY: Means that this KM does not produce any AST tree. This setting is used by base-only component KMs.

Parameters:

type - the processing type

getProcessingType

public IKnowledgeModule.ProcessingType getProcessingType()

Gets the intended code generation processing type for this AbstractComponentKM. The possible values are:
SOURCE: Means that this KM does only source processing. This is the typical setting for a XKM. The KM is responsible for producing an extract AST tree that contains metadata to describe the source extraction.
TARGET: Means that this KM does only target processing. This is the typical setting for a IKM. The KM is responsible for producing a loading AST tree that contains metadata to describe the target loading.
BOTH: Means that this KM does both source and target processing. This is the typical setting for a LKM. The KM is responsible for producing a loading AST tree that contains metadata to describe the stage table loading (or the transparent access), and is also responsible to produce an extract AST tree to describe the extract from the staging table (or transparent access).
NONE: Means that this KM does not generate any source or target code. This is the setting used in 11g KMs that do not produce any AST tree. In that case a seeded component KM is used as a helper to produce the AST tree.
BASE_ONLY: Means that this KM does not produce any AST tree. This setting is used by base-only component KMs.

Specified by:

getProcessingType in interface IKnowledgeModule

Returns:

processing type

getIntegrationType

public java.lang.String getIntegrationType()

Gets the integration type for this KM. The list of domain values is open, but some predefined domain values are provided, such as INTG_TYPE_INCREMENTAL_UPDATE, INTG_TYPE_CONTROL_APPEND. The integration type will be matched with the integration type set for target datastore components, to help find the best default KM assignment.

Specified by:

getIntegrationType in interface IKnowledgeModule

Returns:

intergration type for this KM

setIntegrationType

public void setIntegrationType(java.lang.String type)

Sets the integration type for this KM. The list of domain values is open, but some predefined domain values are provided, such as INTG_TYPE_INCREMENTAL_UPDATE, INTG_TYPE_CONTROL_APPEND. The integration type will be matched with the integration type set for target datastore components, to help find the best default KM assignment.

Parameters:

type - the integration type for this KM

getASTClassName

public java.lang.String getASTClassName()

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

Returns:

a string representing the AST class name

setVariableDefScriptText

public void setVariableDefScriptText(java.lang.String text)

Sets the KM-local groovy substitution variable definition script text.

Parameters:

text -

addVariableDefScriptText

public void addVariableDefScriptText(java.lang.String text)

Appends some texts to the KM-local groovy substitution variable definition script.

Parameters:

text -

getVariableDefScriptText

public java.lang.String getVariableDefScriptText(boolean includeBaseText)

Gets the KM-local groovy substitution variable definition script text.

Parameters:

includeBaseText - If true, include any base KM variable definition script text as well.

Returns:

The KM-local variable definition script text.

getVariableDefScriptText

public java.lang.String getVariableDefScriptText()

Gets the KM-local groovy substitution variable definition script text. No base KM text is included.

Returns:

the KM-local variable definition script text

getClassDeclarationText

public java.lang.String getClassDeclarationText()

Gets class declaration text. The class declaration text is groovy script text that is used to create the KM delegate class

Returns:

class declaration text

addClassDeclarationText

public void addClassDeclarationText(java.lang.String text)

Appends some text to the class declaration text. The class declaration text is groovy script text that is used to create the KM delegate class

Parameters:

text -

setClassDeclarationText

public void setClassDeclarationText(java.lang.String text)

Sets class declaration text

Parameters:

text -

getTargetTechnology

public ITechnology getTargetTechnology()

Gets the target technology for this KM.

Returns:

the target technology

setTargetTechnology

public void setTargetTechnology(ITechnology techno)

Sets the target technology for this KM

Parameters:

techno -

getSourceTechnology

public ITechnology getSourceTechnology()

Gets the source technology for this KM, or null if source technology is not supported.

Returns:

the source technology.

setMultiConnectionSupported

public void setMultiConnectionSupported(boolean pMultiConnectionSupported)

Description copied from class: OdiProcedure

Defines whether this OdiProcedure supports mulitConnection or not. Mainly used by ODI Studio to determine best-suited procedures.

Setting this will affect source technology. If set to false, source technology will be set to null.

Overrides:

setMultiConnectionSupported in class OdiProcedure

Parameters:

pMultiConnectionSupported - true to make this procedure supports mutliConnection, false otherwise

See Also:

OdiProcedure.isMultiConnectionSupported()

getDefaultSourceTechnology

public OdiTechnology getDefaultSourceTechnology()

Description copied from class: OdiProcedure

Gets the default source technology of this OdiProcedure.

Overrides:

getDefaultSourceTechnology in class OdiProcedure

Returns:

default source technology

See Also:

OdiProcedure.setDefaultSourceTechnology(oracle.odi.domain.topology.OdiTechnology)

isSourceSupported

public boolean isSourceSupported()

Return true if this KM allows source technology and language to be set and retrieved. The KM will support source technology and language if it is a XKM or LKM or multi-connect IKM. If this method returns false, then calling getSourceTechnology() method will throw an exception.

Returns:

True if source technology and language is supported.

getDefaultTargetTechnology

public OdiTechnology getDefaultTargetTechnology()

Description copied from class: OdiProcedure

Gets the default target technology of this OdiProcedure.

Overrides:

getDefaultTargetTechnology in class OdiProcedure

Returns:

default target technology

See Also:

OdiProcedure.setDefaultTargetTechnology(oracle.odi.domain.topology.OdiTechnology)

duplicateOption

public ProcedureOption duplicateOption(ProcedureOption pOption)

Description copied from class: OdiProcedure

Duplicates specified option and adds the new option to the end of list of options. Returns newly created option.

Overrides:

duplicateOption in class OdiProcedure

Parameters:

pOption - option to duplicate

Returns:

the newly created ProcedureOption

setSourceTechnology

public void setSourceTechnology(ITechnology techno)

Sets the source technology for this KM

Parameters:

techno -

setDefaultSourceTechnology

public void setDefaultSourceTechnology(OdiTechnology pTechnology)

Description copied from class: OdiProcedure

Sets the default source technology of this OdiProcedure.

Mainly used inside ODI Studio when creating commands.

By default this property is set to null.

Overrides:

setDefaultSourceTechnology in class OdiProcedure

Parameters:

pTechnology - the default source technology

See Also:

OdiProcedure.getDefaultSourceTechnology()

getGenerateMTI

public boolean getGenerateMTI()

Returns true if this EKM is set up for the generation of multi-insert statements.

Returns:

true if this EKM is set up for the generation of multi-insert

setGenerateMTI

public void setGenerateMTI(boolean pGenerateMTI)

Sets the flag to indicate whether this EKM is set up for the generation of multi-insert statements.

Parameters:

pGenerateMTI -

getInsertionLines

public java.util.List getInsertionLines(java.lang.String subtype)
                                 throws oracle.odi.mapping.generation.GenerationException

Returns all the lines held by this AbstractComponentKM that match the subtype. This also includes the lines that match the subtype from the base KM if any.

Parameters:

subtype - - the subtype of the lines

Returns:

List of component KM lines

Throws:

oracle.odi.mapping.generation.GenerationException

getAllLines

public java.util.List getAllLines(boolean resolved)

Retrieves all the lines held by this AbstractComponentKM along with the non overridden lines from the base KM if any. If resolved is true, then this API resolves the entire KM and KM line references if any and return the resolved lines, if false returns just the lines of this KM.

Parameters:

resolved -

Returns:

List of component KM lines

getAllLines

public java.util.List getAllLines(boolean resolved,
                                  IProcedureLine.LineType lineType)

Retrieves all the lines held by this AbstractComponentKM along with the non overridden lines from the base KM if any. If resolved is true, then this API resolves the entire KM and KM line references if any and return the resolved lines, if false returns just the lines of this KM. If a line type is specified, then returns only lines of the specified type.

Parameters:

resolved -

lineType - If non-null, then return only lines of the specified line type.

Returns:

List of component KM lines

getOwnedLines

public java.util.List getOwnedLines()

Return all the lines that are directly owned by this AbstractComponentKM.

Returns:

List of lines owned by this KM

getOwnedLines

public java.util.List getOwnedLines(IProcedureLine.LineType lineType)

Returns all the lines that are directly owned by this AbstractComponentKM, of the specified line type.

Parameters:

lineType - The type to match.

Returns:

A list of the owned lines of the specified type.

getProcedureLines

public java.util.List getProcedureLines()

Description copied from interface: IKnowledgeModule

Gets the list of procedure lines for this KM.

Specified by:

getProcedureLines in interface IKnowledgeModule

Returns:

the list of procedure lines.

findLine

public IProcedureLine findLine(java.lang.String nameText)

Finds the first KM line contained by this KM, whose name contains the specified text. If no such line is found, return null.

Parameters:

nameText - The text to look for in the KM line names.

Returns:

a KM line

getOption

public ProcedureOption getOption(java.lang.String pName)

Retrieves the procedure option which name is the parameter name.

Overrides:

getOption in class OdiProcedure

Parameters:

pName - the name of the option

Returns:

the ProcedureOption matching the given name

See Also:

OdiProcedure.addOption(ProcedureOption)

getKMType

public IKnowledgeModule.KMType getKMType()

Description copied from interface: IKnowledgeModule

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

Specified by:

getKMType in interface IKnowledgeModule

Returns:

the String representation of the KM type.

getName

public java.lang.String getName()

Description copied from class: OdiProcedure

Returns the name of the procedure.

Specified by:

getName in interface IFlexFieldUser

Specified by:

getName in interface IModelObject

Specified by:

getName in interface IOdiEntity

Overrides:

getName in class OdiProcedure

Returns:

the name

See Also:

OdiProcedure.setName(String)

getProcedureOptions

public java.util.List getProcedureOptions()

Description copied from interface: IProcedure

Gets the list of procedure options for this procedure.

Specified by:

getProcedureOptions in interface IKnowledgeModule

Specified by:

getProcedureOptions in interface IProcedure

Overrides:

getProcedureOptions in class OdiProcedure

Returns:

the list of procedure options.

getAllOptions

public java.util.List getAllOptions()

Returns a List of ProcedureOptions containing all the options which belong to the KM and also all the options of base KM. ProcedureOption which belongs to extended KM are editable whereas ProcedureOption which belongs to base KM are non-editable.

Returns:

List of all the options belongs to both base KM and extended KM.

addProcedureOption

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

Description copied from interface: IKnowledgeModule

Adds a procedure option to this KM.

Specified by:

addProcedureOption in interface IKnowledgeModule

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.

isMultiConnectIKM

public boolean isMultiConnectIKM()

Returns true if this is a IKM and supports multiConnection

Returns:

true if this is a IKM AND supports mutliConnection, false otherwise

isMultiConnectLKM

public boolean isMultiConnectLKM()

Returns true if this is a LKM and supports multiConnection

Returns:

true if this is a LKM AND supports mutliConnection, false otherwise

isProcedureLine

public boolean isProcedureLine(OdiProcedureLine line)

Returns true if the specified line is a procedure line or a baseKM line

Overrides:

isProcedureLine in class OdiProcedure

Parameters:

line - The line to check.

Returns:

true for a procedure or baseKM line

isBaseKMLine

public boolean isBaseKMLine(OdiProcedureLine line)

Returns true if the specified line is a baseKM line

Returns:

true if the specified line is a base KM line

isTransparentLKM

public boolean isTransparentLKM()

Returns true if this KM is a transparent LKM Transparent means LKM can access to source/target attributes as if local

Returns:

true if this KM is a transparent LKM

hasGeneratorDelegate

public boolean hasGeneratorDelegate()
                             throws oracle.odi.mapping.generation.GenerationException

Returns true if this KM has an explicit java or groovy generation delegate.

Returns:

true if this KM has an explicit java or groovy generation delegate.

Throws:

oracle.odi.mapping.generation.GenerationException

getDerivedSubSelectLine

public OdiIKMLine getDerivedSubSelectLine()

Returns the predefined component KM line with derived subselect property set to true, if any, else return null.

Returns:

getDerivedSubSelectTemplate

public java.lang.String getDerivedSubSelectTemplate()

Returns the derived subselect template that is defined in an IKM line owned by this AbstractComponentKM, if any, else return null.

Returns:

getLineType

public java.lang.Class getLineType()

Specified by:

getLineType in class OdiProcedure

is11gKM

public boolean is11gKM()

Returns true if this is a 11g-style KM. An 11g-style KM does not generate any AST tree, and the component type field is set to null

Returns:

getAllOptionGroups

public java.util.List getAllOptionGroups()

Returns a List of ProcedureOptionGroup of this KM along with those of base KMs, eliminating groups with same name. If this KM and its base KM both contains group with same name ,then the group of this KM will be returned.

Returns:

a list of procedure option group

getAllOptionsWithNoGroup

public java.util.List getAllOptionsWithNoGroup()

Returns a List of all options from this KM and base KMs which does not belong to any group.

Returns:

a list of procedure option

getSourceLanguage

public oracle.odi.domain.topology.language.OdiLanguage getSourceLanguage()

Gets the source language for this KM. The source language is the generated language that is expected from source code generation artifacts (AST objects) for this KM. Can be overridden by the task source language for individual KM tasks. If the source language is not set, this method returns the default language of the source technology.

Specified by:

getSourceLanguage in interface IKnowledgeModule

Overrides:

getSourceLanguage in class OdiKM

Returns:

The source language.

setSourceLanguage

public void setSourceLanguage(oracle.odi.domain.topology.language.OdiLanguage sourceLanguage)

Sets source language for this AbstractComponentKM

Parameters:

The - source language.

Throws:

DomainRuntimeException - if sourceLanguage is null or if source technology is not set.

getTargetLanguage

public oracle.odi.domain.topology.language.OdiLanguage getTargetLanguage()

Gets the target language for this KM. The target language is the language that will be generated for code generation artifacts (AST objects) produced by this KM. Can be overridden by the task target language for individual KM tasks. If the target language is not set, it tries to get the language from base KM, if the language is not set in the base KM then the default language of the target technology is fetched.

Specified by:

getTargetLanguage in interface IKnowledgeModule

Overrides:

getTargetLanguage in class OdiKM

Returns:

the target language

isBaseOnlyKM

public boolean isBaseOnlyKM()

Returns if this AbstractComponentKM is pure base KM. A KM is a pure base KM if its Processing Type is NONE, and it is a Component KM. A pure base KM is not capable of producing any AST object. It can be a LKM, CKM, IKM, or XKM.

Returns:

true if this is a pure base KM.

getOdiKMTemplateList

public java.util.List getOdiKMTemplateList()

Returns the list of OdiKMTemplate's that are referred by this AbstractComponentKM.

Returns:

unmodifiable list of OdiKMTemplates

removeOdiKMTemplate

public OdiKMTemplateJoin removeOdiKMTemplate(OdiKMTemplate odiKMTemplate)

Removes the {link OdiKMTemplate}'s reference from this AbstractComponentKM.

Parameters:

odiKMTemplate - the KM template to be removed

addOdiKMTemplate

public OdiKMTemplateJoin addOdiKMTemplate(OdiKMTemplate odiKMTemplate)

Adds the {link OdiKMTemplate}'s reference to this AbstractComponentKM.

Parameters:

odiKMTemplate - the KM template to be added

addOdiKMTemplateList

public void addOdiKMTemplateList(java.util.List odiKMTemplateList)

Adds the list of {link OdiKMTemplate}'s to this AbstractComponentKM.

Parameters:

odiKMTemplateList - the list of KM templates to be added

setTargetLanguage

public void setTargetLanguage(oracle.odi.domain.topology.language.OdiLanguage targetLanguage)

Sets target language for this AbstractComponentKM

Parameters:

target - language.

Throws:

DomainRuntimeException - if targetLanguage is null or if target technology is not set.

overrideLine

public ComponentKMLine overrideLine(ComponentKMLine line)

Overrides the specified base KM line by copying the line into this KM, and remove the existing reference line, if any.

Parameters:

line - The base KM line. Can be a reference line or a base KM line. If the specified line is not an already included base line, then do nothing and return null.

Returns:

The new line.

addProcedureLine

public IProcedureLine addProcedureLine(java.lang.String pName)

Description copied from interface: IProcedure

Adds a new procedure line to this procedure.

Specified by:

addProcedureLine in interface IProcedure

Overrides:

addProcedureLine in class OdiProcedure

Parameters:

pName - the name for the new procedure line.

Returns:

the new procedure line.

addProcedureLine

public IProcedureLine addProcedureLine(java.lang.Class pLineClass,
                                       java.lang.String pName)

Description copied from interface: IProcedure

Adds a new procedure line to this procedure.

Specified by:

addProcedureLine in interface IProcedure

Overrides:

addProcedureLine in class OdiProcedure

Parameters:

pLineClass - The class type of the new line.

pName - the name of the new line.

Returns:

the new procedure line.

removeProcedureLine

public void removeProcedureLine(IProcedureLine line)

Description copied from interface: IProcedure

Removes an existing procedure line.

Specified by:

removeProcedureLine in interface IProcedure

Overrides:

removeProcedureLine in class OdiProcedure

Parameters:

line - the line to be removed.

moveLineAfter

public void moveLineAfter(ComponentKMLine pSource,
                          ComponentKMLine pAfter)

Description copied from class: OdiProcedure

Moves the given OdiProcedureLine after the line specified. This will internally rearrange OdiProcedureLines accordingly.

Overrides:

moveLineAfter in class OdiProcedure

Parameters:

pSource - source line

pAfter - move source line after this line

moveLineBefore

public void moveLineBefore(ComponentKMLine pSource,
                           ComponentKMLine pBefore)

Description copied from class: OdiProcedure

Moves the given Procedure Moves the given OdiProcedureLine before the line specified. This will internally rearrange OdiProcedureLines accordingly.

Overrides:

moveLineBefore in class OdiProcedure

Parameters:

pSource - source line

pBefore - move source line before this line

moveLineToBottom

public void moveLineToBottom(ComponentKMLine pLine)

Description copied from class: OdiProcedure

Moves the given OdiProcedureLine to the bottom of the list of lines. This will internally rearrange OdiProcedureLines accordingly.

Overrides:

moveLineToBottom in class OdiProcedure

Parameters:

pLine - line to move

moveLineToTop

public void moveLineToTop(ComponentKMLine pLine)

Description copied from class: OdiProcedure

Moves the given OdiProcedureLine to the top of the list of lines. This will internally rearrange OdiProcedureLines accordingly.

Overrides:

moveLineToTop in class OdiProcedure

Parameters:

pLine - line to move