public abstract class AbstractComponentKM extends OdiKM implements IKnowledgeModule
IKnowledgeModule.KMType, IKnowledgeModule.LKMType, IKnowledgeModule.ProcessingType
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SUBTYPE_ALL_LINES
A subtype value that will pull in all lines defined by the KM, regardless of the subtype
of each line.
|
NAME_MAX_LENGTH
INTG_TYPE_CONTROL_APPEND, INTG_TYPE_INCREMENTAL_UPDATE, INTG_TYPE_INTERMEDIATE_COMPONENT, INTG_TYPE_NONE, INTG_TYPE_SCD, LOCAL_VARIABLES_GROOVY_SCRIPT
Modifier and Type | Method and Description |
---|---|
void |
addClassDeclarationText(java.lang.String text) |
void |
addOdiKMTemplate(OdiKMTemplate odiKMTemplate)
Add the {link OdiKMTemplate}'s reference to this
AbstractComponentKM . |
void |
addOdiKMTemplateList(java.util.List odiKMTemplateList)
Add the list of {link OdiKMTemplate}'s to this
AbstractComponentKM . |
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) |
IProcedureLine |
findLine(java.lang.String nameText)
Find 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 ProcecureOptionGroup of this KM along with those of base KMs, eliminating groups with same name.
|
java.util.List |
getAllOptions() |
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() |
AbstractComponentKM |
getBaseComponentKM()
Returns the base component KM for this AbstractComponentKM
|
java.lang.String |
getClassDeclarationText() |
java.lang.String |
getComponentType() |
OdiTechnology |
getDefaultSourceTechnology()
Gets the default source technology of this OdiProcedure.
|
OdiTechnology |
getDefaultTargetTechnology()
Gets the default target technology of this OdiProcedure.
|
OdiIKMLine |
getDerivedSubSelectLine()
Return the predefined component KM line with derived subselect property
set to true, if any, else return null.
|
java.lang.String |
getDerivedSubSelectTemplate()
Return the derived subselect template that is defined in an IKM line
owned by this AbstractComponentKM, if any, else return null.
|
java.lang.String |
getExpectedUpstreamASTClassName() |
boolean |
getGenerateMTI()
Return whether this EKM is set up for the generation of multi-insert
statements.
|
java.util.List |
getInsertionLines(java.lang.String subtype)
Returns all the lines held by this
AbstractComponentKM that match the subtype. |
java.lang.String |
getIntegrationType()
Get the integration type for this KM.
|
IKnowledgeModule.KMType |
getKMType()
Must be overridden by other types.
|
java.lang.Class |
getLineType() |
IKnowledgeModule.LKMType |
getLKMType()
Get the LKM processing 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() |
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)
Return 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()
Get the intended code generation processing type for this AbstractComponentKM (SOURCE or TARGET).
|
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()
Get the source language for this KM.
|
ITechnology |
getSourceTechnology() |
java.lang.String |
getStaticBaseClassName()
Deprecated.
Use getStaticDelegateClassName, 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)
Get the subtype of this KM, for the specified processing type.
|
oracle.odi.domain.topology.language.OdiLanguage |
getTargetLanguage()
Get the target language for this KM.
|
ITechnology |
getTargetTechnology() |
java.lang.String |
getVariableDefScriptText() |
boolean |
hasGeneratorDelegate()
Return true if this KM has an explicit java or groovy generation delegate.
|
void |
initCustomTemplateOption()
Add a custom template option to the KM if it does not already exist.
|
boolean |
is11gKM() |
boolean |
isBaseKMLine(OdiProcedureLine line) |
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() |
boolean |
isMultiConnectLKM() |
boolean |
isProcedureLine(OdiProcedureLine line)
Return true if the specified line is part of this procedure or a base procedure.
|
boolean |
isSeeded()
Return true if this KM is a shipped, seeded 12c (or later) KM.
|
boolean |
isTransparentLKM() |
void |
removeOdiKMTemplate(OdiKMTemplate odiKMTemplate)
Remove the {link OdiKMTemplate}'s reference from this
AbstractComponentKM . |
void |
setBaseComponentKM(AbstractComponentKM base)
Sets the base component KM for this AbstractComponentKM
|
void |
setClassDeclarationText(java.lang.String text) |
void |
setComponentType(java.lang.String compType) |
void |
setDefaultsFromBaseKM()
Sets this AbstractComponentKM's flags's value (MultiConnectionSupported, LKMType and GenerateMTI), from its base KM.
|
void |
setExpectedUpstreamASTClassName(java.lang.String className) |
void |
setGenerateMTI(boolean pGenerateMTI)
Sets the flag to indicate whether this EKM is set up for the generation of
multi-insert statements.
|
void |
setIntegrationType(java.lang.String type)
Set the integration type for this KM.
|
void |
setIsSeeded(boolean value) |
void |
setLKMType(IKnowledgeModule.LKMType type) |
void |
setMultiConnectionSupported(boolean pMultiConnectionSupported)
Defines whether this OdiProcedure supports mulitConnection or not.
|
void |
setProcessingType(IKnowledgeModule.ProcessingType type)
Set the intended code generation processing type for this AbstractComponentKM (SOURCE or TARGET).
|
void |
setProducedASTClassName(java.lang.String name) |
void |
setSourceTechnology(ITechnology techno) |
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) |
void |
setTargetTechnology(ITechnology techno) |
void |
setVariableDefScriptText(java.lang.String text) |
getChecksum, getCustomizationStatus, getKMBuildNumber, getProject, isDefaultKM, isGlobal, isInstanceLevelSecurityNeeded, isSetBasedOperatorSupported, setChecksum, setDefaultKM, setKMBuildNumber, setProject, setSetBasedOperatorSupported, toString
addLine, addLine, addLine, addLine, addOption, addOption, addOptionGroup, addProcedureLine, addProcedureLine, addProcedureOption, dumpLineOrder, duplicateLine, duplicateOption, getDescription, getFlexFieldsValues, getInternalId, getLines, getOptionGroup, getOptionGroups, getOptionNames, getOptions, getOptionsWithNoGroup, getProcedureId, getProcedureOption, getTopLevelLines, initFlexFields, isMultiConnectionSupported, moveGroupAfterGroup, moveGroupBeforeGroup, moveLineAfter, moveLineBefore, moveLineToBottom, moveLineToTop, moveOptionAfter, moveOptionBefore, moveOptionToBottom, moveOptionToTop, removeLine, removeOption, removeOptionGroup, removeProcedureLine, setDefaultSourceTechnology, setDefaultTargetTechnology, setDescription, setName
getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, isNew, preCommit
equals, getBigNumericId, getGlobalId, getNumericId, getParent, hashCode
addProcedureOption, getDescription, getProcedureOption, isMultiConnectionSupported
addOptionGroup, addProcedureLine, addProcedureLine, addProcedureOption, getOptionGroup, removeProcedureLine
getBigNumericId, getGlobalId, getNumericId
getFirstDate, getFirstUser, getLastDate, getLastUser
getGlobalId, getParent
public static final java.lang.String SUBTYPE_ALL_LINES
public void setDefaultsFromBaseKM()
public void setBaseComponentKM(AbstractComponentKM base)
base
- public OdiProject getOdiProject()
public java.lang.String getComponentType()
public void setComponentType(java.lang.String compType)
public boolean isSeeded()
OdiKM
public void setIsSeeded(boolean value)
public boolean isHidden()
public AbstractComponentKM getBaseComponentKM()
public java.lang.String getStaticBaseClassName()
public void setProducedASTClassName(java.lang.String name)
public java.lang.String getProducedASTClassName()
IKnowledgeModule
getProducedASTClassName
in interface IKnowledgeModule
getProducedASTClassName
in class OdiKM
public void setExpectedUpstreamASTClassName(java.lang.String className)
public java.lang.String getExpectedUpstreamASTClassName()
public void setSubtype(java.lang.String subtype)
public void setSubtype(IKnowledgeModule.ProcessingType processingType, java.lang.String subtype)
processingType
- The processing type (SOURCE or TARGET) for which to set the subtype.subtype
- The subtype to set.public java.lang.String getSubtype()
public java.lang.String getSubtype(IKnowledgeModule.ProcessingType procType)
procType
- public void setLKMType(IKnowledgeModule.LKMType type)
public IKnowledgeModule.LKMType getLKMType()
getLKMType
in interface IKnowledgeModule
public void setProcessingType(IKnowledgeModule.ProcessingType type)
public IKnowledgeModule.ProcessingType getProcessingType()
getProcessingType
in interface IKnowledgeModule
public java.lang.String getIntegrationType()
getIntegrationType
in interface IKnowledgeModule
public void setIntegrationType(java.lang.String type)
public java.lang.String getASTClassName()
public void setVariableDefScriptText(java.lang.String text)
public void addVariableDefScriptText(java.lang.String text)
public java.lang.String getVariableDefScriptText()
public java.lang.String getClassDeclarationText()
public void addClassDeclarationText(java.lang.String text)
public void setClassDeclarationText(java.lang.String text)
public ITechnology getTargetTechnology()
public void setTargetTechnology(ITechnology techno)
public ITechnology getSourceTechnology()
public void setMultiConnectionSupported(boolean pMultiConnectionSupported)
OdiProcedure
Setting this will affect source technology. If set to false, source technology will be set to null.
setMultiConnectionSupported
in class OdiProcedure
pMultiConnectionSupported
- true
to make this procedure
supports mutliConnection, false
otherwiseOdiProcedure.isMultiConnectionSupported()
public OdiTechnology getDefaultSourceTechnology()
OdiProcedure
getDefaultSourceTechnology
in class OdiProcedure
OdiProcedure.setDefaultSourceTechnology(oracle.odi.domain.topology.OdiTechnology)
public OdiTechnology getDefaultTargetTechnology()
OdiProcedure
getDefaultTargetTechnology
in class OdiProcedure
OdiProcedure.setDefaultTargetTechnology(oracle.odi.domain.topology.OdiTechnology)
public void setSourceTechnology(ITechnology techno)
public boolean getGenerateMTI()
public void setGenerateMTI(boolean pGenerateMTI)
pGenerateMTI
- true if generate MTI, false if notpublic java.util.List getInsertionLines(java.lang.String subtype) throws oracle.odi.mapping.generation.GenerationException
AbstractComponentKM
that match the subtype.
This also includes the lines that match the subtype from the base KM if any.subtype
- - the subtype of the linesoracle.odi.mapping.generation.GenerationException
public java.util.List getAllLines(boolean resolved)
resolved
- public java.util.List getAllLines(boolean resolved, IProcedureLine.LineType lineType)
resolved
- lineType
- If non-null, then return only lines of the specified line type.public java.util.List getOwnedLines()
public java.util.List getOwnedLines(IProcedureLine.LineType lineType)
lineType
- The type to match.public java.util.List getProcedureLines()
IKnowledgeModule
getProcedureLines
in interface IKnowledgeModule
public IProcedureLine findLine(java.lang.String nameText)
nameText
- The text to look for in the KM line names.public void initCustomTemplateOption()
public ProcedureOption getOption(java.lang.String pName)
getOption
in class OdiProcedure
pName
- the name of the optionOdiProcedure.addOption(ProcedureOption)
public IKnowledgeModule.KMType getKMType()
getKMType
in interface IKnowledgeModule
public java.lang.String getName()
OdiProcedure
getName
in interface IFlexFieldUser
getName
in interface IModelObject
getName
in interface IOdiEntity
getName
in class OdiProcedure
OdiProcedure.setName(String)
public java.util.List getProcedureOptions()
IProcedure
getProcedureOptions
in interface IKnowledgeModule
getProcedureOptions
in interface IProcedure
getProcedureOptions
in class OdiProcedure
public java.util.List getAllOptions()
public IProcedureOption addProcedureOption(java.lang.String pOptionName, java.lang.Enum pType, java.lang.Object pDefaultValue)
IKnowledgeModule
addProcedureOption
in interface IKnowledgeModule
pOptionName
- The name of the new option.pType
- The type of the new option.pDefaultValue
- The default value for the new option.public boolean isMultiConnectIKM()
public boolean isMultiConnectLKM()
public boolean isProcedureLine(OdiProcedureLine line)
OdiProcedure
isProcedureLine
in class OdiProcedure
line
- The line to check.public boolean isBaseKMLine(OdiProcedureLine line)
public boolean isTransparentLKM()
public boolean hasGeneratorDelegate() throws oracle.odi.mapping.generation.GenerationException
oracle.odi.mapping.generation.GenerationException
public OdiIKMLine getDerivedSubSelectLine()
public java.lang.String getDerivedSubSelectTemplate()
public java.lang.Class getLineType()
getLineType
in class OdiProcedure
public boolean is11gKM()
public java.util.List getAllOptionGroups()
public java.util.List getAllOptionsWithNoGroup()
public oracle.odi.domain.topology.language.OdiLanguage getSourceLanguage()
public oracle.odi.domain.topology.language.OdiLanguage getTargetLanguage()
public java.util.List getOdiKMTemplateList()
OdiKMTemplate
's that are
referred by this AbstractComponentKM
.OdiKMTemplate
spublic void removeOdiKMTemplate(OdiKMTemplate odiKMTemplate)
AbstractComponentKM
.odiKMTemplate
- the KM template to be removedpublic void addOdiKMTemplate(OdiKMTemplate odiKMTemplate)
AbstractComponentKM
.odiKMTemplate
- the KM template to be addedpublic void addOdiKMTemplateList(java.util.List odiKMTemplateList)
AbstractComponentKM
.odiKMTemplateList
- the list of KM templates to be added