Package org.springframework.data.gemfire.search.lucene.support

Class LucenePage<T,K,V>

java.lang.Object

org.springframework.data.gemfire.domain.support.AbstractSliceSupport<T>

org.springframework.data.gemfire.domain.support.AbstractPageSupport<T>

org.springframework.data.gemfire.search.lucene.support.LucenePage<T,K,V>

All Implemented Interfaces:

Iterable<T>, Supplier<Stream<T>>, Page<T>, Slice<T>, Streamable<T>

public class LucenePage<T,K,V>
extends AbstractPageSupport<T>

The LucenePage class is a Spring Data Page implementation supporting Spring Data style paging of PageableLuceneQueryResults complete with Spring Data projections.

Since:

1.1.0

Author:

John Blum

See Also:

• List
• LuceneResultStruct
• PageableLuceneQueryResults
• Page
• AbstractPageSupport
• ProjectingLuceneAccessor

Constructor Summary

Constructors

Constructor	Description
LucenePage(ProjectingLuceneAccessor template, PageableLuceneQueryResults<K,V> queryResults, int pageSize, Class<T> projectionType)	Constructs a new instance of LucenePage initialized with the given Lucene query results, page size and projection type.
LucenePage(ProjectingLuceneAccessor template, PageableLuceneQueryResults<K,V> queryResults, int pageSize, Class<T> projectionType, LucenePage<T,K,V> previous)	Constructs a new instance of LucenePage initialized with the given Lucene query results, page size, projection type and previous page, if one exists.

Method Summary

Modifier and Type	Method	Description
List<T>	getContent()
LucenePage<T,K,V>	getNext()	Null-safe method to return the next page in the collection of pages.
int	getNumber()
protected int	getPageSize()	Returns the number of elements per page.
LucenePage<T,K,V>	getPrevious()	Returns the previous page in the collection of pages.
protected Class<T>	getProjectionType()	Returns the Class type of the projection.
protected PageableLuceneQueryResults<K,V>	getQueryResults()	Returns the Lucene query results backing this LucenePage.
int	getSize()
protected ProjectingLuceneAccessor	getTemplate()	Returns the ProjectingLuceneAccessor used by this LucenePage to perform Lucene data access operations and projections.
long	getTotalElements()
int	getTotalPages()
boolean	hasNext()
boolean	hasPrevious()
<S> Page<S>	map(Function<? super T,? extends S> converter)
protected List<T>	materialize(ProjectingLuceneAccessor template, List<LuceneResultStruct<K,V>> pageOfQueryResults, Class<T> projectionType)	Renders the List of LuceneResultStruct objects into projected values based on the projection type.
static <T, K, V> LucenePage<T,K,V>	newLucenePage(ProjectingLuceneAccessor template, PageableLuceneQueryResults<K,V> queryResults, int pageSize, Class<T> projectionType)	Factory method used to construct a new instance of LucenePage initialized with the given Lucene query results, page size, and projection type.
static <T, K, V> LucenePage<T,K,V>	newLucenePage(ProjectingLuceneAccessor template, PageableLuceneQueryResults<K,V> queryResults, int pageSize, Class<T> projectionType, LucenePage<T,K,V> previousPage)	Factory method used to construct a new instance of LucenePage initialized with the given Lucene query results, page size, projection type and previous page, if one exists.

Methods inherited from class org.springframework.data.gemfire.domain.support.AbstractSliceSupport

getNumberOfElements, getSort, hasContent, isFirst, isLast, iterator, nextPageable, previousPageable

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

getNumberOfElements, getPageable, getSort, hasContent, isFirst, isLast, nextOrLastPageable, nextPageable, previousOrFirstPageable, previousPageable

Methods inherited from interface org.springframework.data.util.Streamable

and, and, and, and, filter, flatMap, get, isEmpty, stream, toList, toSet

Constructor Details

LucenePage

public LucenePage(ProjectingLuceneAccessor template,
 PageableLuceneQueryResults<K,V> queryResults,
 int pageSize,
 Class<T> projectionType)

Constructs a new instance of LucenePage initialized with the given Lucene query results, page size and projection type. The previous page is set to null.

Parameters:

template - ProjectingLuceneAccessor used to perform Lucene queries and data access operations along with projections.

queryResults - PageableLuceneQueryResults wrapped by this LucenePage.

pageSize - number of elements on a LucenePage.

projectionType - Class type of the projection used to view an individual LuceneResultStruct in the Lucene query results.

Throws:

IllegalArgumentException - if ProjectingLuceneAccessor or the PageableLuceneQueryResults are null, or the PageableLuceneQueryResults do not have a next page.

See Also:

• LucenePage(ProjectingLuceneAccessor, PageableLuceneQueryResults, int, Class, LucenePage)

LucenePage

public LucenePage(ProjectingLuceneAccessor template,
 PageableLuceneQueryResults<K,V> queryResults,
 int pageSize,
 Class<T> projectionType,
 LucenePage<T,K,V> previous)

Constructs a new instance of LucenePage initialized with the given Lucene query results, page size, projection type and previous page, if one exists.

Parameters:

template - ProjectingLuceneAccessor used to perform Lucene queries and data access operations along with projections.

queryResults - PageableLuceneQueryResults wrapped by this LucenePage.

pageSize - number of elements on a LucenePage.

projectionType - Class type of the projection used to view an individual LuceneResultStruct in the Lucene query results.

previous - previous page in the chain of pages, if this LucenePage is not the first LucenePage. Can be null.

Throws:

