de.pk86.bf

Class ObjectItemService

java.lang.Object

de.pk86.bf.ObjectItemService

All Implemented Interfaces:

ObjectItemServiceIF

public final class ObjectItemService
extends java.lang.Object
implements ObjectItemServiceIF

Dieser Dienst bietet die Möglichkeiten einer "Suchmaschine" im Kleinen.

• Es können "Objekte" definiert werden.
• Es können "Eigenschaften" definiert werden.
• Die Objekte können mit beliebig vielen "Eigenschaften" versehen werden.
• Mit logischen Ausdrücken (AND, OR, NOT) wird die Menge von Objekte ermittelt, welche bestimmte Eigenschaften haben.

Die so definierten "Objekte" sind hier nichts weiter als ein Identifier für eine beliebige Information; um diesem Objekt einen semantischen Inhalt zu geben wird entweder die Tabelle "Object" um weitere Spalten ergänzt oder dieser Identifiert für den Zugriff auf eine andere Datenquelle verwendet.

Eine "Eigenschaft" ist eine beliebige Zeichenkette von max. 128 Zeichen.

Vorgehen bei einer Abfrage

Es gibt grundsätzlich zwei Möglichkeiten, eine Abfrage zu erstellen:

• Durch Angabe eines Ausdrucks
• Schritt für Schritt

Ausdruck

Der Methode execute() wird ein Ausdruck in einem String übergeben und die Ergebnismenge als ein Array von Object-IDs geliefert. Der String enthält beliebig viele gültige Eigenschaften, die jeweils mit einem Operator verknüpft sind. Die Eigenschaften und Operatoren sind durch White Space voneinander getrennt.

Gültige Operatoren sind:

• | --> OR
• - --> NOT
• ^ --> XOR
• + --> AND

Der Operator AND kann auch weggelassen werden.

Beispiel:
Heiß | weiß

Z.Z. wird der Ausdruck von links nach rechts ausgewertet; es dürfen also keine Klammern angegeben werden.

Schritt für Schritt

Zuerst ist eine Transaktion zu starten (Siehe startTrans()). Eine Transaktion (oder Session) erhält dabei einen beliebigen Namen, unter dem im weiteren Verlauf auf sie Bezug genommen werden muß.

Anschließend können beliebig viele Abfragen durchgeführt werden (siehe performOper()). Jede Abfrage besteht aus einer Eigenschaft und einem Operator (AND, OR, NOT, XOR). Mit dem Operator wird das bisherige Zwischenergebnis logisch verknüpft.

• AND schränkt also die Ergebnismenge weiter ein (gib mir alle Objekte die "heiß" UND "weiß" sind).
• Ein OR erweitert die Ergebnismenge (gib mir alle Objekt die "heiß" ODER "weiß" sind).
• Ein NOT trägt alle Objekte mit dieser Eigenschaft aus der Ergebnismenge aus (laß alle Objekte weg, die "weiß" sind).
• Ob XOR zu irgendetwas gut ist ?

Bei jeder Operation wird die Größe der Ergebnismenge geliefert. Es macht zumeist keinen Sinn, sich große Ergebnismengen anzusehen, sondern diese durch weitere Operationen einzuschränken.

Hat die Ergebnismenge die gewünschte Größe, können die Objekte mit getResultSet() abgerufen werden.

Mit endTrans() wird eine Abfrage beendet und der Speicher wieder frei gegeben.

Magic Method

In manchen Fällen ist bei einer Recherche unklar, auf welche Art die Ergebnismenge weiter eingeschränkt werden kann, also welche Eigenschaften die Objekte der derzeitigen Ergebnismenge haben, aber noch nicht abgefragt wurden. Hierzu dient die Methode getOtherItems().

Performanz, Ressourcen, Begrenzungen

Der hier implementierte Suchalgorithmus ist extrem schnell. Auch dann, wenn große Datenmengen mit sehr komplexen Ausdrücken durchsucht werden. Insbesonders besteht keine Veranlassung, bei der Zuordnung von Eigenschaften zu einem Objekt zurückhaltend zu sein. Es kostet keine Performanz, wenn ein Objekt mehrere Tausend Eigenschaften hat.

