net.sourceforge.nite.nom.nomwrite.impl
Class NOMWriteAnnotation

java.lang.Object
  extended by net.sourceforge.nite.nom.nomwrite.impl.NOMWriteElement
      extended by net.sourceforge.nite.nom.nomwrite.impl.NOMWriteAnnotation
All Implemented Interfaces:
NOMAnnotation, NOMElement

public class NOMWriteAnnotation
extends NOMWriteElement
implements NOMAnnotation

NOMAnnotation extends NOMElement and represents an element within an Annotation set. Such elements extend NOMElement so that they can be used in the query language.

Author:
jonathan

Nested Class Summary
 
Nested classes/interfaces inherited from class net.sourceforge.nite.nom.nomwrite.impl.NOMWriteElement
NOMWriteElement.SharedElement, NOMWriteElement.XMLComment
 
Nested classes/interfaces inherited from interface net.sourceforge.nite.nom.nomwrite.NOMElement
NOMElement.SharedEl
 
Field Summary
 
Fields inherited from interface net.sourceforge.nite.nom.nomwrite.NOMElement
FEATURAL_LAYER, IMPLICIT_ORDER, STRUCTURAL_LAYER, TEMPORAL_ORDER, TIME_ALIGNED_LAYER, UNORDERED, UNTIMED
 
Constructor Summary
NOMWriteAnnotation(NOMCorpus corpus, java.lang.String name, java.lang.String observation, NAgent nagent)
          Create an annotation element: here, the final argument is an NAgent rather than the agent name.
NOMWriteAnnotation(NOMCorpus corpus, java.lang.String name, java.lang.String observation, NAgent nagent, java.lang.String id)
          Create an annotation element: here, the NAgent is given rather than the name of the agent, and an ID is provided by the user.
NOMWriteAnnotation(NOMCorpus corpus, java.lang.String name, java.lang.String observation, java.lang.String agent)
          This constructor will be the most commonly used in application programs.
NOMWriteAnnotation(NOMCorpus corpus, java.lang.String name, java.lang.String observation, java.lang.String agent, java.lang.String id)
          Create an annotation element where the colour of the element is derived from the metadata and the ID is provided by the caller.
 
Method Summary
 
Methods inherited from class net.sourceforge.nite.nom.nomwrite.impl.NOMWriteElement
addAfterSibling, addAttribute, addBeforeSibling, addChild, addChildAboveChildren, addChildAfter, addChildBefore, addExternalPointer, addFirstChild, addLastChild, addPointer, addToCorpus, appendText, deleteChild, endElementString, findAncestorInLayer, findAncestorNamed, findAncestorsInFile, findAncestorsInLayer, findAncestorsNamed, findCommonAncestorInFile, findDescendantsInLayer, findDescendantsNamed, getAgent, getAgentName, getAttribute, getAttributeComparableValue, getAttributes, getChildOrder, getChildren, getChildrenWithInterleavedComments, getColour, getComment, getCorpus, getEndTime, getExternalPointerValue, getGVM, getID, getIDLink, getKeyStroke, getLayer, getLink, getMetadataElement, getName, getNextElement, getNextSibling, getNiteChildren, getObservation, getParentInFile, getParents, getPointers, getPointersTo, getPointerWithRole, getPreviousSibling, getRecursiveDepth, getRecursiveHeight, getShared, getStartTime, getText, getTimeType, getXLink, hasNextElement, inheritTimes, insertParent, isComment, isLeaf, isStreamElement, isStreamElementOld, removeAttribute, removeChild, removeParentAndAdjust, removePointer, setComment, setDoubleAttribute, setEndTime, setGVM, setKeyStroke, setName, setStartTime, setStreamElement, setStringAttribute, setText, startElementString, updateTimes
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.sourceforge.nite.nom.nomwrite.NOMElement
addAfterSibling, addAttribute, addBeforeSibling, addChild, addChildAboveChildren, addChildAfter, addChildBefore, addExternalPointer, addFirstChild, addLastChild, addPointer, addToCorpus, appendText, deleteChild, findAncestorInLayer, findAncestorNamed, findAncestorsInFile, findAncestorsInLayer, findAncestorsNamed, findCommonAncestorInFile, findDescendantsInLayer, findDescendantsNamed, getAgent, getAgentName, getAttribute, getAttributeComparableValue, getAttributes, getChildOrder, getChildren, getChildrenWithInterleavedComments, getColour, getComment, getCorpus, getEndTime, getExternalPointerValue, getGVM, getID, getKeyStroke, getLayer, getLink, getMetadataElement, getName, getNextElement, getNextSibling, getObservation, getParentInFile, getParents, getPointers, getPointersTo, getPointerWithRole, getPreviousSibling, getRecursiveDepth, getRecursiveHeight, getShared, getStartTime, getText, getTimeType, getXLink, hasNextElement, insertParent, isComment, isStreamElement, removeAttribute, removeChild, removeParentAndAdjust, removePointer, setComment, setDoubleAttribute, setEndTime, setGVM, setKeyStroke, setName, setStartTime, setStreamElement, setStringAttribute, setText
 

Constructor Detail

NOMWriteAnnotation

public NOMWriteAnnotation(NOMCorpus corpus,
                          java.lang.String name,
                          java.lang.String observation,
                          java.lang.String agent)
                   throws NOMException
This constructor will be the most commonly used in application programs. The colour of the element is derived from the metadata and the ID is derived from that. IDs generated will be unique with respect to the corpus subset that is currently loaded.

Throws:
NOMException

NOMWriteAnnotation

public NOMWriteAnnotation(NOMCorpus corpus,
                          java.lang.String name,
                          java.lang.String observation,
                          java.lang.String agent,
                          java.lang.String id)
                   throws NOMException
Create an annotation element where the colour of the element is derived from the metadata and the ID is provided by the caller.

Throws:
NOMException

NOMWriteAnnotation

public NOMWriteAnnotation(NOMCorpus corpus,
                          java.lang.String name,
                          java.lang.String observation,
                          NAgent nagent)
                   throws NOMException
Create an annotation element: here, the final argument is an NAgent rather than the agent name.

Throws:
NOMException

NOMWriteAnnotation

public NOMWriteAnnotation(NOMCorpus corpus,
                          java.lang.String name,
                          java.lang.String observation,
                          NAgent nagent,
                          java.lang.String id)
                   throws NOMException
Create an annotation element: here, the NAgent is given rather than the name of the agent, and an ID is provided by the user.

Throws:
NOMException