public abstract class CustomizableCommand extends Command
Important: before API user can call setPlaceholderValue(key, value), make sure the method beginCustomization() is called. The method beginCustomization() initiates the placeholder map to its default state, containing no customized keys and values.
AbstractSyntaxTree.LogCounter
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PIG_PROPKEY_REGISTER_PATHS
The Pig Latin property for a list of register path strings.
|
Modifier and Type | Method and Description |
---|---|
void |
addPlaceHolderKey(java.lang.String key)
Adds a new placeholder key.
|
void |
beginCustomizePlaceholderValues()
Marks the beginning of customization of the placeholder values for this command.
|
void |
beginLogicalCustomization()
Marks the beginning of customization of this command using supported set* method and setPropertyValue of
predefined properties.
|
java.lang.Object |
getPropertyValue(java.lang.String key)
Gets property value for a property key for this command.
|
void |
removePlaceholderKey(java.lang.String key)
Removes a placeholder key.
|
void |
setPlaceholderValue(java.lang.String key,
java.lang.Object value)
Sets the value for a placeholder key.
|
addSourceAlias, calculateOutputSchema, clearSourceAliases, convertExprs, getChildren, getExpressions, getExprText, getExprText, getParentScript, getPhysicalNode, getPlaceholderKeys, getPlaceholderMap, getSourceAlias, getSourceAliases, getTargetAlias, getTemplateSubstitutionMap, getText, getType, getTypeEnum, isDecorator, isSelector, setParentScript, setSourceAlias, setSourceAliases, setTargetAlias, toString
getCodeGenerationTemplate, getCodeGenerationTemplateName, getCustomTemplate, getKMName, getLeafLevelChildren, getMapPhysicalNode, getOrder, getParentAST, getParentOfType, getSourceLanguage, getSourceLocation, getSourceTechnology, getSourceText, getTargetLanguage, getTargetLocation, getTargetTechnology, getTargetText, hasCustomTemplate, hasSourceAndTargetText, isLeafLevelNode, isPushFromSource
public static final java.lang.String PIG_PROPKEY_REGISTER_PATHS
public void addPlaceHolderKey(java.lang.String key)
key
- - the new placeholder key to be added.public void removePlaceholderKey(java.lang.String key) throws GenerationException
key
- - the placeholder key to be removed.GenerationException
public void beginLogicalCustomization() throws GenerationException
GenerationException
public void beginCustomizePlaceholderValues() throws GenerationException
GenerationException
public void setPlaceholderValue(java.lang.String key, java.lang.Object value) throws GenerationException
key
- - the placeholder key whose value is to be setvalue
- - the value for the placeholder key in the placeholder mapGenerationException
public java.lang.Object getPropertyValue(java.lang.String key)
getPropertyValue
in class AbstractSyntaxTree
key
- - the key for the property to be retrieved