Ein Beispieldatenbestand von 40000 Objekten mit 10000 Eigenschaften wobei jedes Objekt im Durchschnitt neun Eigenschaften hat benötigt ca 120MB Daten (MySQL- InnoDB).

Die Zeit für eine beliebige Abfrage liegt unter einer Millisekunde.

Hinweis

Der benötigte Speicherbedarf der Datenbank ist im Wesentlichen durch die Größe des Intervalls der Objekt-IDs definiert; es macht also Sinn, "Lücken" bei den Objekt-IDs möglichst zu vermeiden.

ToDo

• renameItem(String oldItem, String newItem);
  geht im Moment nicht, da MySQL kein DROP CONSTRAINT kann :-(
• Datenbanktabellen automatisch anlegen.
• Object-Ids fortlaufend aus dem Nummernkreis vergeben (OK). (dabei auch Lücken wieder auffüllen!).

Author:

Peter Köker

Field Summary

Fields inherited from interface de.pk86.bf.ObjectItemServiceIF

DEFAULT_DELIM, MAX_SESSIONS

Constructor Summary

Constructors

Constructor and Description
ObjectItemService() Erzeugt einen neuen Dienst.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) int	checkSessionTimeout() Nach 15 Minuten Session beenden
int	countActiveSessions()
void	createItem(java.lang.String name) Erzeugt eine neue Eigenschaft.
void	createObject(long oid, java.lang.String content) Erzeugt ein Objekt mit der angegebenen Nummer.
long	createObject(java.lang.String content) Erzeugt ein beliebiges Text-Objekt mit dem angegebenen Inhalt.
void	deleteItem(java.lang.String name) Löscht eine Eigenschaft.
boolean	endSession(int sessionId) Beendet eine Session und gibt den Speicher wieder frei.
ExpressionResult	execute(java.lang.String expression) Startet eine Session und erstellt eine Ergebnismenge aus einem Ausdruck.
java.lang.String[]	findItems(java.lang.String pattern) Liefert alle Eigenschaften, die ähnlich dem angegebenen Pattern sind (SQL LIKE).
de.jdataset.JDataSet	getFirstPage(int sessionId) Liefert die erste Seite der Ergebnismenge zu der angegebenen SessionId
int	getItemCount(java.lang.String itemname) Liefert die Anzahl der Objekt, die mit dieser Eigenschaft verknüpft sind.
int	getNewSessionId() Für neue Sessions Muß synchronized sein, damit keine doppelten SessionsIds erzeugt werden.
de.jdataset.JDataSet	getNextPage(int sessionId) Blättert vorwärts in der Ergebnismenge
java.lang.String	getObjekts(int[] oids)
java.lang.String	getObjekts(long[] oids)
java.util.Map<java.lang.String,java.lang.Integer>	getOtherItems(int sessionId) Liefert die Menge der in der Ergebnismenge noch nicht angesprochenen Eigenschaften.
de.jdataset.JDataSet	getPrevPage(int sessionId) Blättert rückwärts in der Regebnismenge
ExpressionResult	getResultSet(int sessionId) Liefert die Ergebnismenge einer Session.
boolean	hasItem(long oid, java.lang.String itemname) Deprecated. unused Prüft, ob das angegebene Objekt den angegebene Eigenschaft hat.
boolean	hasItem(java.lang.String itemname) Prüft, ob der angegebene Eigenschaft existiert.
boolean	hasNext(int sessionId) Liefert true, solange getNext() noch Ergebnisse liefert.
boolean	hasSession(int sessionId) Liefert true, wenn eine Session mit der angegebenen Id existiert vor ObjectItemServiceIF.endSession(int) aufrufen.
int	importDatabaseCSV(java.lang.String data) Importiert Objekte in die Datenbasis; Objekte werden zeilenweise erwartet; die Eigenschaften der Objekte durch white space getrennt.
int	importDatabaseDataset(de.jdataset.JDataSet data)
void	importItems(java.lang.String text, boolean lowercase) Importiert durch White Space getrennte Eigenschaften.
void	indexDatabase() Repariert die Datenbank.
(package private) void	indexObject(long oid, java.io.Reader reader, boolean createItems, boolean lowercase)
void	indexObject(long oid, java.lang.String text, boolean createItems, boolean lowercase) Indiziert ein Objekt mit durch White Space getrennte Worte.
ExpressionResult	performOper(java.util.ArrayList<OperToken> al)
int	performOper(int sessionId, java.lang.String itemname, Selection.Oper operand) Deprecated. Dieses schrittweise Vorgehen ist nicht wirklich optimal: Klammern sind so nicht möglich. Ausführen einer Operation. Diese Operation wird mit dem bisherigen Zwischenergebnis der Transaktion ausgeführt; die Größe der Ergebnismenge wird geliefert. Mit getResultSet werden die Objekte der Ergebnismenge geliefert.
void	resetAllSessions() Löscht alle Sessions
Selection	startSession() Startet eine neue Session.
void	startSpider() Startet den experimentelle Spider.
int	updateObjects(de.jdataset.JDataSet ds) Speichert den übergebenen Content

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObjectItemService

