Package org.odftoolkit.odfdom.incubator.search

Class Navigation<T extends Selection>

java.lang.Object

org.odftoolkit.odfdom.incubator.search.Navigation<T>

All Implemented Interfaces:

Iterator<T>

Direct Known Subclasses:

TextNavigation, TextStyleNavigation

public abstract class Navigation<T extends Selection>
extends Object
implements Iterator<T>

Abstract class Navigation used to navigate the document and find the matched element by the user defined conditions

Constructor Summary

Constructors

Constructor	Description
Navigation()

Method Summary

Modifier and Type	Method	Description
abstract OdfElement	getElement()
protected Node	getNextMatchElement(Node startpoint)	get the next matched element in a whole dom tree
protected Node	getNextMatchElementInTree(Node startpoint, Node root)	get the next matched element in a sub tree
abstract boolean	hasNext()	Return true if document still has more matched Selection when traversing the document(In other words return true if next() would return an element instance rather than return null)
abstract boolean	match(Node element)	check if the element match the user defined condition
abstract T	next()	get the current Selection result

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

Navigation

public Navigation()

Method Detail

hasNext

public abstract boolean hasNext()

Return true if document still has more matched Selection when traversing the document(In other words return true if next() would return an element instance rather than return null)

Specified by:

hasNext in interface Iterator<T extends Selection>

Returns:

true if document still has more matched Selection, and vice versa

getElement

public abstract OdfElement getElement()

next

public abstract T next()

get the current Selection result

Specified by:

next in interface Iterator<T extends Selection>

Returns:

the current Selection result

match

public abstract boolean match(Node element)

check if the element match the user defined condition

Parameters:

element - navigate this element

Returns:

true if the element match the user defined condition; false if not match

getNextMatchElement

protected Node getNextMatchElement(Node startpoint)

get the next matched element in a whole dom tree

Parameters:

startpoint - navigate from the startpoint

Returns:

the next matched element

getNextMatchElementInTree

protected Node getNextMatchElementInTree(Node startpoint,
                                         Node root)

get the next matched element in a sub tree

Parameters:

startpoint - navigate from the startpoint

root - the root of the sub tree

Returns:

the next matched element