PagingPredicateImpl (Hazelcast Root 4.0-BETA-1 API)

java.lang.Object
- com.hazelcast.query.impl.predicates.PagingPredicateImpl<K,V>

Type Parameters:

K - the entry key type

V - the entry value type

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, IndexAwarePredicate<K,V>, VisitablePredicate, PagingPredicate<K,V>, Predicate<K,V>, Serializable
```
public class PagingPredicateImpl<K,V>
extends Object
implements PagingPredicate<K,V>, IndexAwarePredicate<K,V>, VisitablePredicate, IdentifiedDataSerializable
```
Implementaiton of PagingPredicate.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`PagingPredicateImpl()` Used for serialization internally
`PagingPredicateImpl(Comparator<Map.Entry<K,V>> comparator, int pageSize)` Construct with a comparator and pageSize results will not be filtered results will be ordered via comparator throws `IllegalArgumentException` if pageSize is not greater than 0
`PagingPredicateImpl(int pageSize)` Construct with a pageSize results will not be filtered results will be natural ordered throws `IllegalArgumentException` if pageSize is not greater than 0
`PagingPredicateImpl(Predicate<K,V> predicate, Comparator<Map.Entry<K,V>> comparator, int pageSize)` Construct with an inner predicate, comparator and pageSize results will be filtered via inner predicate results will be ordered via comparator throws `IllegalArgumentException` if pageSize is not greater than 0 throws `IllegalArgumentException` if inner predicate is also a `PagingPredicate`
`PagingPredicateImpl(Predicate predicate, int pageSize)` Construct with an inner predicate and pageSize results will be filtered via inner predicate results will be natural ordered throws `IllegalArgumentException` if pageSize is not greater than 0 throws `IllegalArgumentException` if inner predicate is also a `PagingPredicate`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Predicate`	`accept(Visitor visitor, Indexes indexes)` Accept visitor.
`boolean`	`apply(Map.Entry mapEntry)` Used for delegating filtering to inner predicate.
`Set<QueryableEntry<K,V>>`	`filter(QueryContext queryContext)` Used if inner predicate is instanceof `IndexAwarePredicate` for filtering.
`Map.Entry<K,V>`	`getAnchor()` Retrieve the anchor object which is the last value object on the previous page.
`int`	`getClassId()` Returns type identifier for this class.
`Comparator<Map.Entry<K,V>>`	`getComparator()` Returns the comparator used by this predicate (if any).
`int`	`getFactoryId()` Returns DataSerializableFactory factory ID for this class.
`IterationType`	`getIterationType()`
`Map.Entry<Integer,Map.Entry>`	`getNearestAnchorEntry()`
`int`	`getPage()` Returns the current page value.
`int`	`getPageSize()` Returns the page size.
`Predicate<K,V>`	`getPredicate()`
`boolean`	`isIndexed(QueryContext queryContext)` Used if inner predicate is instanceof `IndexAwarePredicate` for checking if indexed.
`void`	`nextPage()` Sets the page value to next page.
`void`	`previousPage()` Sets the page value to previous page.
`void`	`readData(ObjectDataInput in)` Reads fields from the input stream
`void`	`reset()` Resets for reuse.
`void`	`setAnchor(int page, Map.Entry anchor)` After each query, an anchor entry is set for that page.
`void`	`setIterationType(IterationType iterationType)`
`void`	`setPage(int page)` Sets the current page value.
`void`	`writeData(ObjectDataOutput out)` Writes object fields to output stream

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PagingPredicateImpl
```
public PagingPredicateImpl()
```
    Used for serialization internally
  - PagingPredicateImpl
```
public PagingPredicateImpl(int pageSize)
```
    Construct with a pageSize results will not be filtered results will be natural ordered throws IllegalArgumentException if pageSize is not greater than 0
    
    Parameters:
    
    pageSize - page size
  - PagingPredicateImpl
```
public PagingPredicateImpl(Predicate predicate,
                           int pageSize)
```
    Construct with an inner predicate and pageSize results will be filtered via inner predicate results will be natural ordered throws IllegalArgumentException if pageSize is not greater than 0 throws IllegalArgumentException if inner predicate is also a PagingPredicate
    
    Parameters:
    
    predicate - the inner predicate through which results will be filtered
    
    pageSize - the page size
  - PagingPredicateImpl
```
public PagingPredicateImpl(Comparator<Map.Entry<K,V>> comparator,
                           int pageSize)
```
    Construct with a comparator and pageSize results will not be filtered results will be ordered via comparator throws IllegalArgumentException if pageSize is not greater than 0
    
    Parameters:
    
    comparator - the comparator through which results will be ordered
    
    pageSize - the page size
  - PagingPredicateImpl
```
public PagingPredicateImpl(Predicate<K,V> predicate,
                           Comparator<Map.Entry<K,V>> comparator,
                           int pageSize)
```
    Construct with an inner predicate, comparator and pageSize results will be filtered via inner predicate results will be ordered via comparator throws IllegalArgumentException if pageSize is not greater than 0 throws IllegalArgumentException if inner predicate is also a PagingPredicate
    
    Parameters:
    
    predicate - the inner predicate through which results will be filtered
    
    comparator - the comparator through which results will be ordered
    
    pageSize - the page size
- Method Detail
  - accept
```
public Predicate accept(Visitor visitor,
                        Indexes indexes)
