name: Annotation

synopsis:


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

#include <Annotation.h>

static boolean diagnose(Integral::DEBUG debug_level);
String getId() const;
boolean setStartAnchor(Anchor* arg);
boolean setEndAnchor(Anchor* arg);
boolean setChannel(long arg);
Anchor* getStartAnchor() const;
Anchor* getEndAnchor() const;
String getType() const;
Long getChannel() const;
HashTable<String, String>& getFeatureMap();
boolean setFeatureMap(HashTable<String, String>& arg);
boolean existsFeature(const String& feature);
boolean deleteFeature(const String& feature);
boolean setFeature(String& feature, String& value);
String getFeature(const String& feature);
boolean getFeatureNames(Vector<String>& features);
boolean unsetFeatures();

quick start:


Annotation anno_00;
Anchor start_00;
Anchor end_00;
anno_00.setStartAnchor(&start_00);
anno_00.setEndAnchor(&end_00);

description:

This class is used to represent an annotation in the annotation graph.

[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"Annotation";

define i/o related constants:

static const String DEF_PARAM;

static const String PARAM_ID;

static const String PARAM_TYPE;

static const String PARAM_START;

static const String PARAM_END;

static const String PARAM_FEATURES;

static const String PARAM_CHANNEL_INDEX;

define default values:

static const long DEF_CHANNEL_INDEX = 0;

error codes:

error codes indicating general errors:

protected data:

declare the annotation id:

String id_d;

declare the annotation type:

String type_d;

declare the start anchor:

Anchor* start_d;

declare the end anchor:

Anchor* end_d;

declare the channel index:

Long channel_index_d;

declare the annotation feature map:

HashTable<String, String> feature_map_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):

~Annotation();

Annotation();

Annotation(const Annotation& arg);

Annotation(String& id, const Annotation* arg);

Annotation(String& id, Anchor* start, Anchor* end, String& type, long channel_index = DEF_CHANNEL_INDEX);

i/o methods:

long sofSize() const;

boolean read(Sof& sof, long tag);

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

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

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

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

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

equality methods:

boolean eq(const Annotation& 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 annotation property methods:

String getId() const;

String getType() const;

declare anchor methods:

boolean setStartAnchor(Anchor* arg);

boolean setEndAnchor(Anchor* arg);

Anchor* getStartAnchor() const;

Anchor* getEndAnchor() const;

declare channel methods:

Long getChannel() const;

boolean setChannel(long arg);

declare feature map methods:

HashTable<String, String>& getFeatureMap();

boolean setFeatureMap(HashTable<String, String>& arg);

boolean existsFeature(const String& feature);

boolean deleteFeature(const String& feature);

boolean setFeature(String& feature, String& value);

String getFeature(const String& feature);

boolean getFeatureNames(Vector<String>& features);

boolean unsetFeatures();

private methods:

declare friend classes:

friend class AnnotationGraph;

declare private methods:

boolean compare(const String& arg1, const String& arg2) const;

examples:

This example shows how to use the Annotation object.

notes:

none.