net.sourceforge.nite.nom.nomread.impl
Class NOMReadAnnotation

java.lang.Object
  net.sourceforge.nite.nom.nomwrite.impl.NOMWriteElement
      net.sourceforge.nite.nom.nomread.impl.NOMReadElement
          net.sourceforge.nite.nom.nomread.impl.NOMReadAnnotation

All Implemented Interfaces:

NOMAnnotation, NOMElement

public class NOMReadAnnotation
extends NOMReadElement
implements NOMAnnotation

NOMAnnotation extends NOMElement and represents an individual annotation on the data. Annotatoions do not extend NOMElement in any way, but are contrasted to NOMObjects and NOMTypeElement, though all are types of NOMElement and as such can be treated similarly by the query engine.

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

NOMReadAnnotation(NOMCorpus corpus, java.lang.String comment, java.lang.String colour)
This constructor creates a comment element

NOMReadAnnotation(NOMCorpus corpus, java.lang.String name, java.lang.String observation, NAgent nagent)
This constructor can also be used in application programs - it's identical except that the last argument is an NAgent rather than the agent name.

NOMReadAnnotation(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.

Method Summary

Methods inherited from class net.sourceforge.nite.nom.nomread.impl.NOMReadElement

addAfterSibling, addAttribute, addBeforeSibling, addChild, addChildAfter, addChildBefore, addFirstChild, addLastChild, addPointer, addToCorpus, appendText, deleteChild, getLink, getShared, removeAttribute, removeChild, removePointer, setComment, setDoubleAttribute, setEndTime, setGVM, setName, setStartTime, setStringAttribute, setText

Methods inherited from class net.sourceforge.nite.nom.nomwrite.impl.NOMWriteElement

addChildAboveChildren, addExternalPointer, 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, getMetadataElement, getName, getNextElement, getNextSibling, getNiteChildren, getObservation, getParentInFile, getParents, getPointers, getPointersTo, getPointerWithRole, getPreviousSibling, getRecursiveDepth, getRecursiveHeight, getStartTime, getText, getTimeType, getXLink, hasNextElement, inheritTimes, insertParent, isComment, isLeaf, isStreamElement, isStreamElementOld, removeParentAndAdjust, setKeyStroke, setStreamElement, 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

NOMReadAnnotation

public NOMReadAnnotation(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

NOMReadAnnotation

public NOMReadAnnotation(NOMCorpus corpus,
                         java.lang.String name,
                         java.lang.String observation,
                         NAgent nagent)
                  throws NOMException

This constructor can also be used in application programs - it's identical except that the last argument is an NAgent rather than the agent name.

Throws:

NOMException

NOMReadAnnotation

public NOMReadAnnotation(NOMCorpus corpus,
                         java.lang.String comment,
                         java.lang.String colour)
                  throws NOMException

This constructor creates a comment element

Throws:

NOMException