|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IMicroPatternProcessingContext
An IMicroPatternProcessingContext is associated with a IMicroPattern to further describe the processing context in which this Micro Pattern expanding occurs
| Field Summary | |
|---|---|
static java.lang.String |
copyright
|
| Method Summary | |
|---|---|
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()
|
boolean |
inUserCode()
|
java.util.Iterator |
referenceIterator()
|
void |
registerReference(java.lang.Object reference)
Convenience method to help collect 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. |
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. |
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_RAISEDthe getStatus() method will no more return IMicroPattern.STATUS_OK. |
java.util.Iterator<com.ibm.pdp.engine.extension.IProcessingStatus> |
statusStack()
|
| Field Detail |
|---|
static final java.lang.String copyright
| Method Detail |
|---|
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()
boolean inUserCode()
java.util.Iterator referenceIterator()
void registerReference(java.lang.Object reference)
reference - key -
void setAttribute(java.lang.String attributeName,
java.lang.String value)
com.ibm.pdp.pacbase.LoopIndiceGenerated="true" may be a good choice
whereas LoopIndiceGenerated="true" may not be explicit enough
attributeName - value -
void setData(java.lang.String key,
java.lang.Object data)
com.ibm.pdp.pacbase.LoopIndiceGenerated may be a good choice
whereas LoopIndiceGenerated may not be explicit enough
key - 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_RAISEDgetStatus() method will no more return IMicroPattern.STATUS_OK.IMicroPattern.UNRECOVERABLE_ERRORIMicroPattern.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_ERRORlocation - 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()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||