| Method Summary |
|
| public SqlQueryBuilder | andSub()
Shorthand for
SqlQueryBuilder.enterSub(Operator) with
Operator.AND as the operator. |
| public SqlQueryBuilder | closeSub()
Close a scope. |
| public SqlQueryBuilder | condition(FxAssignment assignment, PropertyValueComparator comparator, FxValue value)
Render a condition for a common FxAssignment query. |
| public SqlQueryBuilder | condition(FxProperty property, PropertyValueComparator comparator, FxValue value)
Render a condition for a common FxProperty query. |
| public SqlQueryBuilder | condition(String propertyName, PropertyValueComparator comparator, FxValue value)
Render a condition for a FxProperty query. |
| public SqlQueryBuilder | condition(String propertyName, PropertyValueComparator comparator, Object value)
Render a condition for a FxProperty query. |
| public SqlQueryBuilder | enterSub(Operator operator)
Create a new subquery scope with the given operator. |
| public SqlQueryBuilder | filterBriefcase(long briefcaseId)
Return only objects of the given briefcase. |
| public SqlQueryBuilder | filterType(String name)
Uses a content type filter for the given content type name. |
| public SqlQueryBuilder | filterType(long typeId)
Uses a content type filter for the given content type. |
| public SqlQueryBuilder | filterVersion(VersionFilter filter)
Filter the result set using the given version filter mode (live, max, auto or all). |
| public SqlQueryBuilder | fulltext(String value)
Performs a fulltext query over all indexed properties against the given text. |
| public List<String> | getColumnNames()
Return the selected column names. |
| public String | getConditions()
Return the conditional ("WHERE") statement(s) contained in this query. |
| public String | getFilters()
Return the filters defined for this query (if any). |
| public ResultLocation | getLocation()
Return the result location used in this query builder. |
| public int | getMaxRows()
|
| public String | getOrderBy()
Return the order by columns defined for this query. |
| public String | getQuery()
Returns the complete query generated by the builder. |
| public FxResultSet | getResult()
Convenience method for executing a search query using this query builder. |
| public int | getStartRow()
|
| public ResultViewType | getViewType()
Return the result view type used in this query builder. |
| public SqlQueryBuilder | isChild(long nodeId)
Limits the (sub-)query to children of the given node. |
| public SqlQueryBuilder | isChild(String path)
Limits the (sub-)query to children of the given node. |
| public SqlQueryBuilder | isDirectChild(long nodeId)
Limits the (sub-)query to the direct children of the given node. |
| public SqlQueryBuilder | isDirectChild(String path)
Limits the (sub-)query to the direct children of the given node. |
| public boolean | isFrozen()
Return true if this query builder is frozen and cannot be further modified.
A query builder freezes when the query or the query conditions are queried
with the
SqlQueryBuilder.getQuery() and
SqlQueryBuilder.getConditions() methods.
A frozen query builder does not guarantee, however, that the query itself is valid.
true if this query builder is frozen and cannot be further modified. |
| public boolean | isIncludeBasicSelects()
Returns true if the predefined columns are selected by the condition. |
| public SqlQueryBuilder | maxRows(int maxRows)
|
| public SqlQueryBuilder | orSub()
Shorthand for
SqlQueryBuilder.enterSub(Operator) with
Operator.OR as the operator. |
| public SqlQueryBuilder | orderBy(String column, SortDirection direction)
Order the results by the given column. |
| public SqlQueryBuilder | orderBy(int columnIndex, SortDirection direction)
Order the results by the given column (1-based). |
| public SqlQueryBuilder | select(String... columns)
Select one or more columns. |
| public SqlQueryBuilder | setIncludeBasicSelects(boolean includeBasicSelects)
Enables or disables the default select columns. |
| public SqlQueryBuilder | startRow(int startRow)
|
| public SqlQueryBuilder | type(String typeName)
Adds a condition that selects only objects of the given type. |
| public SqlQueryBuilder | type(long typeId)
Adds a condition that selects only objects of the given type. |
| public SqlQueryBuilder | viewType(ResultViewType viewType)
|