public ObjectItemService()

Erzeugt einen neuen Dienst.

Method Detail

getNewSessionId

public int getNewSessionId()

Für neue Sessions Muß synchronized sein, damit keine doppelten SessionsIds erzeugt werden.

Returns:

countActiveSessions

public int countActiveSessions()

createObject

public long createObject(java.lang.String content)

Description copied from interface: ObjectItemServiceIF

Erzeugt ein beliebiges Text-Objekt mit dem angegebenen Inhalt. Die Objekt-Id wird vom System vergeben.

Specified by:

createObject in interface ObjectItemServiceIF

Returns:

Die vergebene Objekt-Id

createObject

public void createObject(long oid,
                java.lang.String content)

Erzeugt ein Objekt mit der angegebenen Nummer.

Diese Objekt-ID ist nicht weiter als ein Identifier für eine beliebige Information. In der Datenbank kann die Tabelle "Objekt" um beliebige weitere Spalten ergänzt werden oder diese Object-ID wird als Identifier für eine andere Datenquelle verwendet.

Specified by:

createObject in interface ObjectItemServiceIF

Parameters:

oid - Object-ID

content -

Throws:

java.lang.IllegalArgumentException - wenn oid < 0 oder größer MAX_OID

createItem

public void createItem(java.lang.String name)

Erzeugt eine neue Eigenschaft.

Achtung! Die Eigenschaften sind case-sensitiv und dürfen auch White Space (Leerzeichen) enthalten.

Specified by:

createItem in interface ObjectItemServiceIF

Parameters:

name - Name der Eigenschaft; max 128 Zeichen.

deleteItem

public void deleteItem(java.lang.String name)

Löscht eine Eigenschaft.

Specified by:

deleteItem in interface ObjectItemServiceIF

Parameters:

name -

hasItem

public boolean hasItem(long oid,
              java.lang.String itemname)

Deprecated. unused Prüft, ob das angegebene Objekt den angegebene Eigenschaft hat.

Parameters:

oid -

itemname -

Returns:

boolean true, wenn das Objekt die angegebene Eigenschaft hat.

hasItem

public boolean hasItem(java.lang.String itemname)

Prüft, ob der angegebene Eigenschaft existiert.

Specified by:

hasItem in interface ObjectItemServiceIF

Parameters:

itemname -

Returns:

boolean

getItemCount

public int getItemCount(java.lang.String itemname)

Liefert die Anzahl der Objekt, die mit dieser Eigenschaft verknüpft sind.

Specified by:

getItemCount in interface ObjectItemServiceIF

Parameters:

itemname - Die Eigenschaft

Returns:

int Die Anzahl der Objekte mit dieser Eigenschaft oder -1 wenn die Eigenschaft nicht existiert.

findItems

public java.lang.String[] findItems(java.lang.String pattern)

Liefert alle Eigenschaften, die ähnlich dem angegebenen Pattern sind (SQL LIKE).

Specified by:

findItems in interface ObjectItemServiceIF

