| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Computed Column 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">ComputedColumn Structure</p> |
| <h1>Structure Overview</h1> |
| <div class="section-text"> |
| A user-defined column in the result set.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Computed Column</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| </table> |
| |
| <h3>Property Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Property-aggregateFunction">aggregateFunction</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-aggregateOn">aggregateOn</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-arguments">arguments</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-dataType">dataType</a></dt> |
| <dd>Column data type property.</dd> |
| <dt><a href="#Property-displayName">displayName</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-expression">expression</a></dt> |
| <dd>The BIRT expression that defines the value of the computed column.</dd> |
| <dt><a href="#Property-filterExpr">filterExpr</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-name">name</a></dt> |
| <dd>The name of the computed column.</dd> |
| </dl> |
| |
| <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. It is not one of the columns |
| retrieved directly from the underlying data provider.</p></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-aggregateFunction">aggregateFunction 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>2.2</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>AggregateOn Function</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-aggregateOn">aggregateOn Property</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#list">list</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>AggregateOn Expression</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-arguments">arguments 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/AggregationArgument.html">AggregationArgument</a> Structures</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>AggregateOn Function Arguments</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-dataType">dataType Property</a></h2> |
| |
| <p class="section-text">Column data type property.</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.0</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></td></tr> |
| <tr><td>string</td> |
| <td>String</td> |
| <td>string</td> |
| <td></td></tr> |
| <tr><td>date-time</td> |
| <td>Date Time</td> |
| <td>date-time</td> |
| <td></td></tr> |
| <tr><td>decimal</td> |
| <td>Decimal</td> |
| <td>decimal</td> |
| <td></td></tr> |
| <tr><td>float</td> |
| <td>Float</td> |
| <td>float</td> |
| <td></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>Column data type property.</p></div> |
| |
| <hr> |
| <h2><a name="Property-displayName">displayName 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>2.2</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Column 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> |
| |
| |
| <hr> |
| <h2><a name="Property-expression">expression Property</a></h2> |
| |
| <p class="section-text">The BIRT expression that defines the value of the computed column.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#expression">expression</a></td></tr> |
| <tr><td>Context:</td> |
| <td>factory</td></tr> |
| <tr><td>Expression Type:</td> |
| <td>any</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>Expression</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 expression that gets evaluated and its resulting |
| value assigned to the computed column.</p></div> |
| |
| <hr> |
| <h2><a name="Property-filterExpr">filterExpr Property</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#expression">expression</a></td></tr> |
| <tr><td>Context:</td> |
| <td></td></tr> |
| <tr><td>Expression Type:</td> |
| <td>None</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>Filter Expression</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-name">name Property</a></h2> |
| |
| <p class="section-text">The name of the computed column.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#memberKey">memberKey</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>The name of the computed column and is required. The name |
| must be unique within the result set.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p>The Result Column Names section for |
| the naming rules.</p></div> |
| </body> |
| </html> |