IllegalArgumentException - if ProjectingLuceneAccessor or the PageableLuceneQueryResults are null, or the PageableLuceneQueryResults do not have a next page.

See Also:

• materialize(ProjectingLuceneAccessor, List, Class)

Method Details

newLucenePage

public static <T,
K,
V> LucenePage<T,K,V> newLucenePage(ProjectingLuceneAccessor template,
 PageableLuceneQueryResults<K,V> queryResults,
 int pageSize,
 Class<T> projectionType)

Factory method used to construct a new instance of LucenePage initialized with the given Lucene query results, page size, and projection type. The previous page is set to null.

Parameters:

template - ProjectingLuceneAccessor used to perform Lucene queries and data access operations along with projections.

queryResults - PageableLuceneQueryResults wrapped by this LucenePage.

pageSize - number of elements on a LucenePage.

projectionType - Class type of the projection used to view an individual LuceneResultStruct in the Lucene query results.

Throws:

IllegalArgumentException - if ProjectingLuceneAccessor or the PageableLuceneQueryResults are null, or the PageableLuceneQueryResults do not have a next page.

See Also:

• LucenePage(ProjectingLuceneAccessor, PageableLuceneQueryResults, int, Class)

newLucenePage

public static <T,
K,
V> LucenePage<T,K,V> newLucenePage(ProjectingLuceneAccessor template,
 PageableLuceneQueryResults<K,V> queryResults,
 int pageSize,
 Class<T> projectionType,
 LucenePage<T,K,V> previousPage)

Factory method used to construct a new instance of LucenePage initialized with the given Lucene query results, page size, projection type and previous page, if one exists.

Parameters:

template - ProjectingLuceneAccessor used to perform Lucene queries and data access operations along with projections.

queryResults - PageableLuceneQueryResults wrapped by this LucenePage.

pageSize - number of elements on a LucenePage.

projectionType - Class type of the projection used to view an individual LuceneResultStruct in the Lucene query results.

previousPage - previous page in the chain of pages, if this LucenePage is not the first LucenePage. Can be null.

Throws:

IllegalArgumentException - if ProjectingLuceneAccessor or the PageableLuceneQueryResults are null, or the PageableLuceneQueryResults do not have a next page.

See Also:

• LucenePage(ProjectingLuceneAccessor, PageableLuceneQueryResults, int, Class, LucenePage)

materialize

protected List<T> materialize(ProjectingLuceneAccessor template,
 List<LuceneResultStruct<K,V>> pageOfQueryResults,
 Class<T> projectionType)

Renders the List of LuceneResultStruct objects into projected values based on the projection type.

Parameters:

template - ProjectingLuceneAccessor used to project the desired values from the List of LuceneResultStruct objects.

pageOfQueryResults - Lucene query results captured in the List of LuceneResultStruct objects.

projectionType - Class type to project the LuceneResultStruct objects as.

Returns:

a List of projected values of the given projection type.

See Also:

• LuceneResultStruct

getPageSize

protected int getPageSize()

Returns the number of elements per page.

Returns:

an integer value indicating the number of elements on a page.

getProjectionType

protected Class<T> getProjectionType()

Returns the Class type of the projection.

Returns:

a Class specifying the projection type.

getQueryResults

protected PageableLuceneQueryResults<K,V> getQueryResults()

Returns the Lucene query results backing this LucenePage.

Returns:

a reference to the PageableLuceneQueryResults backing this LucenePage.

See Also:

• LucenePage
• PageableLuceneQueryResults

getTemplate

protected ProjectingLuceneAccessor getTemplate()

Returns the ProjectingLuceneAccessor used by this LucenePage to perform Lucene data access operations and projections.

Returns:

the ProjectingLuceneAccessor used by this LucenePage to perform Lucene data access operations and projections.

See Also:

• ProjectingLuceneAccessor

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Slice<T>

Overrides:

hasNext in class AbstractSliceSupport<T>

hasPrevious

public boolean hasPrevious()

Specified by:

hasPrevious in interface Slice<T>

Overrides:

hasPrevious in class AbstractSliceSupport<T>

getContent

public List<T> getContent()

Specified by:

getContent in interface Slice<T>

Overrides:

getContent in class AbstractSliceSupport<T>

getNext

public LucenePage<T,K,V> getNext()

Null-safe method to return the next page in the collection of pages.

Returns:

the next page in the collection of pages.

Throws:

IllegalStateException - if no more pages exist beyond this page.

See Also:

• LucenePage
• getPrevious()

getNumber

public int getNumber()

Specified by:

getNumber in interface Slice<T>

Overrides:

getNumber in class AbstractSliceSupport<T>

getPrevious

public LucenePage<T,K,V> getPrevious()

Returns the previous page in the collection of pages.

Returns:

the previous page in the collection of pages or null if no LucenePage proceeds this page.

See Also:

• LucenePage
• getNext()

getSize

public int getSize()

Specified by:

getSize in interface Slice<T>

Overrides:

getSize in class AbstractSliceSupport<T>

getTotalElements

public long getTotalElements()

Specified by:

getTotalElements in interface Page<T>

Overrides:

getTotalElements in class AbstractPageSupport<T>

getTotalPages

public int getTotalPages()

Specified by:

getTotalPages in interface Page<T>

Overrides:

getTotalPages in class AbstractPageSupport<T>

map

public <S> Page<S> map(Function<? super T,? extends S> converter)

Specified by:

map in interface Page<T>

Specified by:

map in interface Slice<T>

Specified by:

map in interface Streamable<T>

Overrides:

map in class AbstractPageSupport<T>