Filtering and Sorting

From OpenOffice.org Wiki

OpenOffice.org Developer's Guide

Forms

• Models and Views

• The Model-View Paradigm
• Models and Views for Form Controls
• Model-View Interaction
• Form Layer Views

• Form Elements in the Document Model

• A Hierarchy of Models

• FormComponent Service
• FormComponents Service
• Logical Forms
• Forms Container
• Form Control Models

• Control Models and Shapes

• Form Components

• Control Models
• Forms
• HTML Forms

• Data Awareness

• Forms

• Forms as Row Sets
• Loadable Forms
• Sub Forms
• Filtering and Sorting
• Parameters

• Data Aware Controls

• Control Models as Bound Components
• Committing Controls

• External Value Suppliers

• Value Bindings

• Form Controls accepting Value Bindings

• External List Sources

• Validation

• Validation in OpenOffice.org
• Validation and Bindings

• Scripting and Events
• Common Tasks

• Initializing Bound Controls
• Automatic Key Generation
• Data Validation
• Programmatic Assignment of Scripts to Events

< Previous Part

Next Part >

Forms support quick and easy filtering and sorting like the underlying row sets. For this, the properties com.sun.star.sdb.RowSet:Filter, com.sun.star.sdb.RowSet:ApplyFilter and com.sun.star.sdb.RowSet:Order area used.

// set this as filter on the form
  String sCompleteFilter = "";
  if ((null != sOdbcDate) && (0 != sOdbcDate.length())) {
      sCompleteFilter = "SALEDATE >= ";
      sCompleteFilter += sOdbcDate;
  }
  m_xSalesForm.setPropertyValue("Filter", sCompleteFilter);
  m_xSalesForm.setPropertyValue("ApplyFilter", new Boolean(true));
 
  // and reload the form
  XLoadable xLoad = (XLoadable)UnoRuntime.queryInterface(XLoadable.class, m_xSalesForm);
  xLoad.reload();

In this fragment, a filter string is built first. The "SALEDATE >= {D '2002-12-02'}" is an example for a filter string. In general, everything that appears after the WHERE clause of an SQL statement is set as a Filter property value. The same holds true for the Order property value and an ORDER BY clause.

The notation for the date in braces: This is the standard ODBC notation for date values, and it is the safest method to supply OpenOffice.org with date values. It also works if you are using non-ODBC data sources, as long as you do not switch on the Native SQL option. Refer to com.sun.star.sdbc.Statement:EscapeProcessing. OpenOffice.org understands and sometimes returns other notations, for instance, in the user interface where that makes sense, but these are locale-dependent, which means you have to know the current locale if you use them.

Then the ApplyFilter property is set to true. This is for safety, because the value of this property is unknown when creating a new form. Every time you have a form or row set, and you want to change the filter, remember to set the ApplyFilter property at least once. Afterwards, reload() is called.

In general, ApplyFilter allows the user of a row set to enable or disable the current filter quickly without remembering it. To see what the effects of the current filter are, set ApplyFilter to false and reload the form.