org.b3log.latke.repository

Class Query

java.lang.Object

org.b3log.latke.repository.Query

public final class Query
extends Object

Query.

Version:

1.1.0.2, Jan 15, 2019

Author:

Liang Ding

See Also:

Projection, Filter, SortDirection

Constructor Summary

Constructors

Constructor and Description
Query()

Method Summary

Modifier and Type	Method and Description
Query	addSort(String propertyName, SortDirection sortDirection) Adds sort for the specified property with the specified direction.
boolean	equals(Object o)
int	getCurrentPageNum() Gets the current page number.
Filter	getFilter() Gets the filter.
Integer	getPageCount() Gets the page count.
int	getPageSize() Sets the page size.
List<Projection>	getProjections() Get the SELECT projections.
Map<String,SortDirection>	getSorts() Gets the sorts.
int	hashCode()
boolean	isDebug() Checks whether is debug.
Query	select(String propertyName, String... propertyNames) Set SELECT projections.
Query	setCurrentPageNum(int currentPageNum) Sets the current page number with the specified current page number.
Query	setDebug(boolean debug) Sets the debug flag.
Query	setFilter(Filter filter) Sets the filter with the specified filter.
Query	setPage(int currentPageNum, int pageSize) Sets the current page number and page size with the specified current page number and the specified page sieze.
Query	setPageCount(int pageCount) Sets the page count with the specified page count.
Query	setPageSize(int pageSize) Sets the page size with the specified page size.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query()

Method Detail

setPage

public Query setPage(int currentPageNum,
                     int pageSize)

Sets the current page number and page size with the specified current page number and the specified page sieze.

Parameters:

currentPageNum - the specified current page number

pageSize - the specified page size

Returns:

the current query object

isDebug

public boolean isDebug()

Checks whether is debug.

Returns:

true if it is, returns false otherwise

setDebug

public Query setDebug(boolean debug)

Sets the debug flag.

Parameters:

debug - the specified debug flag

Returns:

the current query object

select

public Query select(String propertyName,
                    String... propertyNames)

Set SELECT projections.

Parameters:

propertyName - the specified property name

propertyNames - the specified other property names

Returns:

the current query object

getProjections

public List<Projection> getProjections()

Get the SELECT projections.

Returns:

projections

addSort

public Query addSort(String propertyName,
                     SortDirection sortDirection)

Adds sort for the specified property with the specified direction.

Parameters:

propertyName - the specified property name to sort

sortDirection - the specified sort

Returns:

the current query object

setFilter

public Query setFilter(Filter filter)

Sets the filter with the specified filter.

Parameters:

filter - the specified filter

Returns:

the current query object

getFilter

public Filter getFilter()

Gets the filter.

Returns:

filter

getCurrentPageNum

public int getCurrentPageNum()

Gets the current page number.

Note: The default value of the current page number is @code -1}.

Returns:

current page number

setCurrentPageNum

public Query setCurrentPageNum(int currentPageNum)

Sets the current page number with the specified current page number.

Parameters:

currentPageNum - the specified current page number

Returns:

the current query object

getPageSize

public int getPageSize()

Sets the page size.

Note: The default value of the page size -1.

Returns:

page size

setPageSize

public Query setPageSize(int pageSize)

Sets the page size with the specified page size.

Parameters:

pageSize - the specified page size

Returns:

the current query object

getSorts

public Map<String,SortDirection> getSorts()

Gets the sorts.

Returns:

sorts

getPageCount

public Integer getPageCount()

Gets the page count.

Returns:

page count

setPageCount

public Query setPageCount(int pageCount)

Sets the page count with the specified page count.

Parameters:

pageCount - the specified page count

Returns:

the current query object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object