| Attributes' Summary |
| MasterFields |
is used for subreports and contains the names of columns of the parent report.
|
| DetailFields |
is used for subreports and contains the names of the columns of the subreport
which are related to the master fields of the parent report.
|
| Command |
is the command which should be executed, the type of command depends
on the CommandType.
|
| CommandType |
specifies the type of the command to be executed to retrieve a result set.
|
| Filter |
specifies an addtional filter to optinally use.
|
| ApplyFilter |
indicates whether the filter should be applied or not,
default is false.
|
| HavingClause |
additional having clause for the row set
|
| GroupBy |
additional group by for the row set
|
| Order |
is a additional sort order definition for a rowset.
|
| EscapeProcessing |
specifies if the Command should be analyzed on the client side before sending it
to the database server.
|
| RowLimit |
specifies the maximal count of rows which should be fetched.
|
| ActiveConnection |
specifies the active connection which is used to create the resulting report.
|
| DataSourceName |
is the name of the datasource to use, this could be a named datasource
or the URL of a data access component.
|
| Attributes' Details |
MasterFields
[ bound ] sequence< string > MasterFields;
- Description
- is used for subreports and contains the names of columns of the parent report.
These columns are typically the foreign key fields of the parent report.
The values of theses columns are used to identify the data for the subreport.
Each time the parent report changes it's current row, the subreport requeries
it's data based on the values of the master fields.
If the report is no sub report (e.g. it's parent is not a report itself), this
property is not evaluated.
|
|
DetailFields
[ bound ] sequence< string > DetailFields;
- Description
- is used for subreports and contains the names of the columns of the subreport
which are related to the master fields of the parent report.
Entries in this sequence can either denote column names in the sub report,
or paramater names.
For instance, you could base the report on the SQL statement
SELECT * FROM invoices WHERE cust_ref = :cid, and add cid
to the DetailFields property. In this case, the parameter will be filled from
the corresponding master field.
Alternatively, you could simply base your report on the table invoices,
and add the column name cust_ref to the DetailFields. In this case,
and implicit filter clause WHERE cust_ref = :<new_param_name> will
be created, and the artificial parameter will be filled from the corresponding
master field.
If a string in this property denotes both a column name and a parameter name, it
is undefined which way it is interpreted, but implementations of the service are required
to either decide for the paramter or the column, and proceed as usual.
The columns specified herein typically represent a part of the primary key
fields or their aliases of the detail report.
If the report is no sub report (e.g. it's parent is not a report itself), this
property is not evaluated.
*
|
|
Command
[ bound ] string Command;
- Description
- is the command which should be executed, the type of command depends
on the CommandType.
In case of a CommandType of ::CommandType::COMMAND,
means in case the Command specifies an SQL statement, the inherited
::com::sun::star::sdbc::RowSet::EscapeProcessing
becomes relevant:
It then can be to used to specify whether the SQL statement should be analyzed on the
client side before sending it to the database server.
The default value for ::com::sun::star::sdbc::RowSet::EscapeProcessing
is true. By switching it to false, you can pass backend-specific SQL statements,
which are not standard SQL, to your database.
- See also
- ::com::sun::star::sdb::CommandType
|
|
CommandType
[ bound ] long CommandType;
- Description
- specifies the type of the command to be executed to retrieve a result set.
Command needs to be interpreted depending on the value of this property.
This property is only meaningfull together with the Command
property, thus either both or none of them are present.
- See also
- ::com::sun::star::sdb::CommandType
|
|
Filter
[ bound ] string Filter;
- Description
- specifies an addtional filter to optinally use.
The Filter string has to form a SQL WHERE-clause, without the WHERE-string itself.
If a DataSourceName, Command and CommandType
are specified, a ::RowSet can be created with this information. If the results provided by the
row set are to be additionally filtered, the Filter property can be used.
Note that the Filter property does not make sense if a ResultSet has been specified
in the DataAccessDescriptor.
- See also
- ::com::sun::star::sdb::RowSet, ResultSet
|
|
ApplyFilter
[ bound ] boolean ApplyFilter;
- Description
- indicates whether the filter should be applied or not,
default is false.
|
|
HavingClause
[ bound ] string HavingClause
- set raises (::com::sun::star::beans::UnknownPropertyException);
- Description
- additional having clause for the row set
|
|
| GroupBy
|
Order
[ bound ] string Order;
- Description
- is a additional sort order definition for a rowset.
|
|
EscapeProcessing
[ bound ] boolean EscapeProcessing;
- Description
- specifies if the Command should be analyzed on the client side before sending it
to the database server.
The default value of this property is true. By switching it to false, you can pass
backend-specific SQL statements, which are not standard SQL, to your database.
This property is usually present together with the Command and
CommandType properties, and is evaluated if and only if CommandType
equals ::CommandType::COMMAND.
|
|
RowLimit
[ bound ] long RowLimit;
- Description
- specifies the maximal count of rows which should be fetched.
A value of zero implies that no limit exists.
|
|
ActiveConnection
[ bound ] ::com::sun::star::sdbc::XConnection ActiveConnection
- set raises (::com::sun::star::lang::IllegalArgumentException);
- Description
- specifies the active connection which is used to create the resulting report.
|
|
DataSourceName
[ bound ] string DataSourceName;
- Description
- is the name of the datasource to use, this could be a named datasource
or the URL of a data access component.
|
|
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.
