public class TemplateUtils
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
TemplateUtils.LocalTemplate |
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 and Description |
---|
TemplateUtils(AdapterBase adapter,
ILanguage baseLanguage,
ITechnology techno) |
TemplateUtils(AdapterBase adapter,
java.lang.String baseLanguage,
ITechnology techno) |
TemplateUtils(TemplateUtils templateUtils,
ITechnology techno) |
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.
|
public static final java.lang.String LANGUAGE_NONE
public TemplateUtils(AdapterBase adapter, ILanguage baseLanguage, ITechnology techno) throws AdapterException
AdapterException
public TemplateUtils(AdapterBase adapter, java.lang.String baseLanguage, ITechnology techno) throws AdapterException
AdapterException
public TemplateUtils(TemplateUtils templateUtils, ITechnology techno) throws AdapterException
AdapterException
public ITechnology getTechno()
public java.lang.String getLanguage()
public AdapterBase getAdapter()
public static java.lang.String getDefaultBaseLanguageName(ITechnology techno)
public void addLocalTemplateOverride(java.lang.String templateName, java.lang.String baseLanguageName, java.lang.String technoName, java.lang.String text, boolean isGeneric, boolean isReplicateNewlines)
public void addLocalTemplateOverride(ITemplate template)
public ITemplate getTemplate(java.lang.String subtemplateName)
public ITemplate getTemplate(java.lang.String subtemplateName, boolean globalOnly)
public java.lang.String getTemplateText(java.lang.String subtemplateName)
public java.util.Map getTemplateOptionMap(java.lang.String subtemplateName)
public java.lang.String getTemplateText(java.lang.Class astClass)
public java.lang.String getExpandedTemplateText(java.lang.String subtemplate, boolean expandAll) throws ParseException
ParseException
public java.lang.String getExpandedTemplateText(java.lang.String subtemplate, java.util.List includedTemplateNames, boolean expandAll) throws ParseException
ParseException
public ITemplate findTemplate(AbstractSyntaxTree ASTObject)
ASTObject
- public static java.lang.reflect.Method getStaticMethod(java.lang.Class type, java.lang.String methodName, java.lang.Class[] params)
public java.lang.String findTemplateText(AbstractSyntaxTree ASTObject)
public static java.lang.String getTemplateDeclaration(java.lang.String name, java.lang.String baseLanguageName, java.lang.String technologyName, boolean isLocalOverride)
public static java.lang.String getTemplateDeclaration(ITemplate template)
public static java.lang.String getIncludeDeclaration(java.lang.String subtemplateName)
public java.util.Map recalculateVarsAndPush()
public java.util.Map pushVariableStackFrame(java.util.Map localVars)
localVars
- public java.util.Map addVariablesToCurrentFrame(java.util.Map localVars)
public void popVariableStackFrame()
public java.lang.String getParsedTemplateText(java.lang.String templateName, java.util.Map variableMap) throws GenerationException
templateName
- The template name.variableMap
- the substitution variable map.GenerationException