net.sourceforge.nite.meta
Interface NObservation

All Known Implementing Classes:

NiteObservation

public interface NObservation

Information about an Observation. This may be expanded in the future when we wish to allow editing of metadata.

Author:

jonathan

Method Summary

void	addUserCoding(NUserCoding coding) Add a user coding to the corpus.
NUserCoding	findCoding(java.lang.String codingname, java.lang.String agentname) find a user coding for this observation that has coding and agent matching.
java.lang.String	getDescription() returns a description of the observation.
org.w3c.dom.Node	getNode() Get the DOM node which represents this observation in the tree.
java.lang.String	getShortName() The identifier for this observation as used in filenames etc.
java.util.List	getUserCodings() returns a list of user codings (see NUserCoding).
java.lang.String	getVariable(java.lang.String variable) return the value of the observation variable for the given variable name
java.util.List	getVariables() returns a list of strings: these are the values of the observation variables in the same order as you get the declarations from the getObservationVariables call from the metadata.
void	setDocument(org.w3c.dom.Document document) set the DOM document of which this observation is a part Only used by methods that edit the DOM.
void	setNode(org.w3c.dom.Node node) set the DOM node which represents this observation in the tree.

Method Detail

getShortName

java.lang.String getShortName()

The identifier for this observation as used in filenames etc. Could be something like "q4nc8" for the Map Task.

getDescription

java.lang.String getDescription()

returns a description of the observation.

getVariables

java.util.List getVariables()

returns a list of strings: these are the values of the observation variables in the same order as you get the declarations from the getObservationVariables call from the metadata.

getVariable

java.lang.String getVariable(java.lang.String variable)

return the value of the observation variable for the given variable name

getUserCodings

java.util.List getUserCodings()

returns a list of user codings (see NUserCoding).

findCoding

NUserCoding findCoding(java.lang.String codingname,
                       java.lang.String agentname)

find a user coding for this observation that has coding and agent matching. Note that either or both Strings may be null.

addUserCoding

void addUserCoding(NUserCoding coding)

Add a user coding to the corpus. This is an administration function that allows a user to start a new observation

getNode

org.w3c.dom.Node getNode()

Get the DOM node which represents this observation in the tree. Only used by methods that edit the DOM.

setNode

void setNode(org.w3c.dom.Node node)

set the DOM node which represents this observation in the tree. Only used by methods that edit the DOM.

setDocument

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

set the DOM document of which this observation is a part Only used by methods that edit the DOM.