|
WebLogic Integration | |||||||||
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)
Deprecated. Use the full constructor instead. |
|
EventKeyInfo(java.lang.String contentType,
java.lang.String eventDescriptor,
java.lang.String expr,
java.lang.String plugin,
int fieldID)
Create a new event key info object. |
Method Summary | |
int |
compareTo(java.lang.Object obj)
Compare two EventKeyInfo objects. |
boolean |
equals(java.lang.Object obj)
Test two EventKeyInfo objects for equality. |
java.lang.Object |
getContents()
|
java.lang.String |
getContentType()
Return The MIME content type (e.g., "text/xml" ). |
java.lang.String |
getEntryName()
|
java.lang.String |
getEventDescriptor()
Return the content-type-specific event data format description. |
java.lang.String |
getExpr()
Return a workflow expression that yields a unique key for a document. |
int |
getFieldID()
Return The unique plugin-assigned ID for the FieldInfo object. |
java.lang.String |
getOwnerName()
|
java.lang.String |
getPlugin()
Return the name of the plugin that supplies the field type required to evaluate the expression. |
java.lang.String |
getRoot()
Deprecated. Use getEventDescriptor() instead. |
int |
getType()
|
boolean |
isPublished()
|
void |
setExpr(java.lang.String expr)
Set the unique key expression. |
java.lang.String |
toString()
Return a string representation of the object. |
Methods inherited from class java.lang.Object |
clone,
finalize,
getClass,
hashCode,
notify,
notifyAll,
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.public EventKeyInfo(java.lang.String contentType, java.lang.String eventDescriptor, java.lang.String expr, java.lang.String plugin, int fieldID)
contentType
- The MIME content type (e.g.,
"text/xml"
).eventDescriptor
- A string to describe the particular event, in a
plugin-defined format.expr
- Workflow expression specifying how to generate a
unique key value for an event datum with the specified content type and
format description.pluginName
- The name of the plugin that supplies the field type
required to evaluate expr
. If null
and
contentType
is "text/xml"
, the
system will use the default FieldInfo.XMLFIELD
XML field type.fieldID
- The unique plugin-assigned ID for the
FieldInfo
object.Method Detail |
public final java.lang.String getContentType()
"text/xml"
).
public final java.lang.String getRoot()
getEventDescriptor()
instead.
public final java.lang.String getEventDescriptor()
"text/xml"
, the event descriptor
is the DTD Public ID or System ID, or the document element tag name.
public final java.lang.String getExpr()
setExpr(java.lang.String)
public final java.lang.String getPlugin()
public final int getFieldID()
FieldInfo
object.
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 obj)
EventKeyInfo
objects.
obj
- Object with which to compare this one. Must be
null
or an instance of EventKeyInfo
.contentType
and
eventDescriptor
members using the
String.compareTo(Object)
method.o
is not an instance of
EventKeyInfo
.equals(java.lang.Object)
public java.lang.String toString()
public java.lang.Object getContents()
public java.lang.String getEntryName()
public int getType()
public java.lang.String getOwnerName()
public boolean isPublished()
|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |