org.corpus_tools.peppermodules.paula.util.xPointer

Class XPtrRef

java.lang.Object

org.corpus_tools.peppermodules.paula.util.xPointer.XPtrRef

public class XPtrRef
extends Object

Die Klasse XPtrRef stellt Objekte zur Verfuegung, die Informationen ueber das Refernzziel eines XPointers enthalten. Dabei wird in zwei Arten eines referenzziels unterschieden. Dies sind zum einen Einzelelemente, die sich dadurch auszeichnen das sie nur ein Element als Ziel enthalten. Zum anderen sind dies Elementbereiche. Referenzen dieser Art enthalten mehrere Elemente als Ziel. Ein Objekt dieser Klasse haelt dazu den id-Wert der linken Grenze und den der rechten Grenze des Elementbereichs.

Version:

1.0

Author:

Florian Zipser

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPtrRef.POINTERTYPE Ein Pointer kann Elementknoten, oder Textknoten als Ziel haben.

Constructor Summary

Constructors

Constructor and Description
XPtrRef(String docName, String id) Erzeugt ein XPointer-Refernzziel Element.
XPtrRef(String docName, String left, String right) Erzeugt ein XPointer-Refernzziel Element.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDoc() Gibt den Namen des Dokumentes zur�ck, auf das der XPointer zeigt.
String	getID() Gibt das Ziel dieser XPointer-Referenz zur�ck, wenn es sich bei diesem XPointer-Referenz um ein Einzelelement handelt.
String	getLeft() Gibt die linke Bereichsgrenze des Ziels dieser XPointer-Referenz zur�ck, wenn es sich bei dieser XPointer-Referenz um ein Elementbereich handelt.
String	getRight() Gibt die rechte Bereichsgrenze des Ziels dieser XPointer-Referenz zur�ck, wenn es sich bei dieser XPointer-Referenz um ein Elementbereich handelt.
XPtrRef.POINTERTYPE	getType() Gibt den Typ dieses Pointers zur�ck.
boolean	isRange() Gibt an, ob es sich bei dieser XPointer-Adresse um ein Einzelement oder einen Elementbereich handelt.
void	setType(XPtrRef.POINTERTYPE type) Setzt den Typ dieses Pointers.
String	toString() Gibt Informationen ueber 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

XPtrRef

public XPtrRef(String docName,
       String id)
        throws Exception

Erzeugt ein XPointer-Refernzziel Element. Dieses Element ist vom Typ Einzelelement.

Parameters:

docName - String - Name des Dokumentes, aus dem das Zielelement stammt

id - String - ID des Zielelementes

Throws:

Exception

XPtrRef

public XPtrRef(String docName,
       String left,
       String right)
        throws Exception

Erzeugt ein XPointer-Refernzziel Element. Dieses Element ist vom Typ Elementbereich.

Parameters:

docName - String - Name des Dokumentes, aus dem das Zielelement stammt

left - String - id des Elementes, das die linke Grenze bildet

right - String - id des Elementes, das die rechte Grenze bildet

Throws:

Exception

Method Detail

setType

public void setType(XPtrRef.POINTERTYPE type)
             throws Exception

Setzt den Typ dieses Pointers.

Parameters:

type - POINTERTYPE - Typ dieses Pointers, muss ungleich NOTSET sein

Throws:

Exception

getType

public XPtrRef.POINTERTYPE getType()

Gibt den Typ dieses Pointers zur�ck.

Returns:

Typ dieses Pointers.

isRange

public boolean isRange()

Gibt an, ob es sich bei dieser XPointer-Adresse um ein Einzelement oder einen Elementbereich handelt.

Returns:

true, wenn Adresse ein Elementbereich

getDoc

public String getDoc()

Gibt den Namen des Dokumentes zur�ck, auf das der XPointer zeigt. Dieses Element enth�lt das Element mit der id bzw. Elemente mit linker und rechter Bereichsgrenze.

Returns:

Dokumentname des Zieldokuments

getID

public String getID()
             throws Exception

Gibt das Ziel dieser XPointer-Referenz zur�ck, wenn es sich bei diesem XPointer-Referenz um ein Einzelelement handelt.

Returns:

ID-Wert des Ziels dieser Referenz

Throws:

Exception - Fehler, wenn Referenz kein Einzelelement

getLeft

public String getLeft()
               throws Exception

Gibt die linke Bereichsgrenze des Ziels dieser XPointer-Referenz zur�ck, wenn es sich bei dieser XPointer-Referenz um ein Elementbereich handelt.

Returns:

ID-Wert des linken Rand des Ziels dieser Referenz

Throws:

Exception - Fehler, wenn Referenz kein Elementbereich

getRight

public String getRight()
                throws Exception

Gibt die rechte Bereichsgrenze des Ziels dieser XPointer-Referenz zur�ck, wenn es sich bei dieser XPointer-Referenz um ein Elementbereich handelt.

Returns:

ID-Wert des rechten Rand des Ziels dieser Referenz

Throws:

Exception - Fehler, wenn Referenz kein Elementbereich

toString

public String toString()

Gibt Informationen ueber dieses Objekt als String zur�ck.

Overrides:

toString in class Object

Returns:

String - Informationen ueber dieses Objekt