| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Data Set Element (Eclipse BIRT ROM Documentation)</title> |
| <link rel="stylesheet" href="../style/style.css" type="text/css"/> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| </head> |
| <body> |
| <p class="title">Eclipse BIRT Report Object Model (ROM)</p> |
| <p class="subtitle">DataSet Element</p> |
| <h1>Element Overview</h1> |
| <div class="section-text"> |
| Parent of simple data set and joint data set.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Data Set</td></tr> |
| <tr><td>Since:</td> |
| <td>2.1</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>None</code></td></tr> |
| <tr><td>Extends:</td> |
| <td><a href="ReportElement.html">ReportElement</a></td></tr> |
| <tr><td>Extendable:</td> |
| <td>No</td></tr> |
| <tr><td>Abstract:</td> |
| <td>Yes</td></tr> |
| <tr><td>Name Space:</td> |
| <td>Data Sets</td></tr> |
| <tr><td>Name Requirement:</td> |
| <td>Required</td></tr> |
| <tr><td>Allows User Properties:</td> |
| <td>Yes</td></tr> |
| <tr><td>Has Style:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Property Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Property-cachedMetaData">cachedMetaData</a></dt> |
| <dd>Cached derived data attributes of a data set.</dd> |
| <dt><a href="#Property-columnHints">columnHints</a></dt> |
| <dd>Defines the report-related data attributes of the result set�s columns.</dd> |
| <dt><a href="#Property-computedColumns">computedColumns</a></dt> |
| <dd>User-defined columns in the result set.</dd> |
| <dt><a href="#Property-filter">filter</a></dt> |
| <dd>An optional set of filters to apply to the result set before any other data transforms.</dd> |
| <dt><a href="#Property-resultSetHints">resultSetHints</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-rowFetchLimit">rowFetchLimit</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h3>Inherited Properties</h3> |
| |
| <p class="section-text"> |
| <a href="ReportElement.html#Property-comments">comments</a>, |
| <a href="DesignElement.html#Property-customXml">customXml</a>, |
| <a href="ReportElement.html#Property-displayName">displayName</a>, |
| <a href="ReportElement.html#Property-displayNameID">displayNameID</a>, |
| <a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, |
| <a href="ReportElement.html#Property-extends">extends</a>, |
| <a href="ReportElement.html#Property-name">name</a>, |
| <a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, |
| <a href="DesignElement.html#Property-userProperties">userProperties</a>, |
| <a href="ReportElement.html#Property-viewAction">viewAction</a> |
| </p> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p></p></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-cachedMetaData">cachedMetaData Property</a></h2> |
| |
| <p class="section-text">Cached derived data attributes of a data set.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../structs/CachedMetaData.html">CachedMetaData</a> Structure</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Cached metadata</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Hidden</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Defines the cached derived data attributes of a data |
| set. The BIRT designer uses the cached |
| information until the user initiates refresh and reconciles with the latest |
| derived data attributes provided by the connected data source. This |
| property is used during report design time only; its content is maintained by |
| the BIRT designer tool.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p><code>CachedMetaData</span> structure</p></div> |
| |
| <hr> |
| <h2><a name="Property-columnHints">columnHints Property</a></h2> |
| |
| <p class="section-text">Defines the report-related data attributes of the result set�s columns.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td>List of <a href="../structs/ColumnHint.html">ColumnHint</a> Structures</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Column hints</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Hidden</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>In BIRT, a result set column can be defined with an |
| alias. Aliases are useful in cases where a column name is awkward, or is used |
| by multiple columns in a result set.</p> |
| |
| <p>BIRT reports provide a rich viewing experience. The user |
| can search the report, extract data to a file, export data to an OLAP system, |
| and more. Such operations work on the actual data set�s result set instead of on |
| the presentation of the data. Column hints let the report developer customize |
| the search and data extract experience.</p> |
| |
| <p>The column hint element provides a number of "hints" |
| about result set columns. The hints override BIRT defaults for how columns are |
| handled during viewing. Hints can be provided for both retrieved and computed |
| columns.</p> |
| |
| <p>Column hints are keyed to the data set�s primary result |
| set using names. The user must understand how to keep the hints in sync with the |
| data set when either the data set definition, or underlying data source, |
| changes.</p> |
| |
| <p>BIRT uses the column hints in the following cases:</p> |
| |
| <ul> |
| <li>The report references a column using the alias defined in the column hint.</li> |
| <li>The report references a column (retrieved or computed) that is also referenced by the column hint.</li> |
| <li>The column hint has the Export attribute set to "always".</li> |
| </ul> |
| |
| <p>In each case, BIRT checks whether the data set provides |
| the requested column. If so, it continues processing the report. If not, it |
| issues a fatal runtime error.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p><code>ColumnHint</span> structure</p></div> |
| |
| <hr> |
| <h2><a name="Property-computedColumns">computedColumns Property</a></h2> |
| |
| <p class="section-text">User-defined columns in the result set.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td>List of <a href="../structs/ComputedColumn.html">ComputedColumn</a> Structures</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Computed columns</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Hidden</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>A computed column is a user-defined column produced as an |
| expression of other columns within the data set�s primary result set. It is not |
| of the columns retrieved directly from the underlying data provider.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p><code>ComputedColumn</span> structure</p></div> |
| |
| <hr> |
| <h2><a name="Property-filter">filter Property</a></h2> |
| |
| <p class="section-text">An optional set of filters to apply to the result set before any other data transforms.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td>List of <a href="../structs/FilterCondition.html">FilterCondition</a> Structures</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Filter</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Hidden</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>An optional set of filters that apply to the data set�s |
| primary result set. A data set�s filter is applied to each row of the retrieved |
| result set before any other data transforms. The filter expression should thus |
| not contain any aggregation functions. It usually references at least one |
| column from a data row, and may also reference a report parameter or other |
| scripting variable.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p><code>Filter Criteria</span> structure</p> |
| <p>Listing <code>filter</code> property</p> |
| <p>ListingGroup <code>filter</code> |
| property</p></div> |
| |
| <hr> |
| <h2><a name="Property-resultSetHints">resultSetHints Property</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td>List of <a href="../structs/ResultSetColumn.html">ResultSetColumn</a> Structures</td></tr> |
| <tr><td>Since:</td> |
| <td>2.1</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Result set hints</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Hidden</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| |
| <hr> |
| <h2><a name="Property-rowFetchLimit">rowFetchLimit Property</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#integer">integer</a></td></tr> |
| <tr><td>Since:</td> |
| <td>2.2</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Max number of rows to fetch from data set</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Visible</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| </body> |
| </html> |
