com.wewebu.ow.server.collections

Class OwAbstractIterable<T>

java.lang.Object

com.wewebu.ow.server.collections.OwIterableAttributeBag<T>

com.wewebu.ow.server.collections.OwAbstractIterable<T>

All Implemented Interfaces:

OwIterable<T>, OwAttributeBag, Iterable<T>

Direct Known Subclasses:

OwCollectionIterable, OwCollectionPageIterable

public abstract class OwAbstractIterable<T>
extends OwIterableAttributeBag<T>

Abstarct implementation of OwIterable.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Since:

4.2.0.0

Field Summary

Fields inherited from class com.wewebu.ow.server.collections.OwIterableAttributeBag

isPage

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OwAbstractIterable(long skipCount, OwAbstractPageFetcher<T> pageFetcher)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract OwAbstractIterator<T>	createIterator() Sublcasses should create a specific iterator to itterate on the entire collection or on sub-collections/pages only.
boolean	getHasMoreItems() Returns whether the repository contains additional items beyond the page of items already fetched.
protected OwAbstractIterator<T>	getIterator()
OwIterable<T>	getPage() Gets an iterable for the current sub collection within the CMIS collection using default maximum number of items
OwIterable<T>	getPage(int maxNumItems) Gets an iterable for the current sub collection within the CMIS collection
protected OwAbstractPageFetcher<T>	getPageFetcher()
long	getPageNumItems() Returns the number of items fetched for the current page.
protected long	getSkipCount()
long	getTotalNumItems() This will return a "guestimation" since parts/pages will be retrieved on request.
OwIterable<T>	skipTo(long position)

Methods inherited from class com.wewebu.ow.server.collections.OwIterableAttributeBag

attributecount, getAttribute, getAttribute, getAttributeNames, getSafeAttribute, hasAttribute

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.wewebu.ow.server.collections.OwIterable

iterator

Constructor Detail

OwAbstractIterable

protected OwAbstractIterable(long skipCount,
                  OwAbstractPageFetcher<T> pageFetcher)

Method Detail

getTotalNumItems

public long getTotalNumItems()

Description copied from interface: OwIterable

This will return a "guestimation" since parts/pages will be retrieved on request.

Returns:

total number of items or (-1) if not known

getIterator

protected OwAbstractIterator<T> getIterator()

getPageFetcher

protected OwAbstractPageFetcher<T> getPageFetcher()

getSkipCount

protected long getSkipCount()

getPageNumItems

public long getPageNumItems()

Description copied from interface: OwIterable

Returns the number of items fetched for the current page.

Returns:

number of items for currently fetched collection

getHasMoreItems

public boolean getHasMoreItems()

Description copied from interface: OwIterable

Returns whether the repository contains additional items beyond the page of items already fetched.

Returns:

true => further page requests will be made to the repository

skipTo

public OwIterable<T> skipTo(long position)

Parameters:

position - This is relative to the start of the whole collection of items. It is not interpreted as relative to the start of a page.

Returns:

iterable whose starting point is the specified skip to position. This iterable may be the same as this.

getPage

public OwIterable<T> getPage()

Description copied from interface: OwIterable

Gets an iterable for the current sub collection within the CMIS collection using default maximum number of items

Returns:

iterable for current page

getPage

public OwIterable<T> getPage(int maxNumItems)

Description copied from interface: OwIterable

Gets an iterable for the current sub collection within the CMIS collection

Parameters:

maxNumItems - maximum number of items the sub collection will contain

Returns:

iterable for current page

createIterator

protected abstract OwAbstractIterator<T> createIterator()

Sublcasses should create a specific iterator to itterate on the entire collection or on sub-collections/pages only.

Returns:

an instance of OwAbstractIterator used to iterate this collection.