public abstract class ValidatedMarkerExpressionGrammar
extends atg.ui.scenario.expression.DefaultGrammarExtension
The predefined keys and values are provided by the component with the nucleus path defined by the componentPathWithKeysValues property.
Implementations of this class must provide the grammar rule ids for the marker actions/expressions, and the path to the component that supplies the keys and values.
The rules identified by the abstract methods are dynamically constructes using the keys/value provided by the component defined by the componentPathWithKeysValues property.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ADD_MARKER_VALUE_INTRO_RULE_ID
the ruleid used between key and value parameters in the sceneario ui
|
static java.lang.String |
CLASS_VERSION
class versioning info
|
static java.lang.String |
HAS_MARKER_VALUE_INTRO_RULE_ID
the ruleid used between key and value parameters in the sceneario ui for has marker expression
|
static java.lang.String |
HASLAST_MARKER_VALUE_INTRO_RULE_ID
the ruleid used between key and value parameters in the sceneario ui for haslast marker expression
|
static java.lang.String |
HASLASTMARKERWITHKEY_VALUE_INTRO_RULE_ID
the ruleid used between key and value parameters of the hasLastMarkerWithKey expression
|
static java.lang.String |
KEY_VALUE_PROPERTY_NAME
the property used to get the validated keys and values
|
static java.lang.String |
REMOVE_MARKER_VALUE_INTRO_RULE_ID
the ruleid used between key and value parameters in the sceneario u for remove marker actions
|
Constructor and Description |
---|
ValidatedMarkerExpressionGrammar(java.lang.String pGrammarFileTemplate) |
Modifier and Type | Method and Description |
---|---|
protected void |
addAddActionDefaultKeyValueChoice(atg.ui.expreditor.ChoiceRule pChoiceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar,
java.lang.String pValueIntroTextRuleId)
Adds an action key parameter sequence for the provided key value.
|
protected void |
addAnyValueChoice(atg.ui.expreditor.ChoiceRule pSequenceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar) |
protected void |
addConditionKeyParamSequenceRule(java.lang.String pKey,
atg.ui.expreditor.SequenceRule pKeySequenceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
Adds a key parameter sequence rule for a marker conditional.
|
protected void |
addConditionValueChoiceRule(java.util.Collection pValues,
atg.ui.expreditor.SequenceRule pKeySequenceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
Creates a choice element that contains value param choices.
|
protected void |
addHasConditionDefaultKeyValueChoice(atg.ui.expreditor.ChoiceRule pChoiceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar,
java.lang.String pValueIntroTextRuleId,
boolean pIncludeAnyValueKey) |
protected void |
addKeyParamSequenceRule(java.lang.String pKey,
atg.ui.expreditor.SequenceRule pSequenceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
Adds an action key parameter sequence for the provided key value.
|
protected void |
addKeyParamSequenceRuleForCondition(java.lang.String pKey,
atg.ui.expreditor.SequenceRule pSequenceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
Adds an action key parameter sequence for the provided key value.
|
protected void |
addKeyValueChoicesForActionParam(atg.ui.expreditor.ChoiceRule pChoiceRule,
java.util.Map pValidatedKeyValues,
java.lang.String pValueIntroTextRuleId,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar,
boolean pIncludeAnyValue) |
protected void |
addKeyValueChoicesForConditionParam(atg.ui.expreditor.ChoiceRule pChoiceRule,
java.util.Map pValidatedKeyValues,
java.lang.String pValueIntroTextRuleId,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar) |
protected void |
addLiteralChoiceToken(java.lang.String pChoiceValue,
atg.ui.expreditor.ChoiceRule pChoiceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
add a token expression for a literal value.
|
protected void |
addNullChoice(atg.ui.expreditor.ChoiceRule pSequenceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar) |
protected void |
addRemoveActionDefaultKeyValueChoice(atg.ui.expreditor.ChoiceRule pChoiceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar,
java.lang.String pValueIntroTextRuleId)
Adds an action key parameter sequence for the provided key value.
|
protected void |
addScenarioExpression(atg.ui.expreditor.ChoiceRule pChoiceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar) |
protected void |
addScenarioExpression(atg.ui.expreditor.SequenceRule pSequenceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar) |
protected void |
addStringChoice(atg.ui.expreditor.ChoiceRule pChoiceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar) |
protected void |
addValueChoiceRule(java.util.Collection pValues,
atg.ui.expreditor.SequenceRule pKeySequenceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar,
boolean pIncludeAnyValue)
Creates a choice element that contains value param choices.
|
protected void |
addValueParamIntroConstruct(atg.ui.expreditor.ChoiceRule pChoiceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar,
java.lang.String pValueIntroTextRuleId) |
protected void |
addValueParamIntroConstruct(atg.ui.expreditor.SequenceRule pSequenceRule,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar,
java.lang.String pValueIntroTextRuleId) |
void |
completeExtendedGrammar(atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
This method is called to extend the grammar specification.
|
protected atg.ui.expreditor.SequenceRule |
createActionParamSequenceRule(java.lang.String pParamName,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar) |
protected atg.ui.expreditor.SequenceRule |
createConditionParamSequenceRule(atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar) |
protected atg.ui.expreditor.SequenceRule |
createConstantActionParamSequenceRule(java.lang.String pParamName,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar) |
protected atg.ui.expreditor.SequenceRule |
createConstantConditionParamSequenceRule(atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar) |
abstract java.lang.String |
getAddMarkerRuleId()
Should return the grammar rule id for the dynamic add marker key/values
|
java.lang.String |
getAddMarkerValueIntroTextRuleId() |
abstract java.lang.String |
getComponentPathWithKeyValues()
Should return the path to the component used for
obtaining the validated keys and values.
|
abstract java.lang.String |
getHasLastMarkerRuleId()
Should return the grammar rule id for the dynamic hasLastMarker key/values
|
java.lang.String |
getHasLastMarkerValueIntroTextRuleId() |
abstract java.lang.String |
getHasLastMarkerWithKeyRuleId()
Should return the grammar rule id for the dynamic hasMarker and
hasLastMarkerWithKey key/values
|
java.lang.String |
getHasLastMarkerWithKeyValueIntroTextRuleId() |
abstract java.lang.String |
getHasMarkerRuleId()
Should return the grammar rule id for the dynamic hasMarker key/values
|
java.lang.String |
getHasMarkerValueIntroTextRuleId() |
protected java.util.Map |
getKeyValueMapFromComponent(atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
This method is called by completeExtendedGrammar to return the
key/value map from the component.
|
java.lang.String |
getPropertyNameForKeysAndValues()
Should return the property name that contains the map of
keys and values.
|
abstract java.lang.String |
getRemoveMarkerRuleId()
Should return the grammar rule id for the dynamic remove marker key/values
|
java.lang.String |
getRemoveMarkerValueIntroTextRuleId() |
protected void |
populateAddMarkerKeyValueChoices(java.util.Map pValidatedKeyValues,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
Populate the key-value choice construct for the add marker action
rule.
|
protected void |
populateHasLastMarkerKeyValueChoices(java.util.Map pValidatedKeyValues,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
Populates a key-value choice construct for has last marker expression rule.
|
protected void |
populateHasLastMarkerWithKeyKeyValueChoices(java.util.Map pValidatedKeyValues,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
Populates a key-value choice construct for hasLastMarkerWithKey expression rule.
|
protected void |
populateHasMarkerKeyValueChoices(java.util.Map pValidatedKeyValues,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
Populates a key-value choice construct for has marker expression rule.
|
protected void |
populateRemoveMarkerKeyValueChoices(java.util.Map pValidatedKeyValues,
atg.xcl.XclContext pContext,
atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
Populate the key-value choice construct for the marker remove action
rule.
|
public static java.lang.String CLASS_VERSION
public static final java.lang.String KEY_VALUE_PROPERTY_NAME
public static final java.lang.String ADD_MARKER_VALUE_INTRO_RULE_ID
public static final java.lang.String REMOVE_MARKER_VALUE_INTRO_RULE_ID
public static final java.lang.String HAS_MARKER_VALUE_INTRO_RULE_ID
public static final java.lang.String HASLAST_MARKER_VALUE_INTRO_RULE_ID
public static final java.lang.String HASLASTMARKERWITHKEY_VALUE_INTRO_RULE_ID
public ValidatedMarkerExpressionGrammar(java.lang.String pGrammarFileTemplate)
public abstract java.lang.String getAddMarkerRuleId()
public abstract java.lang.String getRemoveMarkerRuleId()
public abstract java.lang.String getHasMarkerRuleId()
public abstract java.lang.String getHasLastMarkerRuleId()
public abstract java.lang.String getHasLastMarkerWithKeyRuleId()
public java.lang.String getPropertyNameForKeysAndValues()
public java.lang.String getAddMarkerValueIntroTextRuleId()
public java.lang.String getRemoveMarkerValueIntroTextRuleId()
public java.lang.String getHasMarkerValueIntroTextRuleId()
public java.lang.String getHasLastMarkerValueIntroTextRuleId()
public java.lang.String getHasLastMarkerWithKeyValueIntroTextRuleId()
public abstract java.lang.String getComponentPathWithKeyValues()
protected java.util.Map getKeyValueMapFromComponent(atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
public void completeExtendedGrammar(atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
completeExtendedGrammar
in interface atg.ui.process.expression.ProcessExpressionGrammarExtension
completeExtendedGrammar
in class atg.ui.process.expression.DefaultProcessExpressionGrammarExtension
protected void addValueChoiceRule(java.util.Collection pValues, atg.ui.expreditor.SequenceRule pKeySequenceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar, boolean pIncludeAnyValue)
protected void addConditionValueChoiceRule(java.util.Collection pValues, atg.ui.expreditor.SequenceRule pKeySequenceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected void addStringChoice(atg.ui.expreditor.ChoiceRule pChoiceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected void addLiteralChoiceToken(java.lang.String pChoiceValue, atg.ui.expreditor.ChoiceRule pChoiceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected void addKeyParamSequenceRule(java.lang.String pKey, atg.ui.expreditor.SequenceRule pSequenceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected void addKeyParamSequenceRuleForCondition(java.lang.String pKey, atg.ui.expreditor.SequenceRule pSequenceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected void addAddActionDefaultKeyValueChoice(atg.ui.expreditor.ChoiceRule pChoiceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar, java.lang.String pValueIntroTextRuleId)
protected void addRemoveActionDefaultKeyValueChoice(atg.ui.expreditor.ChoiceRule pChoiceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar, java.lang.String pValueIntroTextRuleId)
protected void addHasConditionDefaultKeyValueChoice(atg.ui.expreditor.ChoiceRule pChoiceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar, java.lang.String pValueIntroTextRuleId, boolean pIncludeAnyValueKey)
protected atg.ui.expreditor.SequenceRule createConstantConditionParamSequenceRule(atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected atg.ui.expreditor.SequenceRule createConstantActionParamSequenceRule(java.lang.String pParamName, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected atg.ui.expreditor.SequenceRule createActionParamSequenceRule(java.lang.String pParamName, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected atg.ui.expreditor.SequenceRule createConditionParamSequenceRule(atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected void addValueParamIntroConstruct(atg.ui.expreditor.ChoiceRule pChoiceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar, java.lang.String pValueIntroTextRuleId)
protected void addValueParamIntroConstruct(atg.ui.expreditor.SequenceRule pSequenceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar, java.lang.String pValueIntroTextRuleId)
protected void addScenarioExpression(atg.ui.expreditor.SequenceRule pSequenceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected void addScenarioExpression(atg.ui.expreditor.ChoiceRule pChoiceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected void addNullChoice(atg.ui.expreditor.ChoiceRule pSequenceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected void addAnyValueChoice(atg.ui.expreditor.ChoiceRule pSequenceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected void addKeyValueChoicesForActionParam(atg.ui.expreditor.ChoiceRule pChoiceRule, java.util.Map pValidatedKeyValues, java.lang.String pValueIntroTextRuleId, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar, boolean pIncludeAnyValue)
protected void addKeyValueChoicesForConditionParam(atg.ui.expreditor.ChoiceRule pChoiceRule, java.util.Map pValidatedKeyValues, java.lang.String pValueIntroTextRuleId, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected void addConditionKeyParamSequenceRule(java.lang.String pKey, atg.ui.expreditor.SequenceRule pKeySequenceRule, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
protected void populateAddMarkerKeyValueChoices(java.util.Map pValidatedKeyValues, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
pValidatedKeyValues
- the map of validated key/values.pContext
- the context object which acts as a context for a set
of UI components created from a single XCL templatepGrammar
- the process expression context object.protected void populateRemoveMarkerKeyValueChoices(java.util.Map pValidatedKeyValues, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
pValidatedKeyValues
- the map of validated key/values.pContext
- the context object which acts as a context for a set
of UI components created from a single XCL templatepGrammar
- the process expression context object.protected void populateHasMarkerKeyValueChoices(java.util.Map pValidatedKeyValues, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
pValidatedKeyValues
- the map of validated key/values.pContext
- the context object which acts as a context for a set
of UI components created from a single XCL templatepGrammar
- the process expression context object.protected void populateHasLastMarkerKeyValueChoices(java.util.Map pValidatedKeyValues, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
pValidatedKeyValues
- the map of validated key/values.pContext
- the context object which acts as a context for a set
of UI components created from a single XCL templatepGrammar
- the process expression context object.protected void populateHasLastMarkerWithKeyKeyValueChoices(java.util.Map pValidatedKeyValues, atg.xcl.XclContext pContext, atg.ui.process.expression.ProcessExpressionGrammar pGrammar)
pValidatedKeyValues
- the map of validated key/values.pContext
- the context object which acts as a context for a set
of UI components created from a single XCL templatepGrammar
- the process expression context object.