LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | List of all members
SingleSelectQueryAnalyzer Service Reference

represents a service for analyzing a single select statement. More...

import"SingleSelectQueryAnalyzer.idl";

Inheritance diagram for SingleSelectQueryAnalyzer:
XSingleSelectQueryAnalyzer XTablesSupplier XColumnsSupplier XParametersSupplier XInterface XInterface XInterface XInterface SingleSelectQueryComposer

Exported Interfaces

interface XSingleSelectQueryAnalyzer
 
interface com::sun::star::sdbcx::XTablesSupplier
 access to the selected tables. More...
 
interface com::sun::star::sdbcx::XColumnsSupplier
 access the selected columns. More...
 
interface com::sun::star::sdb::XParametersSupplier
 access to the parameters which are used in the where clause. More...
 

Additional Inherited Members

- Public Member Functions inherited from XSingleSelectQueryAnalyzer
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...
 
- Public Member Functions inherited from XInterface
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...
 
- Public Member Functions inherited from XTablesSupplier
com::sun::star::container::XNameAccess getTables ()
 returns the container of tables. More...
 
- Public Member Functions inherited from XColumnsSupplier
com::sun::star::container::XNameAccess getColumns ()
 returns the container of columns. More...
 
- Protected Member Functions inherited from XParametersSupplier
com::sun::star::container::XIndexAccess getParameters ()
 returns the container of parameters. More...
 

Detailed Description

represents a service for analyzing a single select statement.

It hides the complexity of parsing and evaluating a single select statement and provides sophisticated methods for accessing a statements filter, group by, having and order criteria, as well as the corresponding select columns and tables. If supported, it even gives access to the parameters.

See also
com::sun::star::sdb::SingleSelectQueryComposer

Exported Interfaces

access to the parameters which are used in the where clause.

access the selected columns.

access to the selected tables.

The selected tables are those present in the FROM part of a SELECT statement.

Note that OpenOffice.org since version 2.0.4 also supports queries which are based on other queries. For example, given that you have a database containing a query named All Orders, the SQL statement SELECT * FROM "All Orders" is perfectly valid when used with a SingleSelectQueryAnalyzer.

In this case, the name container returned by com::sun::star::sdbcx::XTablesSupplier::getTables() will in fact not return a Table, but a Query object. Semantically, however, this object still acts as a table in the SQL statement.

See also
XSingleSelectQueryAnalyzer::getQueryWithSubstitution

The documentation for this service was generated from the following file: