public class Remarks extends java.lang.Object implements DetailSubelement
While the use of free text is strongly discouraged (it hampers machine-to-machine communication) it is a pragmatic necessity. This entity attempts to encapsulate freetext in a way that simplifies subsequent machine processing. The content of this entity is presumed to be a human-readable chunk of textual data. The optional attributes merely aid in the machine handling of the data.
Constructor and Description |
---|
Remarks()
Remarks class constructor
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getContents()
Returns the String representation of the free-text remarks, or null if it has not been set
|
java.lang.String |
getKeywords()
Returns the optional 'keywords' attribute value if it has been set, or null if it has not
|
java.lang.String |
getName()
Returns the XML element name for the CoT subschema this DetailSubelement represents
|
java.lang.String |
getSource()
Returns the optional 'source' attribute value if it has been set
|
java.util.Date |
getTime()
Returns the optional 'time' attribute value as a Date object
|
java.lang.String |
getTo()
Returns the optional 'to' attribute value if it has been set, or null if it has not
|
java.lang.Double |
getVersion()
Returns the Double representation of the version associated with this remarks element
|
void |
setContents(java.lang.String remarks)
Replaces the String representation of the free-text remarks
|
void |
setKeywords(java.lang.String keywords)
Replaces the String representation of the optional 'keywords' attribute
|
void |
setSource(java.lang.String source)
Replaces the String representation of the optional 'source' attribute
|
void |
setTime(java.util.Date time)
Replaces the Date representation of the optional 'time' attribute
|
void |
setTo(java.lang.String to)
Replaces the String representation of the optional 'to' attribute
|
void |
setVersion(java.lang.Double version)
Replaces the version associated with this remarks element
|
java.lang.String |
toXml()
Returns a full XML String representation of this DetailSubelement
|
public java.lang.String getContents()
public void setContents(java.lang.String remarks)
remarks
- the String representation of the freetext remarks. Null or empty string will clear contentspublic java.lang.String getSource()
public void setSource(java.lang.String source)
source
- the String representation of the value to associate with the optional 'source' attribute. If null, the 'source' attribute is effectively removed.public java.util.Date getTime()
public void setTime(java.util.Date time)
time
- the Date representation of the value to associate with the optional 'time' attribute. If null, the 'time' attribute is effectively removed.public java.lang.String getTo()
public void setTo(java.lang.String to)
to
- the String representation of the value to associate with the optional 'to' attribute. If null, the 'source' attribute is effectively removed.public java.lang.String getKeywords()
public void setKeywords(java.lang.String keywords)
keywords
- the String representation of the value to associate with the optional 'keywords' attribute. If null, the 'keywords' attribute is effectively removed.java.lang.IllegalArgumentException
- if the specified keywords String does not match the pattern defined in the remarks schemapublic java.lang.Double getVersion()
public void setVersion(java.lang.Double version)
version
- the Double representation of the version to set, or null to remove the version attributepublic java.lang.String getName()
DetailSubelement
getName
in interface DetailSubelement
public java.lang.String toXml()
DetailSubelement
toXml
in interface DetailSubelement