|
WebLogic Process Integrator Version 1.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.bea.wlpi.common.EventKeyInfo
Holds information about an XML event key. When WebLogic Process Integrator
processes an XML document, it uses an event key to identify the workflow
definitions or instance(s) that are associated with the incoming document.
The EventKeyInfo
object defines a relationship between a
document element name and a workflow expression. The system evaluates the
expression against the root element of an incoming document (of the
specified type) to yield a key value that uniquely identifies that document
instance, and thus any workflow definitions or instances to which it
relates. Note that the document type is characterized by the document
element name, not the Document Type Definition.
Objects of this class override the boolean equals(Object)
and
implement the comparable
interface. Homogeneous collections
containing objects of this class may, therefore, be searched and sorted using
the Collection.contains(Object), List.indexOf(Object),
Collections.sort(List)
methods.
Constructor Summary | |
EventKeyInfo(java.lang.String root,
java.lang.String expr)
Create a new XML event key info object. |
Method Summary | |
int |
compareTo(java.lang.Object o)
Compare two EventKeyInfo objects. |
boolean |
equals(java.lang.Object obj)
Test two EventKeyInfo objects for equality. |
java.lang.String |
getExpr()
Return a workflow expression that yields a unique key for a document. |
java.lang.String |
getRoot()
Return the XML document element name. |
void |
setExpr(java.lang.String expr)
Set the unique key expression. |
Methods inherited from class java.lang.Object |
clone,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public EventKeyInfo(java.lang.String root, java.lang.String expr)
root
- The XML document element name.expr
- Workflow expression that yields a unique key for a
document instance when evaluated against that document.Method Detail |
public final java.lang.String getRoot()
public final java.lang.String getExpr()
setExpr(java.lang.String)
public final void setExpr(java.lang.String expr)
expr
- Unique key expression, conformant with the workflow
expression syntax.getExpr()
public boolean equals(java.lang.Object obj)
EventKeyInfo
objects for equality.obj
- Object with which to compare this one.true
if obj
is an instance of
EventKeyInfo
with the same root as this one.compareTo(java.lang.Object)
public int compareTo(java.lang.Object o)
EventKeyInfo
objects.obj
- Object with which to compare this one. Must be
null
or an instance of EventKeyInfo
.root
members using the String.compareTo(Object)
method.o
is not an instance of
EventKeyInfo
.equals(java.lang.Object)
|
WebLogic Process Integrator Version 1.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |