de.dfki.lt.hog
Class Metadata

java.lang.Object
  extended by de.dfki.lt.hog.Metadata

public class Metadata
extends java.lang.Object

Represents Metadata objects, holding all relevant metadata information. Moreover, provides methods for generating and parsing METADATA elements. Generation either as XML-String or DOM Element. For an example of usage see main(String[]) METADATA elements are structured like this:

<metadata>
<id>
<entry name="propertyname" value="propertyvalue"/>
<entry name="propertyname" value="propertyvalue"/>
...
</id>
<conf>
<entry name="propertyname" value="propertyvalue"/>
<entry name="propertyname" value="propertyvalue"/>
...
</conf>
<metadata>


Constructor Summary
Metadata()
          Creates an empty Metadata object.
Metadata(java.lang.String xmlString)
          Creates a new Metadata object reading all values from the given Metadata XML String.
Metadata(java.lang.String sessionID, java.lang.String annotationCollectionID, java.lang.String processingTime, java.lang.String component, java.lang.String diagnosis, boolean empty, java.util.Properties config)
          Creates a new Metadata object setting all values as given.
 
Method Summary
static org.w3c.dom.Element createMetadataElement(org.w3c.dom.Document document, java.lang.String sessionID, java.lang.String annotationCollectionID, java.lang.String processingTime, java.lang.String component, java.lang.String diagnosis, boolean empty, java.util.Properties config)
          Creates and returns a DOM metadata Element statically.
static java.lang.String generateXml(java.lang.String sessionID, java.lang.String annotationCollectionID, java.lang.String processingTime, java.lang.String component, boolean empty, java.lang.String diagnosis)
          Generates and returns metadata XML statically setting the conf to empty.
static java.lang.String generateXml(java.lang.String sessionID, java.lang.String annotationCollectionID, java.lang.String processingTime, java.lang.String component, java.lang.String diagnosis, boolean empty, java.util.Properties config)
          Generates and returns metadata XML statically.
 java.lang.String getAcID()
          Returns this Metadata's annotation collection ID attribute.
 java.lang.String getComponent()
          Returns this Metadata's component attribute.
 java.util.Properties getConfig()
          Returns this Metadata's config Properties.
 java.lang.String getCreated()
          Returns this Metadata's creation time stamp attribute.
 java.lang.String getDiagnosis()
          Returns this Metadata's diagnosis attribute.
 boolean getEmpty()
          Returns this Metadata's empty attribute.
 org.w3c.dom.Element getMetadataElement()
          Returns the DOM Element representing this metadata object.
 java.lang.String getMetadataElementName()
          Returns the name of the metadata element as hardcoded in a final variable.
 java.lang.String getProcTime()
          Returns this Metadata's proccesing time attribute.
 java.lang.String getSessionID()
          Returns this Metadata's sessionID attribute.
 java.lang.String getXmlString()
          Returns the XML String representing this metadata object.
static void main(java.lang.String[] args)
          For testing purposes.
 void setAcID(java.lang.String acid)
          Sets this Metadata's annotation collection ID attribute.
 void setComponent(java.lang.String comp)
          Sets this Metadata's component attribute.
 void setConfig(java.util.Properties conf)
          Sets this Metadata's config Properties.
 void setCreated(java.lang.String created)
          Sets this Metadata's creation time stamp attribute.
 void setDiagnosis(java.lang.String diag)
          Sets this Metadata's diagnosis attribute.
 void setDocument(org.w3c.dom.Document document)
           
 void setEmpty(boolean e)
          Sets this Metadata's empty attribute.
 void setProcTime(java.lang.String procTime)
          Sets this Metadata's proccesing time attribute.
 void setSessionID(java.lang.String sid)
          Sets this Metadata's sessionID attribute.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Metadata

public Metadata()
Creates an empty Metadata object. Only the creation time stamp will be generated and added to this object. All other attributes can be set using the set*() methods.


Metadata

public Metadata(java.lang.String sessionID,
                java.lang.String annotationCollectionID,
                java.lang.String processingTime,
                java.lang.String component,
                java.lang.String diagnosis,
                boolean empty,
                java.util.Properties config)
Creates a new Metadata object setting all values as given.


Metadata

public Metadata(java.lang.String xmlString)
Creates a new Metadata object reading all values from the given Metadata XML String.

Parameters:
xmlString -
Method Detail

getCreated

public java.lang.String getCreated()
Returns this Metadata's creation time stamp attribute.


setCreated

public void setCreated(java.lang.String created)
Sets this Metadata's creation time stamp attribute.


getProcTime

public java.lang.String getProcTime()
Returns this Metadata's proccesing time attribute.


setProcTime

public void setProcTime(java.lang.String procTime)
Sets this Metadata's proccesing time attribute.


getSessionID

public java.lang.String getSessionID()
Returns this Metadata's sessionID attribute.


setSessionID

public void setSessionID(java.lang.String sid)
Sets this Metadata's sessionID attribute.


getAcID

public java.lang.String getAcID()
Returns this Metadata's annotation collection ID attribute.


setAcID

public void setAcID(java.lang.String acid)
Sets this Metadata's annotation collection ID attribute.


getComponent

public java.lang.String getComponent()
Returns this Metadata's component attribute.


setComponent

public void setComponent(java.lang.String comp)
Sets this Metadata's component attribute.


getDiagnosis

public java.lang.String getDiagnosis()
Returns this Metadata's diagnosis attribute.


setDiagnosis

public void setDiagnosis(java.lang.String diag)
Sets this Metadata's diagnosis attribute.


getEmpty

public boolean getEmpty()
Returns this Metadata's empty attribute.


setEmpty

public void setEmpty(boolean e)
Sets this Metadata's empty attribute.


getConfig

public java.util.Properties getConfig()
Returns this Metadata's config Properties.


setConfig

public void setConfig(java.util.Properties conf)
Sets this Metadata's config Properties.


setDocument

public void setDocument(org.w3c.dom.Document document)

getMetadataElementName

public java.lang.String getMetadataElementName()
Returns the name of the metadata element as hardcoded in a final variable. See METADATA_ELEMENT in Metadata.java.

Returns:
The name of the metadata element.

getXmlString

public java.lang.String getXmlString()
Returns the XML String representing this metadata object.


getMetadataElement

public org.w3c.dom.Element getMetadataElement()
Returns the DOM Element representing this metadata object.


generateXml

public static java.lang.String generateXml(java.lang.String sessionID,
                                           java.lang.String annotationCollectionID,
                                           java.lang.String processingTime,
                                           java.lang.String component,
                                           java.lang.String diagnosis,
                                           boolean empty,
                                           java.util.Properties config)
Generates and returns metadata XML statically.


generateXml

public static java.lang.String generateXml(java.lang.String sessionID,
                                           java.lang.String annotationCollectionID,
                                           java.lang.String processingTime,
                                           java.lang.String component,
                                           boolean empty,
                                           java.lang.String diagnosis)
Generates and returns metadata XML statically setting the conf to empty.


createMetadataElement

public static org.w3c.dom.Element createMetadataElement(org.w3c.dom.Document document,
                                                        java.lang.String sessionID,
                                                        java.lang.String annotationCollectionID,
                                                        java.lang.String processingTime,
                                                        java.lang.String component,
                                                        java.lang.String diagnosis,
                                                        boolean empty,
                                                        java.util.Properties config)
Creates and returns a DOM metadata Element statically.


main

public static void main(java.lang.String[] args)
For testing purposes.