|
void | setFilter ([in] string filter) raises (com::sun::star::sdbc::SQLException) |
| makes it possible to set a filter condition for the query. More...
|
|
void | setStructuredFilter ([in] sequence< sequence< com::sun::star::beans::PropertyValue > > filter) raises (com::sun::star::sdbc::SQLException,com::sun::star::lang::IllegalArgumentException) |
| appends a new set of filter criteria which is split into levels. More...
|
|
void | appendFilterByColumn ([in] com::sun::star::beans::XPropertySet column, [in] boolean andCriteria, [in] long filterOperator) raises (com::sun::star::sdbc::SQLException, com::sun::star::lang::WrappedTargetException) |
| appends a new filter condition by a com::sun::star::sdb::DataColumn providing the name and the value for the filter. More...
|
|
void | setGroup ([in] string group) raises (com::sun::star::sdbc::SQLException) |
| makes it possible to set a group for the query. More...
|
|
void | appendGroupByColumn ([in] com::sun::star::beans::XPropertySet column) raises (com::sun::star::sdbc::SQLException) |
| appends an additional part to the group criteria of the select statement. More...
|
|
void | setHavingClause ([in] string filter) raises (com::sun::star::sdbc::SQLException) |
| makes it possible to set a HAVING filter condition for the query. More...
|
|
void | setStructuredHavingClause ([in] sequence< sequence< com::sun::star::beans::PropertyValue > > filter) raises (com::sun::star::sdbc::SQLException) |
| appends a new set of HAVING filter criteria which is split into levels. More...
|
|
void | appendHavingClauseByColumn ([in] com::sun::star::beans::XPropertySet column, [in] boolean andCriteria, [in] long filterOperator) raises (com::sun::star::sdbc::SQLException, com::sun::star::lang::WrappedTargetException) |
| appends a new HAVING filter condition by a com::sun::star::sdb::DataColumn providing the name and the value for the filter. More...
|
|
void | setOrder ([in] string order) raises (com::sun::star::sdbc::SQLException) |
| makes it possible to set a sort condition for the query. More...
|
|
void | appendOrderByColumn ([in] com::sun::star::beans::XPropertySet column, [in] boolean ascending) raises (com::sun::star::sdbc::SQLException) |
| appends an additional part to the sort order criteria of the select statement. More...
|
|
string | getQuery () |
| returns the query. More...
|
|
void | setQuery ([in] string command) raises (com::sun::star::sdbc::SQLException) |
| sets a new query for the composer, which may be expanded by filters, group by, having and sort criteria. More...
|
|
string | getFilter () |
| returns the used filter. More...
|
|
sequence< sequence< com::sun::star::beans::PropertyValue > > | getStructuredFilter () |
| returns the currently used filter. More...
|
|
string | getGroup () |
| returns the currently used GROUP BY. More...
|
|
com::sun::star::container::XIndexAccess | getGroupColumns () |
| returns the currently used group. More...
|
|
string | getHavingClause () |
| returns the used HAVING filter. More...
|
|
sequence< sequence< com::sun::star::beans::PropertyValue > > | getStructuredHavingClause () |
| returns the currently used HAVING filter. More...
|
|
string | getOrder () |
| returns the currently used sort order. More...
|
|
com::sun::star::container::XIndexAccess | getOrderColumns () |
| returns the currently used sort order. More...
|
|
string | getQueryWithSubstitution () raises (com::sun::star::sdbc::SQLException) |
| returns the query previously set at the analyzer, with all application-level features being substituted by their database-level counterparts. More...
|
|
void | setCommand ([in] string Command, [in] long CommandType) raises (com::sun::star::sdbc::SQLException) |
| sets a new query for the composer, which may be expanded by filters, group by, having and sort criteria. More...
|
|
any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More...
|
|
void | acquire () |
| increases the reference counter by one. More...
|
|
void | release () |
| decreases the reference counter by one. More...
|
|
simplifies the composing of single select statements.
The interface can be used for composing single SELECT statements without knowing the structure of the used query.
- See also
- com::sun::star::sdb::SingleSelectQueryComposer
sets a new elementary query for the composer
An elementary query or statement is a (single select) statement whose parts are not covered by the various set and get methods of the composer. That is, if the elementary statement contains a filter clause, a call to XSingleSelectQueryAnalyzer::getFilter() will not return you this filter. Instead, only filters which have been set using for instance setFilter() are covered by the get methods.
The only methods which take all parts of the elementary statement into account are XSingleSelectQueryAnalyzer::getQuery() and XSingleSelectQueryAnalyzer::getQueryWithSubstitution(), which always returns the complete composed query.
As a result, you can use the composer to build cumulative filter expressions. That is, you can set ElementaryQuery to a statement already containing filters, and then use setFilter() to append additional filters.
The very same holds for sort orders, HAVING
and GROUP BY
clauses.
There are various use cases for this. For instance, you might want to use the statement represented by a QueryDefinition, and extend it with additional filters or sort orders, while not touching the respective parts already present in QueryDefinition::Command. This can be achieved by setting the QueryDefinition::Command as ElementaryQuery of a SingleSelectQueryComposer.
If, in such a scenario, you would be interested in the filter part of the QueryDefinition::Command, you would set it via XSingleSelectQueryAnalyzer::setQuery(), and retrieve the filter part via XSingleSelectQueryAnalyzer::getFilter().
If you'd be interested in the composed filter, you would set the QueryDefinition::Command as ElementaryQuery, add your filter, and propagate the resulting query (XSingleSelectQueryAnalyzer::getQuery()) to an SingleSelectQueryAnalyzer instance via XSingleSelectQueryAnalyzer::setQuery().