Parameters:

pattern -

Returns:

String[] Die Ergebnismenge aus der Datenbank sortiert nach Alphabet.

startSession

public Selection startSession()

Startet eine neue Session.

Specified by:

startSession in interface ObjectItemServiceIF

Returns:

sessionId, unter dieser id kann auf die Session zugegriffen werden

performOper

public int performOper(int sessionId,
              java.lang.String itemname,
              Selection.Oper operand)

Deprecated. Dieses schrittweise Vorgehen ist nicht wirklich optimal: Klammern sind so nicht möglich. Ausführen einer Operation. Diese Operation wird mit dem bisherigen Zwischenergebnis der Transaktion ausgeführt; die Größe der Ergebnismenge wird geliefert.

Mit getResultSet werden die Objekte der Ergebnismenge geliefert.

Specified by:

performOper in interface ObjectItemServiceIF

Parameters:

name - Name der Session die mit startTrans() erzeugt wurde.

itemname - Name der Eigenschaft.

operand - Einer der in der Klasse Selection definierten Operatoren (AND, OR, NOT, XOR); beim ersten Aufruf dieser Methode in einer Transaktion darf auch der Operator NONE angegeben werden.

Returns:

int Die Größe der Ergebnismenge.

performOper

public ExpressionResult performOper(java.util.ArrayList<OperToken> al)

Specified by:

performOper in interface ObjectItemServiceIF

getResultSet

public ExpressionResult getResultSet(int sessionId)

Liefert die Ergebnismenge einer Session.

Specified by:

getResultSet in interface ObjectItemServiceIF

Parameters:

name -

Returns:

ExpressionResult Die Objekt-IDs aufsteigend sortiert.

getObjekts

public java.lang.String getObjekts(int[] oids)

getObjekts

public java.lang.String getObjekts(long[] oids)

Specified by:

getObjekts in interface ObjectItemServiceIF

hasNext

public boolean hasNext(int sessionId)

Liefert true, solange getNext() noch Ergebnisse liefert.

 ObjectItemService sv = new ObjectItemService();
 String name = "MySession";
 int size = sv.execute(name, "bla blub - blob"); 
 while (sv.hasNext(name)) { 
   long[] resultSet = sv.getNext(name); 
 }
 

Specified by:

hasNext in interface ObjectItemServiceIF

Parameters:

name -

Returns:

boolean

See Also:

#getNext

getOtherItems

public java.util.Map<java.lang.String,java.lang.Integer> getOtherItems(int sessionId)

Liefert die Menge der in der Ergebnismenge noch nicht angesprochenen Eigenschaften.

Vorsicht!
Diese Methode nur aufrufen, wenn die Ergebnismenge klein ist!

Specified by:

getOtherItems in interface ObjectItemServiceIF

Parameters:

name - Eine laufende Session

Returns:

ArrayList Menge der noch verfügbaren Eigenschaften.

hasSession

public boolean hasSession(int sessionId)

Description copied from interface: ObjectItemServiceIF

Liefert true, wenn eine Session mit der angegebenen Id existiert vor ObjectItemServiceIF.endSession(int) aufrufen.

Specified by:

hasSession in interface ObjectItemServiceIF

Returns:

endSession

public boolean endSession(int sessionId)

Beendet eine Session und gibt den Speicher wieder frei.

Specified by:

endSession in interface ObjectItemServiceIF

Parameters:

sessionId -

Returns:

true, wenn Session beendet wurde.

resetAllSessions

public void resetAllSessions()

Löscht alle Sessions

Specified by:

resetAllSessions in interface ObjectItemServiceIF

execute

public ExpressionResult execute(java.lang.String expression)
                         throws java.rmi.RemoteException

Startet eine Session und erstellt eine Ergebnismenge aus einem Ausdruck.

