Query (myjack-api 0.0.2.RELEASE API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

StandardQuery
```
public interface Query<T extends Serializable>
extends Serializable
```
A query object encapsulate all the information about query data from database. Such as fields,where conditions,order by,limits,and pessimistic lock and so on.

Since:

0.0.1

Author:

mayanjun

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Query<T>`	`addComparator(SqlComparator comparator)` Add a comparator
`Query<T>`	`addComparators(List<SqlComparator> comparators)` Add comparators
`Query<T>`	`addSort(Sort sort)` Add an sort field
`Class<T>`	`getBeanType()` Returns bean type
`List<SqlComparator>`	`getComparators()` Returns comparators
`List<String>`	`getExcludeFields()` Returns the excluded fields
`List<String>`	`getIncludeFields()` Returns the included fields
`int`	`getLimit()` Returns the value of limit
`int[]`	`getLimits()` 0 = offset, 1 = limit
`QueryDeletedMode`	`getQueryDeletedMode()` Returns the query delete mode
`boolean`	`isForUpdate()` Set the optimistic lock
`Query<T>`	`removeComparator(SqlComparator comparator)` Remove a comparator
`Query<T>`	`setBeanType(Class<T> beanType)` Set the bean type for this query
`Query<T>`	`setExcludeFields(List<String> excludeFields)` Set the excluded fields in SQL SELECT clause
`Query<T>`	`setForUpdate(boolean forUpdate)` Return if the optimistic lock is used
`Query<T>`	`setIncludeFields(List<String> includeFields)` Set the included fields in SQL SELECT clause
`Query<T>`	`setLimit(int limit)` Set sql limit
`Query<T>`	`setLimits(int offset, int limit)` Set the limit
`Query<T>`	`setQueryDeletedMode(QueryDeletedMode queryDeletedMode)` Set the query delete mode
`Set<Sort>`	`sorts()` Returns the sort fields

- Method Detail
  - addComparator
```
Query<T> addComparator(SqlComparator comparator)
```
    Add a comparator
    
    Parameters:
    
    comparator - comparator
    
    Returns:
  - removeComparator
```
Query<T> removeComparator(SqlComparator comparator)
```
    Remove a comparator
    
    Parameters:
    
    comparator - comparator
    
    Returns:
  - addComparators
```
Query<T> addComparators(List<SqlComparator> comparators)
```
    Add comparators
    
    Parameters:
    
    comparators - comparators
    
    Returns:
  - getComparators
```
List<SqlComparator> getComparators()
```
    Returns comparators
    
    Returns:
    
    the comparators
  - setLimit
```
Query<T> setLimit(int limit)
```
    Set sql limit
    
    Parameters:
    
    limit - limit
    
    Returns:
  - getLimit
```
int getLimit()
```
    Returns the value of limit
    
    Returns:
    
    the value of limit
  - setLimits
```
Query<T> setLimits(int offset,
                   int limit)
```
    Set the limit
    
    Parameters:
    
    offset - offset
    
    limit - limit number
    
    Returns:
  - getLimits
```
int[] getLimits()
```
    0 = offset, 1 = limit
    
    Returns:
    
    limits array, index 0 is offset and 1 is limit
  - setBeanType
```
Query<T> setBeanType(Class<T> beanType)
```
    Set the bean type for this query
    
    Parameters:
    
    beanType - bean type
    
    Returns:
  - getBeanType
```
Class<T> getBeanType()
```
    Returns bean type
    
    Returns:
  - setExcludeFields
```
Query<T> setExcludeFields(List<String> excludeFields)
```
    Set the excluded fields in SQL SELECT clause
    
    Parameters:
    
    excludeFields -
    
    Returns:
  - getExcludeFields
```
List<String> getExcludeFields()
```
    Returns the excluded fields
    
    Returns:
    
    the excluded fields
  - setIncludeFields
```
Query<T> setIncludeFields(List<String> includeFields)
```
    Set the included fields in SQL SELECT clause
    
    Parameters:
    
    includeFields -
    
    Returns:
  - getIncludeFields
```
List<String> getIncludeFields()
```
    Returns the included fields
    
    Returns:
  - isForUpdate
```
boolean isForUpdate()
```
    Set the optimistic lock
    
    Returns:
  - setForUpdate
```
Query<T> setForUpdate(boolean forUpdate)
```
    Return if the optimistic lock is used
    
    Parameters:
    
    forUpdate - if the FOR UPDATE optimistic lock is used
    
    Returns:
  - getQueryDeletedMode
```
QueryDeletedMode getQueryDeletedMode()
```
    Returns the query delete mode
    
    Returns:
  - setQueryDeletedMode
```
Query<T> setQueryDeletedMode(QueryDeletedMode queryDeletedMode)
```
    Set the query delete mode
    
    Parameters:
    
    queryDeletedMode - queryDeletedMode
    
    Returns:
    
    the query delete mode
  - addSort
```
Query<T> addSort(Sort sort)
```
    Add an sort field
    
    Parameters:
    
    sort -
    
    Returns:
  - sorts
```
Set<Sort> sorts()
```
    Returns the sort fields
    
    Returns:

Interface Query<T extends Serializable>

Method Summary

Method Detail

addComparator

removeComparator

addComparators

getComparators

setLimit

getLimit

setLimits

getLimits

setBeanType

getBeanType

setExcludeFields

getExcludeFields

setIncludeFields

getIncludeFields

isForUpdate

setForUpdate

getQueryDeletedMode

setQueryDeletedMode

addSort

sorts