:: com :: sun :: star :: sdb ::

unpublished interface XSingleSelectQueryAnalyzer
Description
simplifies the analyzing of single select statements.

The interface can be used for analyzing single SELECT statements without knowing the structure of the used query.


Methods' Summary
getQuery returns the query.  
setQuery sets a new query for the composer, which may be expanded by filters, group by, having and sort criteria.  
getFilter returns the used filter.  
getStructuredFilter returns the currently used filter.  
getGroup returns the currently used GROUP BY.  
getGroupColumns returns the currently used group.  
getHavingClause returns the used HAVING filter.  
getStructuredHavingClause returns the currently used HAVING filter.  
getOrder returns the currently used sort order.  
getOrderColumns returns the currently used sort order.  
Methods' Details
getQuery
string
getQuery();

Description
returns the query.
Returns
the query
setQuery
void
setQuery( [in] string  command )
raises( ::com::sun::star::sdbc::SQLException );

Description
sets a new query for the composer, which may be expanded by filters, group by, having and sort criteria.
Parameter command
the single select statement to set
Throws
com::sun::star::sdbc::SQLException if a database access error occurs or the statement isn't a single select statement or the statement isn't valid or the statement can not be parsed.
getFilter
string
getFilter();

Description
returns the used filter.

The filter criteria returned is part of the where condition of the select command, but it does not contain the where token.

Returns
the filter
getStructuredFilter
sequence< sequence< ::com::sun::star::beans::PropertyValue > >
getStructuredFilter();

Description
returns the currently used filter.

The filter criteria is split into levels. Each level represents the OR criterias. Within each level, the filters are provided as an AND criteria with the name of the column and the filter condition. The filter condition is of type string. The operator used, is defined by ::com::sun::star::sdb::SQLFilterOperator .

Returns
the structured filter
getGroup
string
getGroup();

Description
returns the currently used GROUP BY.

The group criteria returned is part of the GROUP BY clause of the select command, but it does not contain the GROUP BY keyword .

Returns
the group
getGroupColumns
::com::sun::star::container::XIndexAccess
getGroupColumns();

Description
returns the currently used group.

The columns returned form the GROUP BY clause.

Returns
a collection of com::sun::star::sdb::GroupColumn which form the GROUP BY.
getHavingClause
string
getHavingClause();

Description
returns the used HAVING filter.

The HAVING filter criteria returned is part of the HAVING condition of the select command, but it does not contain the HAVING token.

Returns
the filter
getStructuredHavingClause
sequence< sequence< ::com::sun::star::beans::PropertyValue > >
getStructuredHavingClause();

Description
returns the currently used HAVING filter.

The HAVING filter criteria is split into levels. Each level represents the OR criterias. Within each level, the filters are provided as an AND criteria with the name of the column and the filter condition. The filter condition is of type string. The operator used, is defined by ::com::sun::star::sdb::SQLFilterOperator .

Returns
the structured HAVING filter
getOrder
string
getOrder();

Description
returns the currently used sort order.

The order criteria returned is part of the ORDER BY clause of the select command, but it does not contain the ORDER BY keyword .

Returns
the order
getOrderColumns
::com::sun::star::container::XIndexAccess
getOrderColumns();

Description
returns the currently used sort order.

The order criteria returned is part of the ORDER BY clause of the select command, but it does not contain the ORDER BY keyword .

Returns
a collection of ::com::sun::star::sdb::OrderColumn which form the ORDER BY.
Top of Page