Salt  3.4.2
A powerful, tagset-independent and theory-neutral meta model and API for storing, manipulating, and representing nearly all types of linguistic data .
org.corpus_tools.salt.core.SMetaAnnotation Interface Reference

Inherits org.corpus_tools.salt.core.SAbstractAnnotation.

Inherited by org.corpus_tools.salt.core.impl.SMetaAnnotationImpl.

Additional Inherited Members

- Public Member Functions inherited from org.corpus_tools.salt.core.SAbstractAnnotation
SDATATYPE getValueType ()
 Returns the value of the 'SValue Type' attribute. More...
 
void setValueType (SDATATYPE value)
 
String getValue_STEXT ()
 Returns the sValue attribute of this object as String representation. More...
 
Boolean getValue_SBOOLEAN ()
 Returns the sValue attribute of this object as Boolean if possible. More...
 
Long getValue_SNUMERIC ()
 Returns the sValue attribute of this object as Long if possible. More...
 
Double getValue_SFLOAT ()
 Returns the sValue attribute of this object as Float if possible. More...
 
URI getValue_SURI ()
 Returns the sValue attribute of this object as URI if possible. More...
 
Object getValue_SOBJECT ()
 Returns the the sValue attribute of this object as the original object. More...
 
- Public Member Functions inherited from org.corpus_tools.salt.graph.Label
String getNamespace ()
 Returns the optional namespace of the label. More...
 
void setNamespace (String namespace)
 Sets the optional namespace of the label. More...
 
String getName ()
 Returns the name of the label. More...
 
void setName (String name)
 Sets the name of the label. More...
 
String getQName ()
 Returns the qName of this label, which is the combination of namespace and name must be unique in the containing object. More...
 
void setQName (String qName)
 Sets the qName of this label, which is the combination of namespace and name must be unique in the containing object. More...
 
Object getValue ()
 Returns the value of this label. More...
 
void setValue (Object value)
 Sets the value of this label. More...
 
public< C extends LabelableElement > C getContainer ()
 Returns the container element, which contains this label. More...
 
public< C extends LabelableElement > void setContainer (C container)
 Sets the container element, which contains this label. More...
 
- Public Member Functions inherited from org.corpus_tools.salt.graph.LabelableElement
Collection< LabelgetLabels ()
 Returns all labels being contained by this object. More...
 
void addLabel (Label label)
 Adds the given Label object to the list of labels. More...
 
Label getLabel (String namespace, String name)
 Returns a label having the passed namespace and name, if such a label is contained by this object. More...
 
Label getLabel (String qName)
 Returns a label having the passed qualified name. More...
 
void removeLabel (String qName)
 Removes the label having the passed qName. More...
 
void removeLabel (String namespace, String name)
 Removes a Label object from the list of labels of this object. More...
 
void removeAll ()
 Removes all Label objects.
 
Set< LabelgetLabelsByNamespace (String namespace)
 Returns a set containing all Label objects having the given namespace. More...
 
boolean containsLabel (String qName)
 Checks if this object has a Label object in its list having the given qualified name. More...
 
Integer sizeLabels ()
 returns the number of Label objects contained by this object. More...
 
- Public Member Functions inherited from org.corpus_tools.salt.util.Copyable< T >
copy (T other)
 Takes a new 'empty' object and sets all its fields by copying by value. More...
 
- Public Member Functions inherited from org.corpus_tools.salt.core.SAnnotationContainer
SAnnotation createAnnotation (String namespace, String name, Object value)
 Creates and returns an annotation having the passed namespace, name and value. More...
 
public< A extends SAnnotation > Set< A > createAnnotations (String annotationString)
 This method parses the given annotation String and adds an SAnnotation object for each annotation being contained in that string to the given SAnnotationContainer object. More...
 
public< A extends SAnnotation > Set< A > getAnnotations ()
 Returns all annotations contained by this object. More...
 
void addAnnotation (SAnnotation annotation)
 Adds the passed annotation to this container. More...
 
SAnnotation getAnnotation (String qName)
 Returns an annotation having the passed qualified name, if this container contains such an annotation. More...
 
SAnnotation getAnnotation (String namespace, String name)
 Returns an annotation having the passed qualified name, if this container contains such an annotation. More...
 
