View source for Documentation/DevGuide/Database/Runtime Settings For Predefined Queries

{{Documentation/DevGuide/DatabaseTOC
|Database2b=block|DatabaseSources=block|DatabaseQueries=block
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Database/Adding and Editing Predefined Queries
|NextPage=Documentation/DevGuide/Database/The SingleSelectQueryComposer
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Database/{{SUBPAGENAME}}}} 
 {{DISPLAYTITLE:Runtime Settings For Predefined Queries}}
The queries in the user interface have a number of advanced settings concerning the formatting and filtering of the query and its columns. For the API, these settings are available as long as the data source is connected with the underlying database. The section [[Documentation/DevGuide/Database/Connecting Through a DataSource|Connecting Through a DataSource]] discusses how to get a connection from a data source. When the connection is made, its interface <idl>com.sun.star.sdb.XQueriesSupplier</idl> returns query objects with the advanced settings above.

[[Image:Connection.png|none|thumb|400px|Connection, QueryComposer And Query in the sdb Module]]

The <code>Connection</code> gives you a <idl>com.sun.star.sdbcx.Container</idl> of <idl>com.sun.star.sdb.Query</idl> services. These <code>Query</code> objects are different from <code>QueryDefinitions</code>.

The <idl>com.sun.star.sdb.Query</idl> service inherits both the properties from <idl>com.sun.star.sdb.QueryDefinition</idl> service described previously, and the properties defined in the service <idl>com.sun.star.sdb.DataSettings</idl>. Use <code>DataSettings</code> to customize the appearance of the query when used in the {{AOo}} API GUI or together with a <idl>com.sun.star.sdb.RowSet</idl>.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
!colspan="2"|Properties of <idl>com.sun.star.sdb.DataSettings</idl> 
|-
|<idlm>com.sun.star.sdb.DataSettings:Filter</idlm> 
|<code>string</code> - An additional filter for the data object, WHERE clause syntax. 
|-
|<idlm>com.sun.star.sdb.DataSettings:ApplyFilter</idlm> 
|<code>boolean</code> - Indicates if the filter should be applied, default is FALSE. 
|-
|<idlm>com.sun.star.sdb.DataSettings:Order</idlm> 
|<code>string</code> - Is an additional sort order definition. 
|-
|<idlm>com.sun.star.sdb.DataSettings:FontDescriptor</idlm> 
|<code>struct</code> <idl>com.sun.star.awt.FontDescriptor</idl>. Specifies the font attributes for displayed data. 
|-
|<idlm>com.sun.star.sdb.DataSettings:RowHeight</idlm> 
|<code>long</code> - Specifies the height of a data row. 
|-
|<idlm>com.sun.star.sdb.DataSettings:TextColor</idlm> 
|<code>long</code> - Specifies the text color for displayed text in 0xAARRGGBB notation 
|}

In addition to these properties, the <idl>com.sun.star.sdb.Query</idl> service offers a <idl>com.sun.star.sdbcx.XDataDescriptorFactory</idl> to create new query descriptors based on the current query information. Use this query descriptor to append new queries to the <idl>com.sun.star.sdbcx.Container</idl> using its <idl>com.sun.star.sdbcx.XAppend</idl> interface. This is an alternative to the connection-independent method to create new queries as discussed above. The section [[Documentation/DevGuide/Database/The Descriptor Pattern|The Descriptor Pattern]] explains how to use descriptors to append new elements to database objects.

The <idl>com.sun.star.sdbcx.XRename</idl> interface is used to rename a query. It has one method:
<syntaxhighlight lang="idl">
  void rename( [in] string newName)
</syntaxhighlight>
The interface <idl>com.sun.star.sdbcx.XColumnsSupplier</idl> grants access to the column settings of the query through its single method <code>getColumns()</code>:
<syntaxhighlight lang="idl">
  com::sun::star::container::XNameAccess getColumns()
</syntaxhighlight>
The columns returned by <code>getColumns()</code> are <idl>com.sun.star.sdb.Column</idl> services that provide column information and the ability to improve the appearance of columns. This service is explained in the section [[Documentation/DevGuide/Database/Tables and Columns|Tables and Columns]].

The following code sample connects to Bibliography, and prints the column names and types of the previously defined query Query1. 
<!--[SOURCE:Database/CodeSamples.java]-->
<syntaxhighlight lang="java">
  public static void printQueryColumnNames(XMultiServiceFactory _rMSF) throws com.sun.star.uno.Exception {
      XNameAccess xNameAccess = (XNameAccess)UnoRuntime.queryInterface(
          XNameAccess.class,_rMSF.createInstance("com.sun.star.sdb.DatabaseContext"));
      
      // we use Bibliography
      XDataSource xDS = (XDataSource)UnoRuntime.queryInterface(
          XDataSource.class, xNameAccess.getByName("Bibliography"));
      
      // simple way to connect
      XConnection con = xDS.getConnection("", "");
      
      // we need the XQueriesSupplier interface of the connection
      XQueriesSupplier xQuerySup = (XQueriesSupplier)UnoRuntime.queryInterface(
          XQueriesSupplier.class, con);
      
      // get container with com.sun.star.sdb.Query services
      XNameAccess xQDefs = xQuerySup.getQueries();
      
      // retrieve XColumnsSupplier of Query1
      XColumnsSupplier xColsSup = (XColumnsSupplier) UnoRuntime.queryInterface(
          XColumnsSupplier.class,xQDefs.getByName("Query1"));
      
      XNameAccess xCols = xColsSup.getColumns();
      
      // Access column property TypeName
      String aNames [] = xCols.getElementNames();
      for (int i=0;i<aNames.length;++i) {
          Object col = xCols.getByName(aNames[i]);
          XPropertySet xColumnProps = (XPropertySet)UnoRuntime.queryInterface(
              XPropertySet.class, col);
          System.out.println(aNames[i] + " " + xColumnProps.getPropertyValue("TypeName"));
      }
  }
</syntaxhighlight>
{{PDL1}}

[[Category:Documentation/Developer's Guide/Database Access]]