public class FlowTags extends java.lang.Object implements DetailSubelement
This is a Cursor On Target detail sub-schema that holds "fingerprints" of the system that have processed a particular CoT event. This information aids in the routine of CoT messages along a particular processing chain. Each system that touches a particular CoT event is expected to add its own attribute to this entity. The attribute name should reflect the particular system name, and the value should be the time stamp when the information was sent out from that system. Some illustrative _flow-tags_ attributes are adocs, fbcb2, and tadilj, but the attribute list is not a closed set.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
name |
Constructor and Description |
---|
FlowTags()
Class constructor
|
Modifier and Type | Method and Description |
---|---|
boolean |
containsFlowTag(java.lang.String attributeName)
Returns a boolean indicating if a given flow tag (attribute) has been set on this FlowTags object.
|
java.util.Date |
getFlowTag(java.lang.String attributeName)
Returns the Date value associated with a given flow tag (attribute).
|
java.lang.String |
getName()
Returns the XML element name for the CoT subschema this DetailSubelement represents
|
void |
removeFlowTag(java.lang.String attributeName)
Removes any value associated with the given flow tag (attribute) for this object.
|
void |
setFlowTag(java.lang.String attributeName)
Sets the time value of the given attribute to the current time.
|
void |
setFlowTag(java.lang.String attributeName,
java.util.Date date)
Sets the time value of the given attribute to the given Date.
|
java.lang.String |
toXml()
Returns a full XML String representation of this DetailSubelement
|
public static final java.lang.String name
public void setFlowTag(java.lang.String attributeName) throws java.lang.IllegalArgumentException
attributeName
- the name of the FlowTag (attribute) to set.java.lang.IllegalArgumentException
- if the attribute name is not valid XMLpublic void setFlowTag(java.lang.String attributeName, java.util.Date date) throws java.lang.IllegalArgumentException
attributeName
- the name of the FlowTag (attribute) to set.date
- the time value the attribute will be set to.java.lang.IllegalArgumentException
- when the provided date is null or if the attribute name is not valid XMLpublic java.util.Date getFlowTag(java.lang.String attributeName)
attributeName
- the name of the flow tag being queried.public boolean containsFlowTag(java.lang.String attributeName)
attributeName
- the name of the flow tag being queried.public void removeFlowTag(java.lang.String attributeName)
attributeName
- the name of the flow tag being queried.public java.lang.String getName()
DetailSubelement
getName
in interface DetailSubelement
public java.lang.String toXml()
DetailSubelement
toXml
in interface DetailSubelement