Eigenschaften können selbst auch White Space enthalten; dann sind sie in Anführungszeichen "Meine Eigenschaft" einzuschließen.
Der Ausdruck darf Java-Style-Kommentare enthalten (// oder /*) Die Ergebnismenge selbst kann anschließend mit getResultSet() abgerufen werden, oder seitenweise mit getNext().

Specified by:

execute in interface ObjectItemServiceIF

Parameters:

name - Der Name einer Transaktion.

expression - Ein Ausdruck, bei dem gültigen Eigenschaften und Operatoren; alles durch White Space getrennt.

Returns:

int Die Größe der Ergebnismenge

Throws:

java.rmi.RemoteException

See Also:

hasNext(int), #getNext

getFirstPage

public de.jdataset.JDataSet getFirstPage(int sessionId)

Description copied from interface: ObjectItemServiceIF

Liefert die erste Seite der Ergebnismenge zu der angegebenen SessionId

Specified by:

getFirstPage in interface ObjectItemServiceIF

Returns:

getNextPage

public de.jdataset.JDataSet getNextPage(int sessionId)

Description copied from interface: ObjectItemServiceIF

Blättert vorwärts in der Ergebnismenge

Specified by:

getNextPage in interface ObjectItemServiceIF

Returns:

getPrevPage

public de.jdataset.JDataSet getPrevPage(int sessionId)

Description copied from interface: ObjectItemServiceIF

Blättert rückwärts in der Regebnismenge

Specified by:

getPrevPage in interface ObjectItemServiceIF

Returns:

updateObjects

public int updateObjects(de.jdataset.JDataSet ds)

Description copied from interface: ObjectItemServiceIF

Speichert den übergebenen Content

Specified by:

updateObjects in interface ObjectItemServiceIF

Returns:

importItems

public void importItems(java.lang.String text,
               boolean lowercase)

Importiert durch White Space getrennte Eigenschaften.

Hierbei können die Eigenschaften auch in Anführungszeichen eingeschlossen sein: "Meine Eigenschaft".

Specified by:

importItems in interface ObjectItemServiceIF

Parameters:

text -

lowercase - Wenn true wird Rudi zu rudi.

indexObject

public void indexObject(long oid,
               java.lang.String text,
               boolean createItems,
               boolean lowercase)

Indiziert ein Objekt mit durch White Space getrennte Worte.
Hierbei muß ein Wort mit einem Buchstaben anfangen.

Diese Methode könnte von einem "Spider" aufgerufen werden, der ein Text-Dokument indizieren möchte.
Wird die Eigenschaft "createItems" auf "true" gesetzt, werden die im Text enthaltenen Worte gleichzeitig als Eigenschaften in die Datenbank übernommen (Volltext-Indizierung); wenn "false", dann wird das Objekt nur mit den bereits in der Datenbank vorhandenen Eigenschaften indiziert.

Specified by:

indexObject in interface ObjectItemServiceIF

Parameters:

oid - Ein neu zu erzeugendes Objekt

text - Ein Text zu diesem Objekt, der indiziert werden soll.

createItems - wenn true, dann werden auch neue Eigenschaften erzeugt.

lowercase - Wenn true wird Rudi zu rudi.

indexObject

void indexObject(long oid,
               java.io.Reader reader,
               boolean createItems,
               boolean lowercase)

startSpider

public void startSpider()

Startet den experimentelle Spider.
In der Konfigurationsdatei ist festgelegt, welches Direktory durchsucht wird und welche File-Extensions berücksichtigt werden.

Specified by:

startSpider in interface ObjectItemServiceIF

indexDatabase

public void indexDatabase()

Repariert die Datenbank.

Specified by:

indexDatabase in interface ObjectItemServiceIF

importDatabaseCSV

public int importDatabaseCSV(java.lang.String data)

Description copied from interface: ObjectItemServiceIF

Importiert Objekte in die Datenbasis; Objekte werden zeilenweise erwartet; die Eigenschaften der Objekte durch white space getrennt.

Specified by:

importDatabaseCSV in interface ObjectItemServiceIF

Returns:

Anzahl importierter Objekte

importDatabaseDataset

public int importDatabaseDataset(de.jdataset.JDataSet data)

Specified by:

importDatabaseDataset in interface ObjectItemServiceIF

checkSessionTimeout

int checkSessionTimeout()

Nach 15 Minuten Session beenden

Returns: