Query
Definição da configuração do objeto Query para consultas simplificadas.
all
all() : java.util.List
Description
Returns all records resulting from query execution, if none, returns an empty list.
Return
( java.util.List )
List of records.
debug
debug(enabled: boolean) : Query
Description
Defines whether debug is active or not in the query.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| enabled | boolean | Whether the debug is active or not. |
Return
( Query )
Current Query object.
distinct
distinct(enabled: boolean) : Query
Description
Defines whether the DISTINCT command will be applied to the query.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| enabled | boolean | Whether it will be applied or not. |
Return
( Query )
Current Query object.
fields
fields(fields: [Lorg.netuno.tritao.query.Field;[]) : Query
Description
Defines the fields that will be obtained in the query
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fields | [Lorg.netuno.tritao.query.Field;[] | The fields that will be obtained in the query. |
Return
( Query )
Current Query object.
first
first() : Values
Description
Returns the first record resulting from the query execution, if none, returns null.
Return
( Values )
First record of the result.
getFields
getFields() : java.util.List
Description
Returns the fields that will be obtained in the query
Return
( java.util.List )
The fields that will be obtained in the query
getGroup
getGroup() : Group
Description
Returns the query grouping object.
Return
( Group )
The query grouping object.
getJoin
getJoin() : Config | Exec | Header | Req | Res | Values | DataSchema
Description
Returns the Join objects (related tables) referring to the main table of the query.
Return
( Config | Exec | Header | Req | Res | Values | DataSchema )
The Join objects (related tables) referring to the main table of the query.
getOrder
getOrder() : Order
Description
Returns the query ordering object.
Return
( Order )
The query ordering object.
getPagination
getPagination() : org.netuno.tritao.query.pagination.Pagination
Description
Returns the pagination configuration object (if any) of the query.
Return
( org.netuno.tritao.query.pagination.Pagination )
The pagination configuration object (if any) of the query.
getTableName
getTableName() : string
Description
Returns the name of the query's main table.
Return
( string )
The name of the query's main table.
getTablesToPopulate
getTablesToPopulate() : java.util.List
Return
( java.util.List )
getWhere
getWhere() : Where
Description
Returns the Where object referring to the main table of the query.
Return
( Where )
Where object of the query's main table.
group
group(order: string) : Query
Description
Defines the query grouping object.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| order | string | The query grouping object. |
Return
( Query )
Current Query object.
isDebug
isDebug() : boolean
Description
Returns whether debug is active or not in the query.
Return
( boolean )
Whether debug is active or not in the query.
isDistinct
isDistinct() : boolean
Description
Returns whether the DISTINCT command will be applied to the query.
Return
( boolean )
Whether it will be applied or not.
join
join(relation: Relation) : Query
Description
Defines an INNER JOIN relationship with a table.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| relation | Relation | INNER JOIN type relationship. |
Return
( Query )
Current Query object.
leftJoin
leftJoin(relation: Relation) : Query
Description
Defines an LEFT JOIN relationship with a table.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| relation | Relation | LEFT JOIN type relationship. |
Return
( Query )
Current Query object.
link
link(formLink: string) : Query
Description
Defines a form to be related to the main table of the query using the Link criteria.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| formLink | string | Form to be related. |
Return
( Query )
Current Query object.
link(formLink: string, link: Link) : Query
Description
Defines a form to be related to the main table of the query using the Link criteria.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| formLink | string | Form to be related. |
| link | Link | Link object with a subrelation. |
Return
( Query )
Current Query object.
link(formLink: string, where: Where) : Query
Description
Defines a form to be related to the main table of the query using the Link criteria.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| formLink | string | Form to be related. |
| where | Where | Where object with the conditions referring to the form you want to relate. |
Return
( Query )
Current Query object.
link(formLink: string, where: Where, link: Link) : Query
Description
Defines a form to be related to the main table of the query using the Link criteria.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| formLink | string | Form to be related. |
| where | Where | Where object with the conditions referring to the form you want to relate. |
| link | Link | Link object with a subrelation. |
Return
( Query )
Current Query object.
order
order(column: string, order: string) : Query
Description
Defines the ordering of the query.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| column | string | Column for sorting. |
| order | string | Meaning of ordering. |
Return
( Query )
Current Query object.
page
page(pagination: org.netuno.tritao.query.pagination.Pagination) : Values
Description
Returns Page with the items resulting from executing the query in a paged form and other pagination data.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| pagination | org.netuno.tritao.query.pagination.Pagination | Pagination object with pagination settings. |
Return
( Values )
Page with items and other pagination data.
populate
populate(table: string, filter: Field) : Query
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| table | string | |
| filter | Field |
Return
( Query )
populate(table: string, filter: Field, fields: java.util.List) : Query
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| table | string | |
| filter | Field | |
| fields | java.util.List |
Return
( Query )
rightJoin
rightJoin(relation: Relation) : Query
Description
Defines an RIGHT JOIN relationship with a table.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| relation | Relation | RIGHT JOIN type relationship. |
Return
( Query )
Current Query object.
setDebug
setDebug(enabled: boolean) : Query
Description
Defines whether debug is active or not in the query.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| enabled | boolean | Whether the debug is active or not. |
Return
( Query )
Current Query object.
setDistinct
setDistinct(enabled: boolean) : Query
Description
Defines whether the DISTINCT command will be applied to the query.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| enabled | boolean | Whether it will be applied or not. |
Return
( Query )
Current Query object.
setFields
setFields(fields: java.util.List) : Query
Description
Defines the fields that will be obtained in the query
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fields | java.util.List | The fields that will be obtained in the query. |
Return
( Query )
Current Query object.
setGroup
setGroup(order: Group) : Query
Description
Defines the query grouping object.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| order | Group | The query grouping object. |
Return
( Query )
Current Query object.
setJoin
setJoin(join: Config | Exec | Header | Req | Res | Values | DataSchema) : Query
Description
Defines the Join objects (related tables) referring to the main table of the query.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| join | Config | Exec | Header | Req | Res | Values | DataSchema | The Join objects (related tables) referring to the main table of the query. |
Return
( Query )
Current Query object.
setOrder
setOrder(order: Order) : Query
Description
Defines the query ordering object.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| order | Order | The query ordering object. |
Return
( Query )
Current Query object.
setPagination
setPagination(pagination: org.netuno.tritao.query.pagination.Pagination) : Query
Description
Defines the pagination configuration object (if any) of the query.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| pagination | org.netuno.tritao.query.pagination.Pagination | the pagination configuration object of the query. |
Return
( Query )
Current Query object.
setTableName
setTableName(tableName: string) : Query
Description
Defines the name of the query's main table.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| tableName | string | The name of the query's main table. |
Return
( Query )
Current Query object.
setTablesToPopulate
setTablesToPopulate(tablesToPopulate: java.util.List) : Query
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| tablesToPopulate | java.util.List |
Return
( Query )
setWhere
setWhere(where: Where) : Query
Description
Defines the Where object referring to the main table of the query.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| where | Where | Where object of the query's main table. |
Return
( Query )
Current Query object.