| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Column Hint 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">ColumnHint Structure</p> |
| <h1>Structure Overview</h1> |
| <div class="section-text"> |
| Provides a number of |
| report-related data attributes about a result set column.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Column Hint</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| </table> |
| |
| <h3>Property Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Property-alias">alias</a></dt> |
| <dd>Provides an "alias" name to the column for use within the report.</dd> |
| <dt><a href="#Property-analysis">analysis</a></dt> |
| <dd>Determines how the column is used when exporting the data to an OLAP cube.</dd> |
| <dt><a href="#Property-columnName">columnName</a></dt> |
| <dd>The name of the result set column for which hints are defined.</dd> |
| <dt><a href="#Property-displayName">displayName</a></dt> |
| <dd>The optional localizable display name for the column.</dd> |
| <dt><a href="#Property-displayNameID">displayNameID</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-export">export</a></dt> |
| <dd>Determines how the column will be used when exporting data.</dd> |
| <dt><a href="#Property-format">format</a></dt> |
| <dd>The format string used to format the column data when displaying the value in the search result UI.</dd> |
| <dt><a href="#Property-helpText">helpText</a></dt> |
| <dd>The optional localizable descriptive text that explains the column to the end user.</dd> |
| <dt><a href="#Property-helpTextID">helpTextID</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-parentLevel">parentLevel</a></dt> |
| <dd>Specifies the parent of the column when exporting the data to an OLAP cube.</dd> |
| <dt><a href="#Property-searching">searching</a></dt> |
| <dd>Indicates how the column will be used when searching.</dd> |
| </dl> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>A column hint defines report-related data attributes |
| about a retrieved column or a computed column.</p></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-alias">alias Property</a></h2> |
| |
| <p class="section-text">Provides an "alias" name to the column for use within the report.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#string">string</a></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>Alias</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Provides an "alias" name to the column for use within the |
| report. Useful if the column names are awkward. Optional.</p></div> |
| |
| <hr> |
| <h2><a name="Property-analysis">analysis Property</a></h2> |
| |
| <p class="section-text">Determines how the column is used when exporting the data to an OLAP cube.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#choice">choice</a> (analysisType)</td></tr> |
| <tr><td>Since:</td> |
| <td>reserved</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Analysis</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>auto</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Choices</h3> |
| |
| <table class="section-table"> |
| <thead><tr><td>Name</td><td>Display Name</td> |
| <td>Value</td><td>Description</td></tr></thead> |
| <tbody> |
| <tr><td>auto</td> |
| <td>Auto</td> |
| <td>auto</td> |
| <td>BIRT will attempt to guess the proper use of the |
| column.</td></tr> |
| <tr><td>dimension</td> |
| <td>Dimension</td> |
| <td>dimension</td> |
| <td>The column is a dimension. Use the Parent Dimension |
| property to define the dimension hierarchy.</td></tr> |
| <tr><td>measure</td> |
| <td>Measure</td> |
| <td>measure</td> |
| <td>The column is numeric measure.</td></tr> |
| <tr><td>detail</td> |
| <td>Detail</td> |
| <td>detail</td> |
| <td>The column provides additional information about a |
| dimension. Use the Parent Dimension property to define the dimension for |
| which this column is a detail.</td></tr> |
| <tr><td>none</td> |
| <td>No analysis type</td> |
| <td>none</td> |
| <td>The column should not be exported for use with OLAP.</td></tr> |
| </tbody></table><br> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Determines how the column is used when exporting the data |
| to an OLAP cube. OLAP cubes require that the columns be structured into |
| dimension hierarchies. Such hierarchies are formed though a sequence of |
| dimensions. The intersection of hierarchies has one or more numeric measures. |
| Columns that are neither dimensions nor measures can be detail attributes |
| associated with a dimension. Whether any given column is actually available for |
| use with analysis depends on the Export property above.</p></div> |
| |
| <hr> |
| <h2><a name="Property-columnName">columnName Property</a></h2> |
| |
| <p class="section-text">The name of the result set column for which hints are defined.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#string">string</a></td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>Yes</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Column Name</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>This property keys the column hint to a column within the |
| result set. The name is defined either by the data provider, a result set column |
| definition, or a computed column definition. </p></div> |
| |
| <hr> |
| <h2><a name="Property-displayName">displayName Property</a></h2> |
| |
| <p class="section-text">The optional localizable display name for the column.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#string">string</a></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>Display Name</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The name displayed to the end-user for the column. The |
| display name can be localized. If the display name is omitted, the column name |
| itself is displayed instead.</p></div> |
| |
| <hr> |
| <h2><a name="Property-displayNameID">displayNameID Property</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#string">string</a></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>Display Name Resource Key</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| </table> |
| |
| |
| <hr> |
| <h2><a name="Property-export">export Property</a></h2> |
| |
| <p class="section-text">Determines how the column will be used when exporting data.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#choice">choice</a> (exportType)</td></tr> |
| <tr><td>Since:</td> |
| <td>reserved</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Export</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>if-realized</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Choices</h3> |
| |
| <table class="section-table"> |
| <thead><tr><td>Name</td><td>Display Name</td> |
| <td>Value</td><td>Description</td></tr></thead> |
| <tbody> |
| <tr><td>none</td> |
| <td>No export type</td> |
| <td>none</td> |
| <td>The column cannot be exported.</td></tr> |
| <tr><td>if-realized</td> |
| <td>If Realized</td> |
| <td>if-realized</td> |
| <td>The column can be exported only if it is referenced |
| somewhere in the report.</td></tr> |
| <tr><td>always</td> |
| <td>Always</td> |
| <td>always</td> |
| <td>The column can always be exported. This setting acts |
| like a column reference, and forces the column to be realized even if the |
| column is not otherwise used within the report.</td></tr> |
| </tbody></table><br> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Determines how the column will be used when exporting |
| data.</p></div> |
| |
| <hr> |
| <h2><a name="Property-format">format Property</a></h2> |
| |
| <p class="section-text">The format string used to format the column data when displaying the value in the search result UI.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#string">string</a></td></tr> |
| <tr><td>Since:</td> |
| <td>reserved</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Format</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>An optional BIRT format string used to format the column |
| data when displaying the value in the viewing UI, especially within the search |
| results.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p>Style <code>format</code> properties</p></div> |
| |
| <hr> |
| <h2><a name="Property-helpText">helpText Property</a></h2> |
| |
| <p class="section-text">The optional localizable descriptive text that explains the column to the end user.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#string">string</a></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>Help Text</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Additional pop-up help text associated with the column. |
| This descriptive text can explain the purpose of the column to the end user. |
| The help text can be localized.</p></div> |
| |
| <hr> |
| <h2><a name="Property-helpTextID">helpTextID Property</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#string">string</a></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>Help Text Resource Key</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| </table> |
| |
| |
| <hr> |
| <h2><a name="Property-parentLevel">parentLevel Property</a></h2> |
| |
| <p class="section-text">Specifies the parent of the column when exporting the data to an OLAP cube.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#string">string</a></td></tr> |
| <tr><td>Since:</td> |
| <td>reserved</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Parent Level</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Used when a column�s Analysis property is set to |
| Dimension or Detail. For Dimensions, this property establishes the dimension |
| hierarchy. Lower (more detailed) dimensions identify their parent (more general) |
| dimensions. For details, this property identifies the dimension for which this |
| column is a detail attribute.</p></div> |
| |
| <hr> |
| <h2><a name="Property-searching">searching Property</a></h2> |
| |
| <p class="section-text">Indicates how the column will be used when searching.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#choice">choice</a> (searchType)</td></tr> |
| <tr><td>Since:</td> |
| <td>reserved</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Searching</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>any</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| </table> |
| |
| <h3>Choices</h3> |
| |
| <table class="section-table"> |
| <thead><tr><td>Name</td><td>Display Name</td> |
| <td>Value</td><td>Description</td></tr></thead> |
| <tbody> |
| <tr><td>any</td> |
| <td>Any</td> |
| <td>any</td> |
| <td>The column is always searchable, whether it is indexed |
| or not.</td></tr> |
| <tr><td>indexed</td> |
| <td>Indexed</td> |
| <td>indexed</td> |
| <td>The column is searchable if it is indexed.</td></tr> |
| <tr><td>none</td> |
| <td>No search type</td> |
| <td>none</td> |
| <td>The column is not searchable.</td></tr> |
| </tbody></table><br> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Indicates how the column will be used when searching.</p></div> |
| </body> |
| </html> |
