org.apache.jackrabbit.jcr2spi

Class LazyItemIterator

java.lang.Object

org.apache.jackrabbit.jcr2spi.LazyItemIterator

All Implemented Interfaces:

Iterator, javax.jcr.NodeIterator, javax.jcr.PropertyIterator, javax.jcr.RangeIterator, javax.jcr.version.VersionIterator

public class LazyItemIterator
extends Object
implements javax.jcr.NodeIterator, javax.jcr.PropertyIterator, javax.jcr.version.VersionIterator

LazyItemIterator is an id-based iterator that instantiates the Items only when they are requested.

Important: Items that appear to be nonexistent for some reason (e.g. because of insufficient access rights or because they have been removed since the iterator has been retrieved) are silently skipped. As a result the size of the iterator as reported by getSize() always returns -1.

Property Summary

Properties

Type	Property and Description
javax.jcr.Property	next

Constructor Summary

Constructors

Constructor and Description
LazyItemIterator(ItemManager itemMgr, HierarchyManager hierarchyMgr, Iterator<? extends ItemId> itemIds) Creates a new LazyItemIterator instance.
LazyItemIterator(ItemManager itemMgr, Iterator<? extends HierarchyEntry> hierarchyEntryIterator) Creates a new LazyItemIterator instance.

Method Summary

Methods

Modifier and Type	Method and Description
long	getPosition()
long	getSize() Returns the number of Items in this iterator or -1 if the size is unknown.
boolean	hasNext()
Object	next()
javax.jcr.Node	nextNode()
javax.jcr.Property	nextProperty()
javax.jcr.version.Version	nextVersion()
void	remove()
void	skip(long skipNum)

Methods inherited from class java.lang.Object

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

Property Detail

next

Specified by:

nextProperty in interface javax.jcr.PropertyIterator

See Also:

PropertyIterator.nextProperty()

Constructor Detail

LazyItemIterator

public LazyItemIterator(ItemManager itemMgr,
                Iterator<? extends HierarchyEntry> hierarchyEntryIterator)

Creates a new LazyItemIterator instance.

Parameters:

itemMgr - item manager

hierarchyEntryIterator - Iterator over HierarchyEntries

LazyItemIterator

public LazyItemIterator(ItemManager itemMgr,
                HierarchyManager hierarchyMgr,
                Iterator<? extends ItemId> itemIds)
                 throws javax.jcr.ItemNotFoundException,
                        javax.jcr.RepositoryException

Creates a new LazyItemIterator instance.

Parameters:

itemMgr -

hierarchyMgr -

itemIds -

Throws:

javax.jcr.ItemNotFoundException

javax.jcr.RepositoryException

Method Detail

nextNode

public javax.jcr.Node nextNode()

Specified by:

nextNode in interface javax.jcr.NodeIterator

See Also:

NodeIterator.nextNode()

nextProperty

public javax.jcr.Property nextProperty()

Specified by:

nextProperty in interface javax.jcr.PropertyIterator

See Also:

PropertyIterator.nextProperty()

nextVersion

public javax.jcr.version.Version nextVersion()

Specified by:

nextVersion in interface javax.jcr.version.VersionIterator

See Also:

VersionIterator.nextVersion()

getPosition

public long getPosition()

Specified by:

getPosition in interface javax.jcr.RangeIterator

See Also:

RangeIterator.getPosition()

getSize

public long getSize()

Returns the number of Items in this iterator or -1 if the size is unknown.

Note: The number returned by this method may differ from the number of Items actually returned by calls to hasNext() / getNextNode(). This is caused by the lazy instantiation behaviour of this iterator, that may detect only upon iteration that an Item has been invalidated or removed in the mean time. As soon as an invalid Item is detected, the size of this iterator is adjusted.

Specified by:

getSize in interface javax.jcr.RangeIterator

Returns:

the number of Items in this iterator.

See Also:

RangeIterator.getSize()

skip

public void skip(long skipNum)

Specified by:

skip in interface javax.jcr.RangeIterator

See Also:

RangeIterator.skip(long)

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator

See Also:

Iterator.hasNext()

next

public Object next()

Specified by:

next in interface Iterator

See Also:

Iterator.next()

remove

public void remove()

Specified by:

remove in interface Iterator

Throws:

UnsupportedOperationException - always since removal is not implemented.

See Also:

Iterator.remove()