com.bea.wlpi.common
Class EventKeyInfo

java.lang.Object
  |
  +--com.bea.wlpi.common.EventKeyInfo

All Implemented Interfaces:

java.lang.Comparable, Publishable, java.io.Serializable

public class EventKeyInfo

extends java.lang.Object

implements java.io.Serializable, java.lang.Comparable, Publishable

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.

See Also:

Serialized Form

Fields inherited from interface com.bea.wlpi.common.Publishable

BUSINESS_CALENDAR, BUSINESS_OPERATION, EVENT_KEY, ORG, ROLE, TEMPLATE, TEMPLATE_DEFINITION, USER, XML_REPOSITORY_ENTITY, XML_REPOSITORY_FOLDER

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() Return the publishable content.
java.lang.String	getContentType() Return The MIME content type (e.g., "text/xml").
java.lang.String	getEntryName() Return the display name for the publishable object.
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() Return the name of the object's owner.
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() Return the type of publishable object.
boolean	isPublished() Returns whether the object is published.
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

EventKeyInfo

public EventKeyInfo(java.lang.String root,
                    java.lang.String expr)

Deprecated. Use the full constructor instead.

Create a new XML event key info object.

Parameters:

root - The XML document element name.

expr - Workflow expression that yields a unique key for a document instance when evaluated against that document.

EventKeyInfo

public 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.

Parameters:

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.

Since:

WebLogic Process Integrator 2.0

Method Detail

getContentType

public final java.lang.String getContentType()

Return The MIME content type (e.g., "text/xml").

Returns:

The content type.

Since:

WebLogic Process Integrator 2.0

getRoot

public final java.lang.String getRoot()

Deprecated. Use getEventDescriptor() instead.

Return the XML document element name.

Returns:

The XML document element name to which this event key relates.

getEventDescriptor

public final java.lang.String getEventDescriptor()

Return the content-type-specific event data format description. For a content type of "text/xml", the event descriptor is the DTD Public ID or System ID, or the document element tag name.

Returns:

Event format descriptor.

Since:

WebLogic Process Integrator 2.0

getExpr

public final java.lang.String getExpr()

Return a workflow expression that yields a unique key for a document.

Returns:

Workflow expression that yields a unique key for a document instance when evaluated against that document.

See Also:

setExpr(java.lang.String)

getPlugin

public final java.lang.String getPlugin()

Return the name of the plugin that supplies the field type required to evaluate the expression.

Returns:

The plugin name.

Since:

WebLogic Process Integrator 2.0

getFieldID

public final int getFieldID()

Return The unique plugin-assigned ID for the FieldInfo object.

Returns:

The ID of the field.

Since:

WebLogic Process Integrator 2.0

setExpr

public final void setExpr(java.lang.String expr)

Set the unique key expression.

Parameters:

expr - Unique key expression, conformant with the workflow expression syntax.

See Also:

getExpr()

equals

public boolean equals(java.lang.Object obj)

Test two EventKeyInfo objects for equality.

Overrides:

equals in class java.lang.Object

Parameters:

obj - Object with which to compare this one.

Returns:

true if obj is an instance of EventKeyInfo with the same root as this one.

See Also:

compareTo(java.lang.Object)

compareTo

public int compareTo(java.lang.Object obj)

Compare two EventKeyInfo objects.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

obj - Object with which to compare this one. Must be null or an instance of EventKeyInfo.

Returns:

The result of comparing the contentType and eventDescriptor members using the String.compareTo(Object) method.

Throws:

java.lang.ClassCastException - if o is not an instance of EventKeyInfo.

See Also:

equals(java.lang.Object)

toString

public java.lang.String toString()

Return a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

String representation, showing the values of members.

Since:

WebLogic Process Integrator 2.0

getContents

public java.lang.Object getContents()

Description copied from interface: Publishable

Return the publishable content.

Specified by:

getContents in interface Publishable

Following copied from interface: com.bea.wlpi.common.Publishable

Returns:

A serializable object.

getEntryName

public java.lang.String getEntryName()

Description copied from interface: Publishable

Return the display name for the publishable object.

Specified by:

getEntryName in interface Publishable

Following copied from interface: com.bea.wlpi.common.Publishable

Returns:

Display name.

getType

public int getType()

Description copied from interface: Publishable

Return the type of publishable object.

Specified by:

getType in interface Publishable

Following copied from interface: com.bea.wlpi.common.Publishable

Returns:

Publishable object type: Publishable.TEMPLATE, Publishable.TEMPLATE_DEFINITION, Publishable.BUSINESS_OPERATION, Publishable.BUSINESS_CALENDAR, Publishable.USER, Publishable.ROLE, Publishable.ORG, Publishable.XML_REPOSITORY_FOLDER, Publishable.XML_REPOSITORY_ENTITY, Publishable.EVENT_KEY,

getOwnerName

public java.lang.String getOwnerName()

Description copied from interface: Publishable

Return the name of the object's owner.

Specified by:

getOwnerName in interface Publishable

Following copied from interface: com.bea.wlpi.common.Publishable

Returns:

The object's owner, if any.

isPublished

public boolean isPublished()

Description copied from interface: Publishable

Returns whether the object is published. Published objects cannot be modified.

Specified by:

isPublished in interface Publishable

Following copied from interface: com.bea.wlpi.common.Publishable

Returns:

true if the object is published.