name: AnnotationIndex

synopsis:


g++ [flags ...] file ... -l /isip/tools/lib/$ISIP_BINARY/lib_mmedia.a

#include <AnnotationIndex.h>

static boolean diagnose(Integral::DEBUG debug_level);
boolean add(Annotation* a);
boolean deleteAnnotation(Annotation* anno);
boolean existsAnnotation(const String& id);
boolean existsAnchor(const String& id);
float getNearestOffset(float offset);
boolean getByOffset(float offset, DoubleLinkedList<Annotation>& list);
Annotation* getAnnotationByOffset(float offset);
boolean addFeature(Annotation* anno, const String& feature, const String& value);
boolean deleteFeature(Annotation* anno, const String& feature);
boolean existsFeature(const String& feature, const String& value);

quick start:


String anno_name_00(L"Annotation1");
String unit_00(L"seconds");

String ancr_name_00(L"Anchor1");
String ancr_name_01(L"Anchor2");

float offset_00 = 2.409875;
float offset_01 = 2.649875;

Anchor ancr_00(ancr_name_00, offset_00, unit_00);
Anchor ancr_01(ancr_name_01, offset_01, unit_00);

String type_00(L"oh i see uh-huh");
String feat_00(L"feature1");
String value_00(L"value1");

Annotation anno_00(anno_name_00, &ancr_00, &ancr_01, type_00);
anno_00.setFeature(feat_00, value_00);

AnnotationIndex andx_00;

andx_00.add(&anno_00);

description:

This class is used for quick access to annotations and anchors in the annotation library.

[1] S. Bird, M. Liberman, A Formal Framework for Linguistic Annotation, Linguistic Data Consortium, University of Pennsylvania, Philadelphia, Pennsylvania, USA, 2000. [2] K. Maeda, X. Ma, H. Lee, S. Bird, The Annotation Graph Toolkit: Application Developer's Manual (Draft), Linguistic Data Consortium, University of Pennsylvania, Philadelphia, Pennsylvania, USA, 2001.

dependencies:

public constants:

define the class name:

static const String CLASS_NAME = L"AnnotationIndex";

define i/o related constants:
```
static const String DEF_PARAM;
```

error codes:

error codes indicating general errors:

protected data:

declare a list to store the set of anchors:

DoubleLinkedList<Anchor> ancrset_d;

declare the anchors indexed by identifiers:

HashTable<String, Anchor> ancr_by_id_d;

declare the anchor set indexed by the offset:

HashTable<Float, DoubleLinkedList<Anchor> > ancrset_by_offset_d;

declare the annotations indexed by identifiers:

HashTable<String, Annotation> anno_by_id_d;

declare the annotations indexed by type:

HashTable<String, DoubleLinkedList<Annotation> > anno_by_type_d;

declare annotations indexed by the offset of start anchor:

HashTable<Float, DoubleLinkedList<Annotation> > start_by_offset_d;

declare annotations indexed by the offset of end anchor:

HashTable<Float, DoubleLinkedList<Annotation> > end_by_offset_d;

declare annotations indexed by their end anchor:

HashTable<HashKey<Anchor>, DoubleLinkedList<Annotation> > incoming_d;

declare annotations indexed by their start anchor:

HashTable<HashKey<Anchor>, DoubleLinkedList<Annotation> > outgoing_d;

declare annotations indexed by their feature:

HashTable<String, DoubleLinkedList<Annotation> > by_feature_d;

declare the debugging parameters:
```
static Integral::DEBUG debug_level_d;
```
declare the memory manager:
```
static MemoryManager mgr_d;
```

required public methods:

static methods:
```
static const String& name();
```

debug methods:

boolean debug(const unichar* msg) const;

static boolean setDebug(Integral::DEBUG arg);

static boolean diagnose(Integral::DEBUG debug_level);

destructor/constructor(s):

~AnnotationIndex();

AnnotationIndex();

AnnotationIndex(const AnnotationIndex& arg);

assign methods:

boolean assign(const AnnotationIndex& arg);

operator= method:
```
not present.
```

i/o methods:

long sofSize() const;

boolean read(Sof& sof, long tag);

boolean write(Sof& sof, long tag) const;

boolean read(Sof& sof, long tag, const String& name);

boolean readData(Sof& sof, const String& pname = DEF_PARAM, long size = SofParser::FULL_OBJECT, boolean param = true, boolean nested = false);

boolean write(Sof& sof, long tag, const String& name) const;

boolean writeData(Sof& sof, const String& pname =  DEF_PARAM) const;

equality methods:

boolean eq(const AnnotationIndex& arg) const;

memory management methods:

static void* operator new(size_t arg);

static void* operator new[](size_t arg);

static void operator delete(void* arg);

static void operator delete[](void* arg);

static boolean setGrowSize(long arg);

boolean clear(Integral::CMODE cmode = Integral::DEF_CMODE);

class-specific public methods:

declare anchor related methods:

boolean existsAnchor(const String& id);

float getNearestOffset(float offset);

boolean getByOffset(float offset, DoubleLinkedList<Annotation>& list);

declare annotation related methods:

boolean add(Annotation* a);

boolean deleteAnnotation(Annotation* anno);

boolean existsAnnotation(const String& id);

Annotation* getAnnotationByOffset(float offset);

declare feature map related methods:

boolean addFeature(Annotation* anno, const String& feature, const String& value);

boolean deleteFeature(Annotation* anno, const String& feature);

boolean existsFeature(const String& feature, const String& value);

private methods:

declare friend classes:

friend class AnnotationGraph;

declare private methods:

boolean addAnchor(Anchor* ancr);

boolean deleteAnchor(Anchor*ancr);

examples:

This example shows how to use the AnnotationIndex object.

notes:

none.