Iterator< SAnnotationiterator_SAnnotation ()
 Returns an iterator to iterate over the SAnnotation objects contained by this container. More...
 
SMetaAnnotation createMetaAnnotation (String namespace, String name, Object value)
 Creates and returns a meta annotation having the passed namespace, name and value. More...
 
public< A extends SMetaAnnotation > Set< A > createMetaAnnotations (String metaAnnotationString)
 This method parses the given meta annotation String and adds an SMetaAnnotation object for each meta annotation being contained in that string to the given SAnnotationContainer object. More...
 
public< A extends SMetaAnnotation > Set< A > getMetaAnnotations ()
 Returns all meta annotations contained by this object. More...
 
void addMetaAnnotation (SMetaAnnotation metaAnnotation)
 Adds the passed meta annotation to this container. More...
 
SMetaAnnotation getMetaAnnotation (String qName)
 Returns a meta annotation having the passed qualified name, if this container contains such a meta annotation. More...
 
Iterator< SMetaAnnotationiterator_SMetaAnnotation ()
 Returns an iterator to iterate over the SMetaAnnotation objects contained by this container. More...
 
SProcessingAnnotation createProcessingAnnotation (String namespace, String name, Object value)
 Creates and returns a processing-annotation having the passed namespace, name and value. More...
 
public< A extends SProcessingAnnotation > Set< A > createProcessingAnnotations (String annotationString)
 This method parses the given processing-annotation String and adds an SProcessingAnnotation object for each processing-annotation being contained in that string to the given SAnnotationContainer object. More...
 
public< A extends SProcessingAnnotation > Set< A > getProcessingAnnotations ()
 Returns all processing-annotations contained by this object. More...
 
void addProcessingAnnotation (SProcessingAnnotation processingAnnotation)
 Adds the passed processing-annotation to this container. More...
 
SProcessingAnnotation getProcessingAnnotation (String qName)
 Returns a processing-annotation having the passed qualified name, if this container contains such a processing-annotation. More...
 
Iterator< SProcessingAnnotationiterator_SProcessingAnnotation ()
 Returns an iterator to iterate over the SProcessingAnnotation objects contained by this container. More...
 
SFeature createFeature (String namespace, String name, Object value)
 Creates and returns an feature having the passed namespace, name and value. More...
 
public< A extends SFeature > Set< A > createFeatures (String featureString)
 This method parses the given feature String and adds an SFeature object for each feature being contained in that string to the given SAnnotationContainer object. More...
 
public< A extends SFeature > Set< A > getFeatures ()
 Returns all features contained by this object. More...
 
void addFeature (SFeature feature)
 Adds the passed feature to this container. More...
 
SFeature getFeature (String qName)
 Returns an feature having the passed qualified name, if this container contains such an feature. More...
 
SFeature getFeature (String namespace, String name)
 Returns an feature having the passed qualified name, if this container contains such an feature. More...
 
Iterator< SFeatureiterator_SFeature ()
 Returns an iterator to iterate over the SFeature objects contained by this container. More...
 
- Static Public Attributes inherited from org.corpus_tools.salt.graph.Label
static final String NS_SEPERATOR = "::"
 Separator between namespace and name: qname= NAMESPACE {@value NS_SEPERATOR} NAME.
 

Detailed Description

Meta annotations are very useful for instance to document the creation process or the aim of a corpus, a sub corpus or a document. These information are supposed to give a person working with this corpus additional non-linguistic information. For instance which tools have been used, which persons have annotated the corpus, when was the corpus annotated and so on. Let's give an example: A meta annotation describing the creation date of the origin would have the sName="date" and the sValue="1487" and an empty sNS can be added to a SCorpus. Salt is an open model, which means, there are no limitations on naming a meta annotation. Further, Salt does not interpret them, therefore the meta annotation for determining the author can also be named 'creator' or something else instead of 'author'.

The most convenient way to use meta annotations is to add a meta annotation to a document node or a corpus node. But since a meta annotation is just a label of a specific type, you are free to add it to each node or edge in the Salt model (for instance to annotate a specific node being created by from a specific annotator).

A SFeature could be used, to add some information to any Salt object during a processing. So for instance you can store any state like 'already processed' or other non-linguistic and non meta annotations like 'having the color red' to it.

For further information on labels,

See also
Label
Author
florian