The GroupIndex Template Library

---

groupindex::IndexCommandLine< CIndex, CInterface > Class Template Reference

Diese Template-Klasse erstellt für eine groupindex::GroupIndex - Klasse automatisch ein Shell-Tool für ein Indexierungssystem. More...

#include <IndexCommandLine.h>

Collaboration diagram for groupindex::IndexCommandLine< CIndex, CInterface >:

[legend]List of all members.

Public Member Functions
int	command (int argc, char **args)
int	run ()
Protected Attributes
CIndex::IndexRepresentation	dr
std::fstream	idxstream
std::fstream	idxHeapStream
CIndex *	groupindex
char	indexfilename [1024]
char *	indexdirname
char *	indexfname
char *	heapfname
int	mismatches

---

Detailed Description

template<class CIndex, class CInterface>
class groupindex::IndexCommandLine< CIndex, CInterface >

Diese Template-Klasse erstellt für eine groupindex::GroupIndex - Klasse automatisch ein Shell-Tool für ein Indexierungssystem.

Dieses erlaubt durch einen kleinen Befehlssatz Zugriff auf Indexe, so z.B. das Erstellen, Modifizieren und Durchsuchen von Indexen. Zum Einlesen von Dateien bzw. zum Parsen von Indexdateien und Suchanfragen muss eine Klasse CInterface implementiert werden. Diese muss lediglich zwei statische Methoden unterstützen:

•  static void CInterface::parseQuery(char* query_desc, std::set<CIndex::IndexSet>& query); 
  

  Parst die in query_desc angegebene Anfrage und erzeugt daraus ein Stl-set, welches die in query_desc enthaltenen Anfragelemente enthält. Diese Anfrage enthält Instanzen der Mengenklasse. Die Klasse CIndex::IndexSet ist genau dieselbe wie die Mengenklasse, die der Klasse CIndex als Mengenklasse übergeben wurde. Der übergegebene String query_desc kann wohlgemerkt auch als Dateiname interpretiert werden, so dass CInterface::parseQuery den Inhalt dieser Datei parst.

•  static void CInterface::readDataFile(char* filename, CIndex& groupindex); 
  

  Parst die in filename angegebene Datei und fügt die darin enthaltenen Elemente in das Index-Objekt groupindex ein.

Ein IndexCommandLine - Objekt kann einfach mit dem Standard-Konstruktor erzeugt und mit der run() - Methode gestartet werden. Damit besteht z.B. die main() - Routine eines einfachen Indexierungssystems aus den folgenden Programmzeilen:

 int main(int argc, char** args)
 {
    IndexCommandLine<myIndexType,myInterface> icl;
    icl.run();
 }

Die Index-Shell benötigt für viele Operationen einen aktuellen Index. Ein solcher kann mit dem Befehl OPEN geöffnet bzw. neu angelegt werden. Es stehen dann folgende Befehle zur Verfügung:

• ADD

...

;
Fügt datafile1 ... datafileN in den aktuell geöffneten Index ein. Es muss zuvor ein Index mit OPEN

geöffnet worden sein.

• REMOVE

...

;
Entfernt datafile1 ... datafileN aus dem aktuellen Index. Es muss zuvor ein Index mit OPEN

geöffnet worden sein.

• MERGE

;
Vereinigt den aktuellen Index mit dem in der Indexdatei indexfile2 enthaltenen Index. indexfile2 muss eine gültige Indexdatei vom selben Typ wie der aktuelle Index sein. Sind in Dateinamen vorhanden, die im aktuellen Index bereits existieren, so werden diese umbenannt und erhalten einen eindeutigen Namen.

• EXIT;
  Beendet die Index-Shell.
• LIST;
  Listet alle Dateinamen auf, die im aktuellen Index gespeichert sind.
• MISMATCHES

;
setzt die Anzahl der zulässigen Mismatches für Suchanfragen auf N. Standard-Wert ist 0.

• OPEN

;
öffnet die Index-Datei indexfile und macht diesen Index zum aktuellen Index. Existiert indexfile nicht, so wird diese angelegt.

• CLOSE;
  Schliesst den aktuellen Index.

Die Syntax der Befehle ist nicht case-sensitive. Befehle müssen mit einem ";" und einem Zeilenende abgeschlossen werden. Die Befehle MISMATCHES und EXIT benötigen kein aktuelles Index-Objekt.

---

The documentation for this class was generated from the following file:

• IndexCommandLine.h

The GroupIndex-Template-Library
Universität Bonn, Institut für Informatik III, 2001