name: SymbolGraphDatabase

synopsis:


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

#include <SymbolGraphDatabase.h>

String& getDataBaseName();
boolean setDataBaseName(String& arg);
boolean setDataBaseSof(Sof& sof);
boolean getRecord(String& identifier, Filename& record);
boolean removeRecord(String& identifier);
boolean insertRecord(String& identifier, Long& index);
boolean load(Sdb& id_list, Sdb& file_list, Vector<Filename>& file_vec);
boolean store(Sof& db_sof, long tag, Vector<Filename>& file_vec);

quick start:


String name_00(L"TIDIGITS");

SymbolGraphDatabase audb_00;
audb_00.setDataBaseName(name_00);

description:

This class facilitates the interface between the symbol graph database and another applications or classes.

dependencies:

none.

public constants:

define the class name:
```
static const String CLASS_NAME;
```

i/o related constants:

static const String DEF_PARAM;

static const String PARAM_KEYS;

static const String PARAM_NAME;

static const String PARAM_VALUES;

error codes:

error codes indicating general errors:

protected data:

declare the database name:

String name_d;

define the container object:

HashTable<String, Long> hash_d;

define the database file pointer:

Sof* database_sof_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:

static boolean diagnose(Integral::DEBUG debug_level);

boolean debug(const unichar* msg) const;

static boolean setDebug(Integral::DEBUG arg);

destructor/constructor(s):

~SymbolGraphDatabase();

SymbolGraphDatabase();

SymbolGraphDatabase(const SymbolGraphDatabase& arg);

assign methods:

boolean assign(const SymbolGraphDatabase& arg);

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

i/o methods:

long sofSize() const;

boolean read(Sof& sof, long tag);

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;

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 SymbolGraphDatabase& 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 database property methods:

String& getDataBaseName();

boolean setDataBaseName(String& arg);

boolean setDataBaseSof(Sof& sof);

declare database record methods:

boolean getRecord(String& identifier, Filename& record);

boolean removeRecord(String& identifier);

boolean insertRecord(String& identifier, Long& index);

declare database i/o methods:

boolean load(Sdb& id_list, Sdb& file_list, Vector<Filename>& file_vec);

boolean load(Filename& file_list, Vector<Filename>& file_vec);

boolean store(Sof& db_sof, long tag, Vector<Filename>& file_vec);

private methods:

declare private methods:

examples:

This example shows how to generate an SymbolGraph database given identifiers and file list.

notes:

none.