name: Identifier

synopsis:


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

#include <Identifier.h>

static boolean diagnose(Integral::DEBUG debug_level);
const String registerId();
const String registerId(const String& id);
boolean existsId(const String& id);
boolean reclaimId(const String& id);
String getNamespace(const String& id);
Annotation* getAnnotationRef(const String& id);
Anchor* getAnchorRef(const String& id);
boolean deleteAnnotationRef(const String& id);
boolean deleteAnchorRef(const String& id);
boolean addAnnotationRef(const String& id, Annotation* ref);
boolean addAnchorRef(const String& id, Anchor* ref);
boolean existsAnnotation(const String& id);
boolean existsAnchor(const String& id);

quick start:


String database(L"Timit");
String anchor(L"Anchor1");

Identifier ident_00(database, anchor);
ident_00.registerId();
ident_00.existsId(L"Timit:Anchor1");

description:

This class is used to represent an identifier 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"Identifier";

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

error codes:

error codes indicating general errors:

protected data:

declare the identifier namespace:

String namespace_d;

declare the identifier type:

String type_d;

declare define the collection of identifiers already issued:

DoubleLinkedList<String> issued_d;

declare define the highest id issued so far:

Long curr_d;

declare define the table of anchors:

HashTable<String, Anchor> anchors_d;

declare define the table of annotations:

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

~Identifier();

Identifier();

Identifier(const Identifier& arg);

Identifier(String& id, String& type);

assign methods:
```
boolean assign(const Identifier& 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 Identifier& 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 identifier methods:

const String registerId();

const String registerId(const String& id);

boolean existsId(const String& id);

boolean reclaimId(const String& id);

String getNamespace(const String& id);

declare annotation related methods:

Annotation* getAnnotationRef(const String& id);

boolean deleteAnnotationRef(const String& id);

boolean addAnnotationRef(const String& id, Annotation* ref);

boolean existsAnnotation(const String& id);

declare anchor related methods:

Anchor* getAnchorRef(const String& id);

boolean deleteAnchorRef(const String& id);

boolean addAnchorRef(const String& id, Anchor* ref);

boolean existsAnchor(const String& id);

private methods:

declare private methods:

examples:

This example shows how to use the Identifier object.

notes:

none.