org.springframework.data.solr.core.query

Class SolrPageRequest

java.lang.Object

org.springframework.data.solr.core.query.SolrPageRequest

All Implemented Interfaces:

Pageable

public class SolrPageRequest
extends Object
implements Pageable

Solr specific implementation of Pageable allowing zero sized pages.

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor and Description
SolrPageRequest(int page, int size) Creates a new SolrPageRequest.
SolrPageRequest(int page, int size, Sort.Direction direction, String... properties) Creates a new SolrPageRequest with sort parameters applied.
SolrPageRequest(int page, int size, Sort sort) Creates a new SolrPageRequest with sort parameters applied.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Pageable	first()
long	getOffset()
int	getPageNumber()
int	getPageSize()
Sort	getSort()
int	hashCode()
boolean	hasPrevious()
Pageable	next()
Pageable	previous() Returns the Pageable requesting the previous Page.
Pageable	previousOrFirst()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.data.domain.Pageable

getSortOr, isPaged, isUnpaged, toOptional, unpaged

Constructor Detail

SolrPageRequest

public SolrPageRequest(int page,
                       int size)

Creates a new SolrPageRequest. Pages are zero indexed.

Parameters:

page - zero-based page index.

size - the size of the page to be returned.

SolrPageRequest

public SolrPageRequest(int page,
                       int size,
                       Sort.Direction direction,
                       String... properties)

Creates a new SolrPageRequest with sort parameters applied.

Parameters:

page - zero-based page index.

size - the size of the page to be returned.

direction - the direction of the Sort to be specified, can be null.

properties - the properties to sort by, must not be null or empty.

SolrPageRequest

public SolrPageRequest(int page,
                       int size,
                       @Nullable
                       Sort sort)

Creates a new SolrPageRequest with sort parameters applied.

Parameters:

page - zero-based page index.

size - the size of the page to be returned.

sort - can be null.

Method Detail

getPageNumber

public int getPageNumber()

Specified by:

getPageNumber in interface Pageable

getPageSize

public int getPageSize()

Specified by:

getPageSize in interface Pageable

getOffset

public long getOffset()

Specified by:

getOffset in interface Pageable

getSort

public Sort getSort()

Specified by:

getSort in interface Pageable

next

public Pageable next()

Specified by:

next in interface Pageable

previousOrFirst

public Pageable previousOrFirst()

Specified by:

previousOrFirst in interface Pageable

first

public Pageable first()

Specified by:

first in interface Pageable

hasPrevious

public boolean hasPrevious()

Specified by:

hasPrevious in interface Pageable

previous

public Pageable previous()

Returns the Pageable requesting the previous Page.

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object