net.cnri.repository.search

Class QueryParams

java.lang.Object

net.cnri.repository.search.QueryParams

public class QueryParams
extends java.lang.Object

Parameters to a repository search, such as pagination and sorting.

Field Summary

Fields

Modifier and Type	Field and Description
static QueryParams	DEFAULT Default query parameters.

Constructor Summary

Constructors

Constructor and Description
QueryParams(int pageNumber, int pageSize, java.util.List<SortField> sortFields) Construct a QueryParams.
QueryParams(int pageNumber, int pageSize, java.util.List<SortField> sortFields, java.util.List<java.lang.String> returnedFields) Construct a QueryParams.
QueryParams(int pageNumber, int pageSize, java.util.List<SortField> sortFields, java.util.List<java.lang.String> returnedFields, java.util.Map<java.lang.String,java.lang.String> extras) Construct a QueryParams.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getExtras()
int	getPageOffset()
int	getPageSize()
java.util.List<java.lang.String>	getReturnedFields()
java.util.List<SortField>	getSortFields()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final QueryParams DEFAULT

Default query parameters. Passing null to repository search methods amounts to using this. No pagination and no sorting.

Constructor Detail

QueryParams

public QueryParams(int pageNumber,
           int pageSize,
           java.util.List<SortField> sortFields)

Construct a QueryParams.

Parameters:

pageNumber - the page number to return. Starts at 0. Ignored if pageSize==0.

pageSize - the number of objects to return. PageSize of 0 means return all.

sortFields - fields to sort over. If null means no sort.

QueryParams

public QueryParams(int pageNumber,
           int pageSize,
           java.util.List<SortField> sortFields,
           java.util.List<java.lang.String> returnedFields)

Construct a QueryParams.

Parameters:

pageNumber - the page number to return. Starts at 0. Ignored if pageSize==0.

pageSize - the number of objects to return. PageSize of 0 means return all.

sortFields - fields to sort over. If null means no sort.

returnedFields - fields to include in the query result. This means the DigitalObjects returned by a search will only partially represent the matched objects.

QueryParams

public QueryParams(int pageNumber,
           int pageSize,
           java.util.List<SortField> sortFields,
           java.util.List<java.lang.String> returnedFields,
           java.util.Map<java.lang.String,java.lang.String> extras)

Construct a QueryParams.

Parameters:

pageNumber - the page number to return. Starts at 0. Ignored if pageSize==0.

pageSize - the number of objects to return. PageSize of 0 means return all.

sortFields - fields to sort over. If null means no sort.

returnedFields - fields to include in the query result. This means the DigitalObjects returned by a search will only partially represent the matched objects.

extras - extra parameters to include in the query. The repository implementation is responsible for interpreting the parameters.

Method Detail

getPageOffset

public int getPageOffset()

getPageSize

public int getPageSize()

getSortFields

public java.util.List<SortField> getSortFields()

getReturnedFields

public java.util.List<java.lang.String> getReturnedFields()

getExtras

public java.util.Map<java.lang.String,java.lang.String> getExtras()