StandardQuery (myjack-api 0.0.2.RELEASE API)

java.lang.Object
- org.mayanjun.myjack.api.query.StandardQuery<T>

All Implemented Interfaces:

Serializable, Query<T>
```
public class StandardQuery<T extends PersistableEntity>
extends Object
implements Query<T>
```
Represents a query

Since:

0.0.1

Author:

mayanjun

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StandardQuery()

Constructors
Constructor and Description
`StandardQuery()`

Method Summary

All Methods Instance Methods Concrete 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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Class StandardQuery<T extends PersistableEntity>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StandardQuery

Method Detail

addComparator

removeComparator

addComparators

getComparators

setLimit

getLimit

setLimits

getLimits

setBeanType

getBeanType

setExcludeFields

getExcludeFields

setIncludeFields

getIncludeFields

isForUpdate

setForUpdate

getQueryDeletedMode

setQueryDeletedMode

addSort

sorts