com.googlecode.jinahya.xml

Class ElementLocator<D>

java.lang.Object

com.googlecode.jinahya.xml.ElementLocator<D>

Type Parameters:

D - document type parameter

Direct Known Subclasses:

DOM4JElementLocator, DOMElementLocator, JDOMElementLocator, KDOMElementLocator, XOMElementLocator

public abstract class ElementLocator<D>
extends Object

Abstract element locator.

Author:

Jin Kwon

Method Summary

Methods

Modifier and Type	Method and Description
String	attribute(String namespaceURI, String localName) Finds an attribute and returns its value.
ElementLocator<D>	attribute(String namespaceURI, String localName, String value) Sets or removes attribute's value.
ElementLocator<D>	child(String localName) Adds a child element and locate it.
ElementLocator<D>	child(String localName, int index) Locates child element which has given localName in no name space at index.
ElementLocator<D>	child(String namespaceURI, String localName) Adds a child element and locate it.
ElementLocator<D>	child(String namespaceURI, String localName, int index) Locate a child element which has given localName in given namespaceURI at index.
int	count(String localName) Returns the number of child elements which each has given localName in no name space.
int	count(String namespaceURI, String localName) Returns the number of child elements which each has given localName in specified namespaceURI.
ElementLocator<D>	parent() Locates to the parent element.
ElementLocator<D>	remove() Removes currently located element and locate parent.
ElementLocator<D>	root() Locate to the root element.
String	text() Returns text value of currently located element.
ElementLocator<D>	text(String text) Sets the text value of currently located element.
abstract D	toDocument(D document) Prints contents to given document.
String	toJSON() Returns JSON representation of the contents.

Methods inherited from class java.lang.Object

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

Method Detail

count

public final int count(String localName)

Returns the number of child elements which each has given localName in no name space.

Parameters:

localName - local name

Returns:

number of children

count

public final int count(String namespaceURI,
        String localName)

Returns the number of child elements which each has given localName in specified namespaceURI. En empty string("") must be used for no(null) name space.

Parameters:

namespaceURI - The name space URI.

localName - The local name.

Returns:

child count

See Also:

#getCount(String)

root

public final ElementLocator<D> root()

Locate to the root element. Nothing happens if this locator is already locating the root element.

Returns:

self

parent

public final ElementLocator<D> parent()

Locates to the parent element. An IllegalStateException will be thrown if there is no parent to locate (on the root).

Returns:

self

child

public final ElementLocator<D> child(String localName,
                      int index)

Locates child element which has given localName in no name space at index. An IndexOutOfBoundsException will be thrown if there is no child at specified index.

Parameters:

localName - element's local name

index - child element index

Returns:

self

See Also:

child(java.lang.String, java.lang.String, int)

child

public final ElementLocator<D> child(String namespaceURI,
                      String localName,
                      int index)

Locate a child element which has given localName in given namespaceURI at index. An IndexOutOfBoundsException will be thrown if there is no child at specified index.

Parameters:

namespaceURI - element's name space URI

localName - element's local name

index - target index to locate

Returns:

self

See Also:

child(String, int)

child

public final ElementLocator<D> child(String localName)

Adds a child element and locate it. The new child element will be named as localName in no name space.

Parameters:

localName - new child element's local name.

Returns:

self

child

public final ElementLocator<D> child(String namespaceURI,
                      String localName)

Adds a child element and locate it. The new child element will be named as localName in given namespaceURI.

Parameters:

namespaceURI - child element's name space URI

localName - child element's local name

Returns:

self

text

public final String text()

Returns text value of currently located element.

Returns:

text value; may be null

text

public final ElementLocator<D> text(String text)

Sets the text value of currently located element.

Parameters:

text - new text value

Returns:

self

attribute

public final String attribute(String namespaceURI,
               String localName)

Finds an attribute and returns its value.

Parameters:

namespaceURI - attribute's name space URI

localName - attribute's local name

Returns:

attribute's value or null if not found

attribute

public final ElementLocator<D> attribute(String namespaceURI,
                          String localName,
                          String value)

Sets or removes attribute's value. If value is null mapped attribute will be removed.

Parameters:

namespaceURI - attribute's name space URI

localName - attribute's local name

value - attribute's value; null for removing attribute

Returns:

self

toDocument

public abstract D toDocument(D document)

Prints contents to given document.

Parameters:

document - an empty document

Returns:

given document

remove

public final ElementLocator<D> remove()

Removes currently located element and locate parent. An IllegalStateException will be thrown if this locate is currently locating the root element.

Returns:

self

toJSON

public final String toJSON()

Returns JSON representation of the contents.

Returns:

a JSON string.