oracle.odi.mapping.generation

Class TemplateUtils

java.lang.Object

oracle.odi.mapping.generation.TemplateUtils

public class TemplateUtils
extends java.lang.Object

A class representing a set of templates for a particular technology and base language, with some overridden templates.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateUtils.LocalTemplate

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LANGUAGE_NONE A keyword used for the base language name of a KM template, if no language is defined for the template.

Constructor Summary

Constructors

Constructor and Description
TemplateUtils(AdapterBase adapter, ILanguage baseLanguage, ITechnology techno)
TemplateUtils(AdapterBase adapter, java.lang.String baseLanguage, ITechnology techno)
TemplateUtils(TemplateUtils templateUtils, ITechnology techno)

Method Summary

Modifier and Type	Method and Description
void	addLocalTemplateOverride(ITemplate template)
void	addLocalTemplateOverride(java.lang.String templateName, java.lang.String baseLanguageName, java.lang.String technoName, java.lang.String text, boolean isGeneric, boolean isReplicateNewlines)
java.util.Map	addVariablesToCurrentFrame(java.util.Map localVars) Add a set of variables to the current local template variable stack frame.
ITemplate	findTemplate(AbstractSyntaxTree ASTObject) Find template text for a specified AST object, which may be a query or some other language object.
java.lang.String	findTemplateText(AbstractSyntaxTree ASTObject)
AdapterBase	getAdapter()
static java.lang.String	getDefaultBaseLanguageName(ITechnology techno)
java.lang.String	getExpandedTemplateText(java.lang.String subtemplate, boolean expandAll)
java.lang.String	getExpandedTemplateText(java.lang.String subtemplate, java.util.List includedTemplateNames, boolean expandAll)
static java.lang.String	getIncludeDeclaration(java.lang.String subtemplateName)
java.lang.String	getLanguage()
java.lang.String	getParsedTemplateText(java.lang.String templateName, java.util.Map variableMap) Gets the parsed template text.
static java.lang.reflect.Method	getStaticMethod(java.lang.Class type, java.lang.String methodName, java.lang.Class[] params)
ITechnology	getTechno()
ITemplate	getTemplate(java.lang.String subtemplateName)
ITemplate	getTemplate(java.lang.String subtemplateName, boolean globalOnly)
static java.lang.String	getTemplateDeclaration(ITemplate template)
static java.lang.String	getTemplateDeclaration(java.lang.String name, java.lang.String baseLanguageName, java.lang.String technologyName, boolean isLocalOverride)
java.util.Map	getTemplateOptionMap(java.lang.String subtemplateName)
java.lang.String	getTemplateText(java.lang.Class astClass)
java.lang.String	getTemplateText(java.lang.String subtemplateName)
void	popVariableStackFrame() Pop the variable stack frame to the parent frame.
java.util.Map	pushVariableStackFrame(java.util.Map localVars) Push the specified local variables onto the global shared variable stack.
java.util.Map	recalculateVarsAndPush() Re-run the KM local groovy variable definition script to recalculate the KM-local variable values for a new set of AST objects.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LANGUAGE_NONE

public static final java.lang.String LANGUAGE_NONE

A keyword used for the base language name of a KM template, if no language is defined for the template.

See Also:

Constant Field Values

Constructor Detail

TemplateUtils

public TemplateUtils(AdapterBase adapter,
                     ILanguage baseLanguage,
                     ITechnology techno)
              throws AdapterException

Throws:

AdapterException

TemplateUtils

public TemplateUtils(AdapterBase adapter,
                     java.lang.String baseLanguage,
                     ITechnology techno)
              throws AdapterException

Throws:

AdapterException

TemplateUtils

public TemplateUtils(TemplateUtils templateUtils,
                     ITechnology techno)
              throws AdapterException

Throws:

AdapterException

Method Detail

getTechno

public ITechnology getTechno()

getLanguage

public java.lang.String getLanguage()

getAdapter

public AdapterBase getAdapter()

getDefaultBaseLanguageName

public static java.lang.String getDefaultBaseLanguageName(ITechnology techno)

addLocalTemplateOverride

public void addLocalTemplateOverride(java.lang.String templateName,
                                     java.lang.String baseLanguageName,
                                     java.lang.String technoName,
                                     java.lang.String text,
                                     boolean isGeneric,
                                     boolean isReplicateNewlines)

addLocalTemplateOverride

public void addLocalTemplateOverride(ITemplate template)

getTemplate

public ITemplate getTemplate(java.lang.String subtemplateName)

getTemplate

public ITemplate getTemplate(java.lang.String subtemplateName,
                             boolean globalOnly)

getTemplateText

public java.lang.String getTemplateText(java.lang.String subtemplateName)

getTemplateOptionMap

public java.util.Map getTemplateOptionMap(java.lang.String subtemplateName)

getTemplateText

public java.lang.String getTemplateText(java.lang.Class astClass)

getExpandedTemplateText

public java.lang.String getExpandedTemplateText(java.lang.String subtemplate,
                                                boolean expandAll)
                                         throws ParseException

Throws:

ParseException

getExpandedTemplateText

public java.lang.String getExpandedTemplateText(java.lang.String subtemplate,
                                                java.util.List includedTemplateNames,
                                                boolean expandAll)
                                         throws ParseException

Throws:

ParseException

findTemplate

public ITemplate findTemplate(AbstractSyntaxTree ASTObject)

Find template text for a specified AST object, which may be a query or some other language object. The template name will match the simple class name of the object, or one of it's superclasses.

Parameters:

ASTObject -

Returns:

getStaticMethod

public static java.lang.reflect.Method getStaticMethod(java.lang.Class type,
                                                       java.lang.String methodName,
                                                       java.lang.Class[] params)

findTemplateText

public java.lang.String findTemplateText(AbstractSyntaxTree ASTObject)

getTemplateDeclaration

public static java.lang.String getTemplateDeclaration(java.lang.String name,
                                                      java.lang.String baseLanguageName,
                                                      java.lang.String technologyName,
                                                      boolean isLocalOverride)

getTemplateDeclaration

public static java.lang.String getTemplateDeclaration(ITemplate template)

getIncludeDeclaration

public static java.lang.String getIncludeDeclaration(java.lang.String subtemplateName)

recalculateVarsAndPush

public java.util.Map recalculateVarsAndPush()

Re-run the KM local groovy variable definition script to recalculate the KM-local variable values for a new set of AST objects. This call will push the variable stack frame down one. After the call and after the parser is run, the popVariableStackFrame call should be done.

pushVariableStackFrame

public java.util.Map pushVariableStackFrame(java.util.Map localVars)

Push the specified local variables onto the global shared variable stack. The new stack frame will include the parent values plus the new local values.

Parameters:

localVars -

Returns:

The new local variable stack frame.

addVariablesToCurrentFrame

public java.util.Map addVariablesToCurrentFrame(java.util.Map localVars)

Add a set of variables to the current local template variable stack frame.

popVariableStackFrame

public void popVariableStackFrame()

Pop the variable stack frame to the parent frame. Add all child frame values to all parent frames, if the parent frame doesn't have a value for the variable name.

getParsedTemplateText

public java.lang.String getParsedTemplateText(java.lang.String templateName,
                                              java.util.Map variableMap)
                                       throws GenerationException

Gets the parsed template text.

Parameters:

templateName - The template name.

variableMap - the substitution variable map.

Returns:

the parsed template text.

Throws:

GenerationException