gate
Interface FeatureMap

All Superinterfaces:
Map<Object,Object>, SimpleFeatureMap
All Known Implementing Classes:
SimpleFeatureMapImpl

public interface FeatureMap
extends SimpleFeatureMap

An attribute-value matrix. Represents the content of an annotation, the meta-data on a resource, and anything else we feel like. The event code is needed so a persistent annotation can fire updated events when its features are updated


Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Method Summary
 void addFeatureMapListener(FeatureMapListener l)
          Adds a gate listener
 void removeFeatureMapListener(FeatureMapListener l)
          Removes a gate listener
 boolean subsumes(FeatureMap aFeatureMap)
          Tests if this featureMap object includes aFeatureMap features.
 boolean subsumes(FeatureMap aFeatureMap, Set aFeatureNamesSet)
          Tests if this featureMap object includes aFeatureMap but only for the features present in the aFeatureNamesSet.
 boolean subsumes(Ontology ontologyLR, FeatureMap aFeatureMap)
          Tests if this featureMap object includes aFeatureMap features.
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Method Detail

subsumes

boolean subsumes(FeatureMap aFeatureMap)
Tests if this featureMap object includes aFeatureMap features.

Parameters:
aFeatureMap - object which will be included or not in this FeatureMap obj.
Returns:
true if this includes aFeatureMap and false if not.

subsumes

boolean subsumes(Ontology ontologyLR,
                 FeatureMap aFeatureMap)
Tests if this featureMap object includes aFeatureMap features.
If the feature map contains class and (optionally) ontology features:
then the ontologyLR is used to provide ontology based subsume with respect to the subClassOf relations.

Parameters:
ontologyLR - an ontology to be used for the subsume
aFeatureMap - object which will be included or not in this FeatureMap obj.
Returns:
true if this includes aFeatureMap and false if not.

subsumes

boolean subsumes(FeatureMap aFeatureMap,
                 Set aFeatureNamesSet)
Tests if this featureMap object includes aFeatureMap but only for the features present in the aFeatureNamesSet.

Parameters:
aFeatureMap - which will be included or not in this FeatureMap obj.
aFeatureNamesSet - is a set of strings representing the names of the features that would be considered for subsumes.
Returns:
true if all features present in the aFeaturesNameSet from aFeatureMap are included in this obj, or false otherwise.

removeFeatureMapListener

void removeFeatureMapListener(FeatureMapListener l)
Removes a gate listener


addFeatureMapListener

void addFeatureMapListener(FeatureMapListener l)
Adds a gate listener