public interface IMicroPatternProcessingContext
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
copyright |
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<java.lang.Object> |
generationReferenceIterator() |
java.util.Iterator<java.lang.String> |
getAllAttributeNames() |
java.lang.String |
getAttribute(java.lang.String attributeName) |
java.lang.Object |
getData(java.lang.String key) |
com.ibm.pdp.engine.IGeneratedInfo |
getGeneratedInfo() |
IMicroPatternGenerationProperties |
getGenerationProperties()
Returns the generation properties.
|
int |
getStatus() |
void |
registerGenerationReference(java.lang.Object reference)
Convenience method to help collect generation references during the processing of MPs
|
void |
setAttribute(java.lang.String attributeName,
java.lang.String value)
Sets the given attribute in the Micro-Pattern Processing Context so that it is available for further reference by
Micro-Pattern handlers.
A best practice for Micro-Pattern handlers is to prefix the attribute's name by the namespace. |
void |
setData(java.lang.String key,
java.lang.Object data)
Sets the given Object data in the Micro-Pattern Processing Context so that it is available for further reference by
Micro-Pattern handlers.
A best practice for Micro-Pattern handlers is to prefix the data key by the namespace. |
void |
setGenerationProperties(IMicroPatternGenerationProperties properties)
Sets the generation properties.
|
void |
setStatus(int status,
int location,
java.lang.String msg,
java.lang.String userAction)
Sets the current processing status, message and associated action
In case status is IMicroPattern.UNRECOVERABLE_ERROR or IMicroPattern.WARNING_RAISED the getStatus() method will no more return IMicroPattern.STATUS_OK .The higher status will always remain active, so that setting status IMicroPattern.UNRECOVERABLE_ERROR then IMicroPattern.WARNING_RAISED will
lead to the getStatus() method to return IMicroPattern.UNRECOVERABLE_ERROR |
java.util.Iterator<com.ibm.pdp.engine.extension.IProcessingStatus> |
statusStack() |
static final java.lang.String copyright
java.util.Iterator<java.lang.Object> generationReferenceIterator()
java.util.Iterator<java.lang.String> getAllAttributeNames()
java.lang.String getAttribute(java.lang.String attributeName)
attributeName
- java.lang.Object getData(java.lang.String key)
key
- com.ibm.pdp.engine.IGeneratedInfo getGeneratedInfo()
IMicroPatternGenerationProperties getGenerationProperties()
int getStatus()
void registerGenerationReference(java.lang.Object reference)
reference
- key
- void setAttribute(java.lang.String attributeName, java.lang.String value)
com.ibm.pdp.pacbase.MyBooleanAttribute="true"
may be a good choice
whereas MyBooleanAttribute="true"
may not be explicit enoughattributeName
- value
- void setData(java.lang.String key, java.lang.Object data)
com.ibm.pdp.pacbase.MyBooleanAttribute
may be a good choice
whereas MyBooleanAttribute
may not be explicit enoughkey
- data
- void setGenerationProperties(IMicroPatternGenerationProperties properties)
void setStatus(int status, int location, java.lang.String msg, java.lang.String userAction)
IMicroPattern.UNRECOVERABLE_ERROR
or IMicroPattern.WARNING_RAISED
getStatus()
method will no more return IMicroPattern.STATUS_OK
.IMicroPattern.UNRECOVERABLE_ERROR
IMicroPattern.WARNING_RAISED
will
lead to the getStatus()
method to return IMicroPattern.UNRECOVERABLE_ERROR
status
- The current processing context Status. May be IMicroPattern.STATUS_OK
(default),
IMicroPattern.WARNING_RAISED
or IMicroPattern.UNRECOVERABLE_ERROR
location
- the location in source code to which associate this status, or 0msg
- The associated message for the current status. This field shouldn't be nulluserAction
- An optional user action aimed at resolving the WARNING or UNRECOVERABLE ERROR. May be nulljava.util.Iterator<com.ibm.pdp.engine.extension.IProcessingStatus> statusStack()