public abstract class AbstractSyntaxTree
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
AbstractSyntaxTree.LogCounter
Type safe enum that represents different log counter types defined for a task.
|
Modifier and Type | Method and Description |
---|---|
abstract java.util.List |
getChildren()
Get the list of child objects owned by this substitution API object.
|
ITemplate |
getCodeGenerationTemplate()
Get the top-level global code generation template associated with this substitution API object.
|
static java.lang.String |
getCodeGenerationTemplateName(java.lang.Class astClassType)
Get the name of the top-level global template associated with the AST class type.
|
java.lang.String |
getCustomTemplate()
Returns the custom template that has been set for this object, if any, else null.
|
abstract java.util.List |
getExpressions()
Get a list of expressions owned by this substitution API object.
|
java.lang.String |
getKMName()
Return the name of the KM that generated this AST, or null if it was not generated by a KM.
|
java.util.List |
getLeafLevelChildren()
Get a list of leaf-level or lowest level children in this substitution API object tree.
|
MapPhysicalNode |
getMapPhysicalNode()
Get the map physical node that created this substitution API object.
|
java.lang.Integer |
getOrder()
Get the order of this node, if this node is part of an ordered list of AST objects.
|
AbstractSyntaxTree |
getParentAST()
Get the parent substitution API object for this child object.
|
AbstractSyntaxTree |
getParentOfType(java.lang.Class type)
Navigate up the parent hierarchy in this AST tree to find the first
parent of the specified class type.
|
java.lang.Object |
getPropertyValue(java.lang.String name)
Get the value of a named property for the AST object.
|
ILanguage |
getSourceLanguage()
Get the source language that is generated by this AST object, if any, else null.
|
ILocation |
getSourceLocation()
Get source location information for this AST, if any is defined, else return null.
|
ITechnology |
getSourceTechnology()
Get the source technology for this AST, if any available, else return null.
|
java.lang.String |
getSourceText()
Get the source text associated with this substitution API object, if any is defined, else null.
|
ILanguage |
getTargetLanguage()
Get the target language that is generated by this AST object, if any, else null.
|
ILocation |
getTargetLocation()
Get target location information for this AST, if any is defined, else return null.
|
ITechnology |
getTargetTechnology()
Get target technology information for this AST, if any is defined, else return null.
|
java.lang.String |
getTargetText()
Get the target text generated by this substitution API object.
|
abstract java.util.Map |
getTemplateSubstitutionMap()
Get a hash map containing built-in template substitution variable names as the hash key,
and the substitution variable value as values.
|
java.lang.String |
getText()
Get the generated text for this substitution API object.
|
abstract java.lang.String |
getType()
Get a class type string for this substitution API object.
|
boolean |
hasCustomTemplate()
Return true if this substitution API object has a custom template defined.
|
boolean |
hasSourceAndTargetText()
Return true if this object has both source and target text available, else false.
|
boolean |
isLeafLevelNode()
Return true if this substitution API object is a leaf-level node in the current substitution API tree.
|
boolean |
isPushFromSource()
Return true if this AST should push data from source, where the target command must be moved to
the source data server to execute.
|
public abstract java.lang.String getType()
public abstract java.util.List getChildren()
public boolean isLeafLevelNode()
public java.util.List getLeafLevelChildren()
public AbstractSyntaxTree getParentOfType(java.lang.Class type)
type
- The type of parent to find.public AbstractSyntaxTree getParentAST()
public java.lang.String getText() throws GenerationException
GenerationException
public ITemplate getCodeGenerationTemplate()
public static java.lang.String getCodeGenerationTemplateName(java.lang.Class astClassType)
astClassType
- The class type of the substitution API object for which to retrieve the top-level global template.public boolean hasSourceAndTargetText()
public abstract java.util.Map getTemplateSubstitutionMap()
public abstract java.util.List getExpressions()
public java.lang.String getSourceText() throws GenerationException
GenerationException
public java.lang.String getTargetText() throws GenerationException
GenerationException
public ILocation getSourceLocation() throws GenerationException
GenerationException
public ILocation getTargetLocation() throws GenerationException
GenerationException
public ITechnology getSourceTechnology() throws GenerationException
GenerationException
public ILanguage getSourceLanguage() throws GenerationException
GenerationException
public ITechnology getTargetTechnology() throws GenerationException
GenerationException
public ILanguage getTargetLanguage() throws GenerationException
GenerationException
public java.lang.Object getPropertyValue(java.lang.String name)
name
- The property name.public java.lang.String getKMName()
public java.lang.String getCustomTemplate()
public boolean hasCustomTemplate()
public boolean isPushFromSource()
public MapPhysicalNode getMapPhysicalNode()
public java.lang.Integer getOrder()