de.dfki.lt.hog.container
Class AnnotationEncapsulator

java.lang.Object
  extended by de.dfki.lt.hog.container.AnnotationEncapsulator

public class AnnotationEncapsulator
extends java.lang.Object

Encapsulates XML annotation (not necessarily HoG-generated) and relevant metadata such as session ID or annotation collection ID. Main purpose is transport of dynamic data for/within the SDL module.


Constructor Summary
AnnotationEncapsulator()
          Create new AnnotationEncapsulator object.
AnnotationEncapsulator(Metadata metadata)
          Create new AnnotationEncapsulator object from Metadata.
AnnotationEncapsulator(Metadata metadata, java.lang.Object annotation)
          Create new AnnotationEncapsulator object from Metadata and an annotation object.
AnnotationEncapsulator(java.lang.Object annotation)
          Create new AnnotationEncapsulator object from an annotation object.
 
Method Summary
 AnnotationEncapsulator clone(java.lang.Object newAnnotation)
          Creates a new AnnotationEncapsulator, copies all attributes exception the annotation object from the original AnnotationEncapsulator.
 java.lang.Object getAnnotation()
          Return annotation obejct.
 java.lang.String getAnnotationCollectionID()
          Return annotationCollectionID attribute.
 java.lang.String getAnnotationID()
          Return annotationID attribute.
 java.lang.String getLanguage()
          Return language attribute.
 MoCoMan getMoCoMan()
          Return MoCoMan obejct.
 java.lang.String getSessionID()
          Return sessionID attribute.
 void setAnnotation(java.lang.Object o)
          Set annotation object.
 void setAnnotationCollectionID(java.lang.String acid)
          Set annotationCollectionID attribute.
 void setAnnotationID(java.lang.String acid)
          Set annotationID attribute.
 void setLanguage(java.lang.String lang)
          Set language attribute.
 void setMoCoMan(MoCoMan mcm)
          Set MoCoMan object.
 void setSessionID(java.lang.String sid)
          Set sessionID attribute.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AnnotationEncapsulator

public AnnotationEncapsulator()
Create new AnnotationEncapsulator object. Use subsequent setter methods to fill attributes.


AnnotationEncapsulator

public AnnotationEncapsulator(Metadata metadata)
Create new AnnotationEncapsulator object from Metadata.


AnnotationEncapsulator

public AnnotationEncapsulator(Metadata metadata,
                              java.lang.Object annotation)
Create new AnnotationEncapsulator object from Metadata and an annotation object.


AnnotationEncapsulator

public AnnotationEncapsulator(java.lang.Object annotation)
Create new AnnotationEncapsulator object from an annotation object.

Method Detail

clone

public AnnotationEncapsulator clone(java.lang.Object newAnnotation)
Creates a new AnnotationEncapsulator, copies all attributes exception the annotation object from the original AnnotationEncapsulator. The new AnnotationEncapsulator contains the annotation objects specified as parameter.

Parameters:
newAnnotation - the new annotation object
Returns:
a new AnnotationEncapsulator

getSessionID

public java.lang.String getSessionID()
Return sessionID attribute.

Returns:
String sessionID

setSessionID

public void setSessionID(java.lang.String sid)
Set sessionID attribute.

Parameters:
sid - the new sessionID

getAnnotationCollectionID

public java.lang.String getAnnotationCollectionID()
Return annotationCollectionID attribute.

Returns:
String annotationCollectionID

setAnnotationCollectionID

public void setAnnotationCollectionID(java.lang.String acid)
Set annotationCollectionID attribute.


getAnnotationID

public java.lang.String getAnnotationID()
Return annotationID attribute.

Returns:
String annotationID

setAnnotationID

public void setAnnotationID(java.lang.String acid)
Set annotationID attribute.


getAnnotation

public java.lang.Object getAnnotation()
Return annotation obejct.

Returns:
Object sessionID

setAnnotation

public void setAnnotation(java.lang.Object o)
Set annotation object.


getMoCoMan

public MoCoMan getMoCoMan()
Return MoCoMan obejct.

Returns:
MoCoMan MoCoMan

setMoCoMan

public void setMoCoMan(MoCoMan mcm)
Set MoCoMan object.


getLanguage

public java.lang.String getLanguage()
Return language attribute.

Returns:
String language

setLanguage

public void setLanguage(java.lang.String lang)
Set language attribute.

Parameters:
lang - the new language