```
    Description copied from interface: VisitablePredicate
    
    Accept visitor. Predicate can either return it's own instance if no modification was done as a result of the visit. In the case there is a change needed then the predicate has to return changed copy of itself. Predicates has to be treated as immutable for optimization purposes.
    
    Specified by:
    
    accept in interface VisitablePredicate
    
    Parameters:
    
    visitor - visitor to accept
    
    indexes - indexes
    
    Returns:
    
    itself or its changed copy
  - filter
```
public Set<QueryableEntry<K,V>> filter(QueryContext queryContext)
```
    Used if inner predicate is instanceof IndexAwarePredicate for filtering.
    
    Specified by:
    
    filter in interface IndexAwarePredicate<K,V>
    
    Parameters:
    
    queryContext -
    
    Returns:
  - isIndexed
```
public boolean isIndexed(QueryContext queryContext)
```
    Used if inner predicate is instanceof IndexAwarePredicate for checking if indexed.
    
    Specified by:
    
    isIndexed in interface IndexAwarePredicate<K,V>
    
    Parameters:
    
    queryContext -
    
    Returns:
  - apply
```
public boolean apply(Map.Entry mapEntry)
```
    Used for delegating filtering to inner predicate.
    
    Specified by:
    
    apply in interface Predicate<K,V>
    
    Parameters:
    
    mapEntry -
    
    Returns:
  - reset
```
public void reset()
```
    Description copied from interface: PagingPredicate
    
    Resets for reuse.
    
    Specified by:
    
    reset in interface PagingPredicate<K,V>
  - nextPage
```
public void nextPage()
```
    Description copied from interface: PagingPredicate
    
    Sets the page value to next page.
    
    Specified by:
    
    nextPage in interface PagingPredicate<K,V>
  - previousPage
```
public void previousPage()
```
    Description copied from interface: PagingPredicate
    
    Sets the page value to previous page.
    
    Specified by:
    
    previousPage in interface PagingPredicate<K,V>
  - getIterationType
```
public IterationType getIterationType()
```
  - setIterationType
```
public void setIterationType(IterationType iterationType)
```
  - getPage
```
public int getPage()
```
    Description copied from interface: PagingPredicate
    
    Returns the current page value.
    
    Specified by:
    
    getPage in interface PagingPredicate<K,V>
    
    Returns:
    
    the current page value.
  - setPage
```
public void setPage(int page)
```
    Description copied from interface: PagingPredicate
    
    Sets the current page value.
    
    Specified by:
    
    setPage in interface PagingPredicate<K,V>
    
    Parameters:
    
    page - the current page value.
  - getPageSize
```
public int getPageSize()
```
    Description copied from interface: PagingPredicate
    
    Returns the page size.
    
    Specified by:
    
    getPageSize in interface PagingPredicate<K,V>
    
    Returns:
    
    the page size
  - getPredicate
```
public Predicate<K,V> getPredicate()
```
  - getComparator
```
public Comparator<Map.Entry<K,V>> getComparator()
```
    Description copied from interface: PagingPredicate
    
    Returns the comparator used by this predicate (if any).
    
    Specified by:
    
    getComparator in interface PagingPredicate<K,V>
    
    Returns:
    
    the comparator or null
  - getAnchor
```
public Map.Entry<K,V> getAnchor()
```
    Description copied from interface: PagingPredicate
    
    Retrieve the anchor object which is the last value object on the previous page.
    Note: This method will return `null` on the first page of the query result or if the predicate was not applied for the previous page number.
    
    Specified by:
    
    getAnchor in interface PagingPredicate<K,V>
    
    Returns:
    
    Map.Entry the anchor object which is the last value object on the previous page
  - setAnchor
```
public void setAnchor(int page,
                      Map.Entry anchor)
```
    After each query, an anchor entry is set for that page. The anchor entry is the last entry of the query.
    
    Parameters:
    
    anchor - the last entry of the query
  - getNearestAnchorEntry
```
public Map.Entry<Integer,Map.Entry> getNearestAnchorEntry()
```
  - writeData
```
public void writeData(ObjectDataOutput out)
               throws IOException
```
    Description copied from interface: DataSerializable
    
    Writes object fields to output stream
    
    Specified by:
    
    writeData in interface DataSerializable
    
    Parameters:
    
    out - output
    
    Throws:
    
    IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.
  - readData
```
public void readData(ObjectDataInput in)
              throws IOException
```
    Description copied from interface: DataSerializable
    
    Reads fields from the input stream
    
    Specified by:
    
    readData in interface DataSerializable
    
    Parameters:
    
    in - input
    
    Throws:
    
    IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.
  - getFactoryId
```
public int getFactoryId()
```
    Description copied from interface: IdentifiedDataSerializable
    
    Returns DataSerializableFactory factory ID for this class.
    
    Specified by:
    
    getFactoryId in interface IdentifiedDataSerializable
    
    Returns:
    
    factory ID
  - getClassId
```
public int getClassId()
```
    Description copied from interface: IdentifiedDataSerializable
    
    Returns type identifier for this class. It should be unique per DataSerializableFactory.
    
    Specified by:
    
    getClassId in interface IdentifiedDataSerializable
    
    Returns:
    
    type ID

Class PagingPredicateImpl<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PagingPredicateImpl

PagingPredicateImpl

PagingPredicateImpl

PagingPredicateImpl

PagingPredicateImpl

Method Detail

accept

filter

isIndexed

apply

reset

nextPage

previousPage

getIterationType

setIterationType

getPage

setPage

getPageSize

getPredicate

getComparator

getAnchor

setAnchor

getNearestAnchorEntry

writeData

readData

getFactoryId

getClassId