Package org.basex.query.iter

Class AtomIter

java.lang.Object

org.basex.query.iter.Iter

org.basex.query.iter.AtomIter

public final class AtomIter
extends Iter

Atomization iterator.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Constructor Summary

Constructors

Constructor	Description
AtomIter(Iter iter, QueryContext qc, InputInfo info, long size)	Constructor.

Method Summary

Modifier and Type	Method	Description
Item	get(long i)	Returns the specified item, or an arbitrary item if the index is invalid.
Item	next()	Returns the next item.
long	size()	Returns the iterator size.

Methods inherited from class org.basex.query.iter.Iter

iterValue, value

Methods inherited from class java.lang.Object

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

Constructor Details

AtomIter

public AtomIter(Iter iter,
 QueryContext qc,
 InputInfo info,
 long size)

Constructor.

Parameters:

iter - input iterator

qc - query context

info - input info

size - iterator size (can be -1)

Method Details

next

public Item next()
          throws QueryException

Description copied from class: Iter

Returns the next item.

Specified by:

next in class Iter

Returns:

resulting item, or null if all items have been returned

Throws:

QueryException - query exception

size

public long size()

Description copied from class: Iter

Returns the iterator size. -1 is returned if the result size is unknown. If this method returns a positive value, Iter.get(long) needs to be implemented as well.

Overrides:

size in class Iter

Returns:

number of entries

get

public Item get(long i)
         throws QueryException

Description copied from class: Iter

Returns the specified item, or an arbitrary item if the index is invalid. If this method returns items, Iter.size() needs to be implemented as well.

Overrides:

get in class Iter

Parameters:

i - value offset (starting with 0)

Returns:

specified item or null

Throws:

QueryException - query exception