| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>OdaResultSetColumn 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">OdaResultSetColumn Structure</p> |
| <h1>Structure Overview</h1> |
| <div class="section-text"> |
| Describes a column within a result set of an ODA data set.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>OdaResultSetColumn</td></tr> |
| <tr><td>Since:</td> |
| <td>2.1.1</td></tr> |
| </table> |
| |
| <h3>Property Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Property-dataType">dataType</a></dt> |
| <dd>The optional data type of the column.</dd> |
| <dt><a href="#Property-name">name</a></dt> |
| <dd>The name of the column.</dd> |
| <dt><a href="#Property-nativeDataType">nativeDataType</a></dt> |
| <dd>The data type know to an ODA user.</dd> |
| <dt><a href="#Property-nativeName">nativeName</a></dt> |
| <dd>The name known to an ODA user.</dd> |
| <dt><a href="#Property-position">position</a></dt> |
| <dd>The 1-based position of the column, as defined by the |
| driver of underlying data provider.</dd> |
| </dl> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The column definition element describes a column within a |
| result set.</p></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-dataType">dataType Property</a></h2> |
| |
| <p class="section-text">The optional data type of the column.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#choice">choice</a> (columnDataType)</td></tr> |
| <tr><td>Since:</td> |
| <td>2.1.1</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Data Type</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>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>any</td> |
| <td>Any</td> |
| <td>any</td> |
| <td></td></tr> |
| <tr><td>integer</td> |
| <td>Integer</td> |
| <td>integer</td> |
| <td>A whole number.</td></tr> |
| <tr><td>string</td> |
| <td>String</td> |
| <td>string</td> |
| <td>Arbitrary Unicode text.</td></tr> |
| <tr><td>date-time</td> |
| <td>Date Time</td> |
| <td>date-time</td> |
| <td>A date, time or |
| combination of date and time.</td></tr> |
| <tr><td>decimal</td> |
| <td>Decimal</td> |
| <td>decimal</td> |
| <td>Any type of number |
| including currency. Fixed decimal, arbitrary precision.</td></tr> |
| <tr><td>float</td> |
| <td>Float</td> |
| <td>float</td> |
| <td>A scientific amount |
| using the usual floating point notation.</td></tr> |
| <tr><td>boolean</td> |
| <td>Boolean</td> |
| <td>boolean</td> |
| <td></td></tr> |
| <tr><td>date</td> |
| <td>Date</td> |
| <td>date</td> |
| <td></td></tr> |
| <tr><td>time</td> |
| <td>Time</td> |
| <td>time</td> |
| <td></td></tr> |
| </tbody></table><br> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The optional data type. Required only for data sets that |
| require this information.</p></div> |
| |
| <hr> |
| <h2><a name="Property-name">name Property</a></h2> |
| |
| <p class="section-text">The name of 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>2.1.1</td></tr> |
| <tr><td>Required:</td> |
| <td>Yes</td></tr> |
| <tr><td>Display Name:</td> |
| <td>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 of a result set column. Required. This is the |
| column name referenced by report elements. </p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p>The Result Set Columns� Column Names section above for |
| the naming rules.</p></div> |
| |
| <hr> |
| <h2><a name="Property-nativeDataType">nativeDataType Property</a></h2> |
| |
| <p class="section-text">The data type know to an ODA user.</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.1.1</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Native Data Type Code</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 is the data type known to an ODA custom designer and runtime driver, and is provided by a custom ODA designer. </p></div> |
| |
| <hr> |
| <h2><a name="Property-nativeName">nativeName Property</a></h2> |
| |
| <p class="section-text">The name known to an ODA user.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#literalString">literalString</a></td></tr> |
| <tr><td>Since:</td> |
| <td>2.1.1</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Native 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 is the name known to an ODA custom designer and runtime driver, and is provided by a custom ODA designer. </p></div> |
| |
| <hr> |
| <h2><a name="Property-position">position Property</a></h2> |
| |
| <p class="section-text">The 1-based position of the column, as defined by the |
| driver of underlying data provider.</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.1.1</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Position</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 optional 1-based position of the column, as defined |
| by the driver of underlying data provider. Required for data sets that identify |
| columns by position instead of name; ignored otherwise.</p></div> |
| </body> |
| </html> |
