1:34 p.m.
Author: heiko.braun(a)jboss.com
Date: 2010-03-07 14:34:43 -0500 (Sun, 07 Mar 2010)
New Revision: 991
Modified:
activity-monitor/trunk/model/src/main/java/org/jboss/bpm/monitor/model/bpaf/Event.java
activity-monitor/trunk/model/src/main/resources/org/jboss/bpm/monitor/model/bpaf/BPAF.hbm.xml
Log:
update javadocs
Modified:
activity-monitor/trunk/model/src/main/java/org/jboss/bpm/monitor/model/bpaf/Event.java
===================================================================
---
activity-monitor/trunk/model/src/main/java/org/jboss/bpm/monitor/model/bpaf/Event.java 2010-03-07
19:26:24 UTC (rev 990)
+++
activity-monitor/trunk/model/src/main/java/org/jboss/bpm/monitor/model/bpaf/Event.java 2010-03-07
19:34:43 UTC (rev 991)
@@ -24,9 +24,10 @@
/**
- * <p>Java class for anonymous complex type.
+ * <p>Every state change in the BPAF state model can be represented as an XML
message following the BPAF Event Format.
+ *
*
- * <p>The following schema fragment specifies the expected content contained within
this class.
+ * <p>This format has the following basic components:
*
* <pre>
* <complexType>
@@ -77,41 +78,74 @@
@XmlElement(name = "DataElement")
protected List<Tuple> dataElement;
+ /**
+ * A globally unique identifier for the individual event
+ */
@XmlAttribute(name = "EventID", required = true)
@XmlJavaTypeAdapter(CollapsedStringAdapter.class)
protected long eventID;
+ /**
+ * [optional]: A globally unique identifier for the originating server of the event
+ */
@XmlAttribute(name = "ServerID")
@XmlJavaTypeAdapter(CollapsedStringAdapter.class)
@XmlSchemaType(name = "NMTOKEN")
protected String serverID;
+ /**
+ * The identifier of the process definition
+ * from which the current process instance has been derived.
+ */
@XmlAttribute(name = "ProcessDefinitionID", required = true)
@XmlJavaTypeAdapter(CollapsedStringAdapter.class)
@XmlSchemaType(name = "NMTOKEN")
protected String processDefinitionID;
+ /**
+ * The identifier of the process instance
+ * that serves as the context of the event.
+ */
@XmlAttribute(name = "ProcessInstanceID", required = true)
@XmlJavaTypeAdapter(CollapsedStringAdapter.class)
@XmlSchemaType(name = "NMTOKEN")
protected String processInstanceID;
+ /**
+ * [optional]: The name of the process definition
+ * from which the current process instance has been derived.
+ */
@XmlAttribute(name = "ProcessName")
protected String processName;
+ /**
+ * [optional]: The identifier of the activity definition
+ * from which the current activity instance has been derived.
+ */
@XmlAttribute(name = "ActivityDefinitionID")
@XmlJavaTypeAdapter(CollapsedStringAdapter.class)
@XmlSchemaType(name = "NMTOKEN")
protected String activityDefinitionID;
+ /**
+ * [optional]: The identifier of the activity instance
+ * that serves as the context of the event.
+ */
@XmlAttribute(name = "ActivityInstanceID")
@XmlJavaTypeAdapter(CollapsedStringAdapter.class)
@XmlSchemaType(name = "NMTOKEN")
protected String activityInstanceID;
+ /**
+ * [optional]: The name of the activity definition
+ * from which the current activity instance has been derived.
+ */
@XmlAttribute(name = "ActivityName")
protected String activityName;
+ /**
+ * The time of the event occurrence
+ */
@XmlAttribute(name = "Timestamp", required = true)
@XmlSchemaType(name = "long")
protected long timestamp;
@@ -153,26 +187,10 @@
}
/**
- * Gets the value of the dataElement property.
- *
- * <p>
- * This accessor method returns a reference to the live list,
- * not a snapshot. Therefore any modification you make to the
- * returned list will be present inside the JAXB object.
- * This is why there is not a <CODE>set</CODE> method for the dataElement
property.
- *
- * <p>
- * For example, to add a new item, do as follows:
- * <pre>
- * getDataElement().add(newItem);
- * </pre>
- *
- *
- * <p>
- * Objects of the following type(s) are allowed in the list
- * {@link Object }
- *
- *
+ * A name-value-pair that can be used to store additional process data
+ * that can later be used to correlate or aggregate events.
+ *
+ * @return
*/
@OneToMany(mappedBy="event")
public List<Tuple> getDataElement() {
@@ -434,8 +452,18 @@
@Embeddable
public static class EventDetails {
+ /**
+ * An identifier of the current state
+ * of the object that changed state, derived from the BPAF state model
+ */
@XmlAttribute(name = "CurrentState", required = true)
protected State currentState;
+
+ /**
+ * [optional]: An identifier of
+ * the previous state of the object that changed state,
+ * derived from the BPAF state model
+ */
@XmlAttribute(name = "PreviousState")
protected State previousState;
Modified:
activity-monitor/trunk/model/src/main/resources/org/jboss/bpm/monitor/model/bpaf/BPAF.hbm.xml
===================================================================
---
activity-monitor/trunk/model/src/main/resources/org/jboss/bpm/monitor/model/bpaf/BPAF.hbm.xml 2010-03-07
19:26:24 UTC (rev 990)
+++
activity-monitor/trunk/model/src/main/resources/org/jboss/bpm/monitor/model/bpaf/BPAF.hbm.xml 2010-03-07
19:34:43 UTC (rev 991)
@@ -13,19 +13,19 @@
<property name="serverID" column="serverID"/>
- <property name="processDefinitionID"
column="processDefinitionID"/>
- <property name="processInstanceID"
column="processInstanceID"/>
+ <property name="processDefinitionID"
column="processDefinitionID" not-null="true"/>
+ <property name="processInstanceID"
column="processInstanceID" not-null="true"/>
<property name="processName" column="processName" />
<property name="activityDefinitionID"
column="activityDefinitionID"/>
<property name="activityInstanceID"
column="activityInstanceID"/>
<property name="activityName" column="activityName"/>
- <property name="timestamp" column="timestamp"/>
+ <property name="timestamp" column="timestamp"
not-null="true"/>
<component name="eventDetails">
- <property name="currentState"
column="currentState">
+ <property name="currentState" column="currentState"
not-null="true">
<type name="org.jboss.bpm.monitor.model.StateUserType">
<param
name="enumClass">org.jboss.bpm.monitor.model.bpaf.State</param>
</type>