org.corpus_tools.peppermodules.paula.util.xPointer

Class XPtrInterpreter

java.lang.Object

org.corpus_tools.peppermodules.paula.util.xPointer.XPtrInterpreter

public class XPtrInterpreter
extends Object

Die Klasse XPtrInterpreter stellt Objekte zur Verf�gung, denen XPointer �bergeben werden k�nnen und von den Objekten interprtiert werden. Ein Objekt dieser Klasse gibt eine geordnete Menge von XPointerReferenzen zur�ck, die dem gegebenen XPointer entsprechen. Verarbeitbare XPointertypen sind: Einzelelemente, Elementbereiche, Elementsequenzen.
Die unterst�tzte Syntax:
KW_SHARP := #
KW_XPTR := KW_SHARP xpointer
KW_RANGE := /range-to
KW_LBRACE := (
KW_RBRACE := )

idVal := [A-Za-z0-9_-]
ShorthandPtr := KW_SHARP idVal
idPtr := id KW_LBRACE 'idVal' KW_RBRACE
range := idPtr KW_RANGE KW_LBRACE idPtr KW_RBRACE

Einzelelement := ShorthandPtr
Elementbereich := KW_XPTR KW_LBRACE range KW_RBRACE
Elementsequenz := KW_LBRACE ( Elementbereich | Einzelelement) (Elementbereich | Einzelelement)* KW_RBRACE

Einzel-XML-Datei := [a-zA-Z_0-9]+[.][a-zA-Z_0-9]+;

Version:

1.0

Author:

Florian Zipser

Constructor Summary

Constructors

Constructor and Description
XPtrInterpreter() Erzeugt ein leeres XPtrInterpreter-Objekt.
XPtrInterpreter(String base, String xPtr) Erzeugt ein XPtrInter�reter-Objekt.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDoc() Gibt den Dokumentnamen auf den sich der Xpointer dieses Objekts zur�ck, sofern dieser gesetzt ist.
Vector<XPtrRef>	getResult() Gibt eine geordnete Menge von XPointer-Refernzielen zur�ck.
String	getXPtr() Gibt den Xpointer dieses Objekts zur�ck, sofern dieser gesetzt ist.
org.corpus_tools.peppermodules.paula.util.xPointer.XPtrInterpreter.TOKENTYPE	getXPtrType() Gibt den Typ zur�ck, den dieser XPointer hat.
void	setBase(String base) Setzt das Basisdokument neu.
void	setInterpreter(String base, String xPtr) Setzt dieses Interpreter Objekt neu. dabei wird gepr�ft ob im xPtr eine Dokumentenbasis angeben ist.
void	setXPtr(String xPtr) Setzt den XPointer, der interpretiert werden soll neu.
String	toString() Gibt Informationen �ber dieses Objekt als String zur�ck.

Methods inherited from class java.lang.Object

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

Constructor Detail

XPtrInterpreter

public XPtrInterpreter()

Erzeugt ein leeres XPtrInterpreter-Objekt. Der Dokumentname des Zieldokumentes, sowie der Xpointer m�ssen seperat gesetzt werden. Der Dokumentname muss nur dann gesetzt werden, wenn er nicht im XPointer steckt.

XPtrInterpreter

public XPtrInterpreter(String base,
               String xPtr)
                throws Exception

Erzeugt ein XPtrInter�reter-Objekt. Dabei wird der Dokumentname der XPtrRef-Objekte auf den �bergebenen gesetzt, sofern der �bergebne XPointer sich nicht auf ein anderes Dokument bezieht. Ist der base-Wert leer, muss sich das DOkument im XPointer befinden, ist auch dieser leer muss er sp�ter gesetzt werden

Parameters:

base - String - Name des Dokuments, auf das sich der XPointer bezieht

xPtr - String - zu interpretierender XPointer

Throws:

Exception

Method Detail

setInterpreter

public void setInterpreter(String base,
                  String xPtr)

Setzt dieses Interpreter Objekt neu. dabei wird gepr�ft ob im xPtr eine Dokumentenbasis angeben ist. Wenn dem so ist wird diese anstatt der �bergebenen gesetzt. Ansonsten wird die Dokumentenbasis auf base gesetzt.

Parameters:

base - String - XML-Dokumentenbasis, diese wird als Basis genommen, wenn xPtr keine enth�lt

xPtr - String - XPointerziel, eventuell mit Basis

setXPtr

public void setXPtr(String xPtr)
             throws Exception

Setzt den XPointer, der interpretiert werden soll neu.

Parameters:

xPtr - String - zu Interpretierender XPointer Wert

Throws:

Exception

setBase

public void setBase(String base)
             throws Exception

Setzt das Basisdokument neu. Auf dieses bezieht sich der �bergebene XPointer.

Parameters:

base - String - Basisdokument f�r diesen XPointer

Throws:

Exception

getXPtrType

public org.corpus_tools.peppermodules.paula.util.xPointer.XPtrInterpreter.TOKENTYPE getXPtrType()
                                                                                         throws Exception

Gibt den Typ zur�ck, den dieser XPointer hat.

Returns:

Typ des XPointers

Throws:

Fehler - , wenn XPointer nicht gesetzt

Exception

getResult

public Vector<XPtrRef> getResult()
                          throws Exception

Gibt eine geordnete Menge von XPointer-Refernzielen zur�ck.

Returns:

Ziele dieses Xpointers

Throws:

Exception

getXPtr

public String getXPtr()

Gibt den Xpointer dieses Objekts zur�ck, sofern dieser gesetzt ist.

Returns:

XPointer dieses Objekts

getDoc

public String getDoc()

Gibt den Dokumentnamen auf den sich der Xpointer dieses Objekts zur�ck, sofern dieser gesetzt ist.

Returns:

Dokumentname

toString

public String toString()

Gibt Informationen �ber dieses Objekt als String zur�ck.

Overrides:

toString in class Object

Returns:

String - Informationen �ber dieses Objekt