com.wewebu.ow.server.collections

Class OwFilteringIterable<T>

java.lang.Object

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

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

All Implemented Interfaces:

OwIterable<T>, OwAttributeBag, Iterable<T>

public class OwFilteringIterable<T>
extends OwIterableAttributeBag<T>

An OwIterable implementation that accepts a filtering criteria.

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

Constructor and Description
OwFilteringIterable(OwIterable<T> iterable, OwItemFilter<T> filter)
OwFilteringIterable(OwIterable<T> iterable, OwItemFilter<T> filter, long pageSize)
OwFilteringIterable(OwIterable<T> iterable, OwItemFilter<T> filter, long pageSize, boolean exactCalculation)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getHasMoreItems() Returns whether the repository contains additional items beyond the page of items already fetched.
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
long	getPageNumItems() Returns the number of items fetched for the current page.
long	getTotalNumItems() This will return a "guestimation" since parts/pages will be retrieved on request.
boolean	isExcatCalculation() Is calculation enabled for getTotalNumItems()
Iterator<T>	iterator()
void	setExactCalculation(boolean calculation) Define if filter should be accessed for total count calculation.
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

Constructor Detail

OwFilteringIterable

public OwFilteringIterable(OwIterable<T> iterable,
                   OwItemFilter<T> filter)

OwFilteringIterable

public OwFilteringIterable(OwIterable<T> iterable,
                   OwItemFilter<T> filter,
                   long pageSize)

OwFilteringIterable

public OwFilteringIterable(OwIterable<T> iterable,
                   OwItemFilter<T> filter,
                   long pageSize,
                   boolean exactCalculation)

Method Detail

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

iterator

public Iterator<T> iterator()

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

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

setExactCalculation

public void setExactCalculation(boolean calculation)

Define if filter should be accessed for total count calculation.

Parameters:

calculation - boolean

See Also:

getTotalNumItems()

isExcatCalculation

public boolean isExcatCalculation()

Is calculation enabled for getTotalNumItems()

Returns:

boolean (by default false)

See Also:

setExactCalculation(boolean)