---

AnnotationIndex.h

Go to the documentation of this file.

// AnnotationIndex.h: This class maintains all the indexes over annotations.
// Author: Xiaoyi Ma, Steven Bird
// Copyright (C) 2001 Linguistic Data Consortium, U Penn.
// Web: http://www.ldc.upenn.edu/; Email: ldc@ldc.upenn.edu
// For license information, see the file `LICENSE' included
// with the distribution.


// The annotation data is indexed in a wide variety of ways.
// This class maintains all the indexes.

#ifndef AnnotationIndex_h
#define AnnotationIndex_h

#include <map>
#include <algorithm>

#include "AGTypes.h"
#include "Identifiers.h"
#include "Anchor.h"
#include "Annotation.h"
#include "Hash.h"

using namespace std;

// Indexes on Anchors
typedef hash_map<Id, Anchor*, hashString, StringEqual > AnchorById;
typedef map<Offset, AnchorSet, less<Offset> > AnchorSetByOffset;

// Indexes on Annotations
// - by convention we leave "annotation" out of the name
typedef hash_map<Id, Annotation*, hashString, StringEqual > ById;
typedef hash_map<String, AnnotationSet, hashString, StringEqual > ByType;
typedef map<Offset, AnnotationSet>  ByOffset;
typedef hash_map<pair<string,string>, AnnotationSet, hashStringPair, StringPairEqual >  ByFeature;
typedef hash_map<Anchor*, AnnotationSet, hashPointer, PointerEqual> ByAnchor;

class AnnotationIndex {
  friend class AG;
 private:
  AnchorSeq anchorSet;

  AnchorById anchorById;
  AnchorSetByOffset anchorSetByOffset;

  ById byId;
  ByType byType;
  ByOffset byStartAnchorOffset;
  ByOffset byEndAnchorOffset;
  ByFeature byFeature;

  ByAnchor incoming;
  ByAnchor outgoing;

  void addAnchor(Anchor*);
  void deleteAnchor(Anchor*);

 public:
  AnnotationIndex();
  ~AnnotationIndex();


  void add(Annotation* a);
  void deleteAnnotation(Annotation* a);
  void addFeature(Annotation* a, const String& feature, const String& value);
  void deleteFeature(Annotation* a, const String& feature);
  AnnotationSet getByOffset(Offset offset);
  Annotation* getAnnotationByOffset(Offset offset);
  bool existsAnnotation(const Id& id);
  bool existsAnchor(const Id& id);
  Offset getNearestOffset(Offset o);
};

#endif

---