Difference between revisions of "SUN Report Builder/Functions"
From Apache OpenOffice Wiki
DrewJensen (Talk | contribs) (→blank tables) |
|||
Line 2: | Line 2: | ||
− | ''' | + | '''Rounding'''<br> |
{| class="prettytable" cellpadding="10" border="1" | {| class="prettytable" cellpadding="10" border="1" | ||
| '''''Function Name''''' | | '''''Function Name''''' | ||
| '''''Description''''' | | '''''Description''''' | ||
+ | | '''''Parameters''''' | ||
| '''''Example ''''' | | '''''Example ''''' | ||
+ | |||
|- | |- | ||
− | | | + | | INT |
− | | | + | | Returns a number down to the nearest integer |
| | | | ||
+ | |} | ||
+ | <br> | ||
+ | '''Information'''<br> | ||
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Function Name''''' | ||
+ | | '''''Description''''' | ||
+ | | '''''Parameters''''' | ||
+ | | '''''Example ''''' | ||
|- | |- | ||
− | | | + | | CHOOSE |
− | | | + | | Uses an index to return a value from a list of values. |
| | | | ||
|- | |- | ||
− | | | + | | HASCHANGED |
− | | | + | | Checks, whether the columns specified by the given names has changed. |
| | | | ||
|- | |- | ||
− | | | + | | ISBLANK |
− | | | + | | Checks, whether the value is undefined (null). |
| | | | ||
|- | |- | ||
− | | | + | | ISERR |
− | | | + | | Tells if the parameter is of error type but returns false if the error is of type NA. |
| | | | ||
|- | |- | ||
− | | | + | | ISERROR |
− | | | + | | Tells if the parameter is of error type but returns false. |
| | | | ||
|- | |- | ||
− | | | + | | ISEVEN |
− | | | + | | Checks whatever the value is an even number. |
| | | | ||
|- | |- | ||
− | | | + | | ISLOGICAL |
− | | | + | | Checks whatever the value is of type Logical. |
| | | | ||
|- | |- | ||
− | | | + | | ISNA |
− | | | + | | Tells if the parameter is of error type NA. |
| | | | ||
|- | |- | ||
− | | | + | | ISNONTEXT |
+ | | Checks whatever the value is not of type Text. | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | | | + | | ISNUMBER |
+ | | Checks whatever the value is of type Number. | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | | | + | | ISODD |
− | | | + | | Checks whatever the value is an odd number. |
| | | | ||
|- | |- | ||
− | | | + | | ISREF |
− | | | + | | Checks whatever the value is a reference. |
| | | | ||
|- | |- | ||
− | | | + | | ISTEXT |
− | | | + | | Checks whatever the value is of type Text. |
| | | | ||
|- | |- | ||
− | | | + | | NA |
− | | | + | | Returns the constant error NA. |
| | | | ||
+ | |} | ||
+ | <br> | ||
+ | '''Date/Time'''<br> | ||
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Function Name''''' | ||
+ | | '''''Description''''' | ||
+ | | '''''Parameters''''' | ||
+ | | '''''Example ''''' | ||
|- | |- | ||
− | | | + | | DATE |
− | | | + | | Returns the number of days since 01.01.1900 |
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Parameter Description''''' | ||
+ | | Month | ||
+ | | Day | ||
+ | |} | ||
| | | | ||
|- | |- | ||
− | | | + | | DATEDIF |
− | | | + | | Returns the number of years, months, or days between two dates. |
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Parameter Description''''' | ||
+ | | Date2 | ||
+ | | Format | ||
+ | |} | ||
| | | | ||
|- | |- | ||
− | | | + | | DATEVALUE |
− | | | + | | Returns date serial number from given text. |
| | | | ||
|- | |- | ||
− | | | + | | DAY |
− | | | + | | Returns the day of a date |
| | | | ||
|- | |- | ||
− | | | + | | HOUR |
− | | | + | | Returns the hour (0 through 23) from a time. |
| | | | ||
|- | |- | ||
− | | | + | | MONTH |
− | | | + | | Returns the month of a date |
| | | | ||
|- | |- | ||
− | | | + | | NOW |
− | | | + | | Returns the current time |
| | | | ||
|- | |- | ||
− | | | + | | TIME |
− | | | + | | Returns the time |
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Parameter Description''''' | ||
+ | | Minute. | ||
+ | | Second | ||
+ | |} | ||
| | | | ||
|- | |- | ||
− | | | + | | TODAY |
− | | | + | | Returns the current date |
| | | | ||
|- | |- | ||
− | | | + | | WEEKDAY |
− | | | + | | Returns the day of week from a date. |
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Parameter Description''''' | ||
+ | | Type | ||
+ | |} | ||
| | | | ||
|- | |- | ||
− | | | + | | YEAR |
+ | | Returns the year of a date | ||
| | | | ||
− | |||
− | |||
|} | |} | ||
<br> | <br> | ||
− | ''' | + | '''Text'''<br> |
{| class="prettytable" cellpadding="10" border="1" | {| class="prettytable" cellpadding="10" border="1" | ||
| '''''Function Name''''' | | '''''Function Name''''' | ||
− | | '''''Description''''' | + | | '''''Description''''' |
− | | '''''Example''''' | + | | '''''Parameters''''' |
+ | | '''''Example ''''' | ||
|- | |- | ||
− | | | + | | EXACT |
− | | | + | | Reports if two text values are exactly equal using a case-sensitive comparison. |
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Parameter Description''''' | ||
+ | | Text2 | ||
+ | |} | ||
| | | | ||
|- | |- | ||
− | | | + | | FIND |
− | | | + | | Returns the starting position of a given text. |
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Parameter Description''''' | ||
+ | | Text | ||
+ | | Index | ||
+ | |} | ||
| | | | ||
|- | |- | ||
− | | | + | | LEFT |
− | | | + | | Returns a selected number of text characters from the left. |
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Parameter Description''''' | ||
+ | | Length | ||
+ | |} | ||
| | | | ||
|- | |- | ||
− | | | + | | LEN |
− | | | + | | Returns the lengh in characters of the given value. |
| | | | ||
|- | |- | ||
− | | | + | | LOWER |
− | | | + | | Returns the given text in lower case. |
| | | | ||
|- | |- | ||
− | | | + | | MID |
− | | | + | | Returns extracted text, given an original text, starting position, and length. |
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Parameter Description''''' | ||
+ | | Start | ||
+ | | Length | ||
+ | |} | ||
| | | | ||
|- | |- | ||
− | | | + | | REPLACE |
− | | | + | | Returns text where an old text is substituted with a new text within the start index and length range. |
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Parameter Description''''' | ||
+ | | Start | ||
+ | | Len | ||
+ | | New | ||
+ | |} | ||
| | | | ||
− | | | + | |- |
− | + | | REPT | |
− | + | | Returns text repeated Count times.. | |
{| class="prettytable" cellpadding="10" border="1" | {| class="prettytable" cellpadding="10" border="1" | ||
− | | ''''' | + | | '''''Parameter Description''''' |
− | | | + | | Count |
− | | | + | |} |
+ | | | ||
|- | |- | ||
− | | | + | | RIGHT |
+ | | Returns a selected number of text characters from the right. | ||
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Parameter Description''''' | ||
+ | | Count | ||
+ | |} | ||
| | | | ||
+ | |||
+ | |- | ||
+ | | SUBSTITUTE | ||
+ | | Returns text where an old text is substituted with a new text. If which is specified, only this occurrance will be replaced otherwise every occurrance will be replaced. | ||
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Parameter Description''''' | ||
+ | | Old | ||
+ | | New | ||
+ | | Which | ||
+ | |} | ||
| | | | ||
|- | |- | ||
− | | | + | | T |
− | | | + | | Returns the given text value or a zero lenght string for non text type. |
| | | | ||
|- | |- | ||
− | | | + | | TEXT |
− | | | + | | Returns the given value as text. |
| | | | ||
|- | |- | ||
− | | | + | | LOWER |
− | | | + | | Returns the given text free of leading and trailing spaces. Internal multiple spaces are replaced by one. |
| | | | ||
|- | |- | ||
− | | | + | | UPPER |
− | | | + | | Returns the given text in upper case. |
| | | | ||
+ | |- | ||
+ | | URLENCODE | ||
+ | | Applies URL-Encoding to a text given in the first parameter using the encoding specified in the second parameter. If no encoding is given, ISO-8859-1 is assumed. | ||
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Parameter Description''''' | ||
+ | | Encoding | ||
|} | |} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
| | | | ||
− | |||
− | |||
|} | |} | ||
<br> | <br> | ||
− | ''' | + | '''Mathematical'''<br> |
{| class="prettytable" cellpadding="10" border="1" | {| class="prettytable" cellpadding="10" border="1" | ||
| '''''Function Name''''' | | '''''Function Name''''' | ||
− | | '''''Description''''' | + | | '''''Description''''' |
− | | '''''Example''''' | + | | '''''Parameters''''' |
+ | | '''''Example ''''' | ||
|- | |- | ||
− | | | + | | ABS |
− | | | + | | Returns the absolute (nonnegative) of the value. |
| | | | ||
|- | |- | ||
− | | | + | | AVERAGE |
− | | | + | | Average a list of numeric values. |
| | | | ||
|- | |- | ||
− | | | + | | Even |
− | | | + | | Returns the rounding a number up to the nearest even integer. |
| | | | ||
|- | |- | ||
− | | | + | | MAX |
− | | | + | | Returns the maximum from a set of numbers. |
| | | | ||
|- | |- | ||
− | | | + | | MIN |
− | | | + | | Returns the minimum from a set of numbers. |
| | | | ||
|- | |- | ||
− | | | + | | MOD |
− | | | + | | Returns the remainder when one number is divided by another number. |
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Parameter Description''''' | ||
+ | | Divisor | ||
+ | |} | ||
| | | | ||
|- | |- | ||
− | | | + | | ODD |
− | | | + | | Returns the rounding a number up to the nearest odd integer. |
| | | | ||
|- | |- | ||
− | | | + | | SUM |
− | | | + | | Sum a list of numeric values. |
| | | | ||
+ | |} | ||
+ | <br> | ||
+ | '''Logical'''<br> | ||
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Function Name''''' | ||
+ | | '''''Description''''' | ||
+ | | '''''Parameters''''' | ||
+ | | '''''Example ''''' | ||
|- | |- | ||
− | | | + | | AND |
− | | | + | | Logical AND |
| | | | ||
|- | |- | ||
− | | | + | | FALSE |
− | | | + | | Logical FALSE |
| | | | ||
|- | |- | ||
− | | | + | | IF |
− | | | + | | Conditional execution |
+ | {| class="prettytable" cellpadding="10" border="1" | ||
+ | | '''''Parameter Description''''' | ||
+ | | A term that is evaluated if the condition evaluates to true. | ||
+ | | A term that is evaluated if the condition evaluates to false. | ||
+ | |} | ||
| | | | ||
|- | |- | ||
− | | | + | | AND |
− | | | + | | Logical AND |
| | | | ||
|- | |- | ||
− | | | + | | OR |
− | | | + | | Logical OR |
| | | | ||
|- | |- | ||
− | | | + | | TRUE |
− | | | + | | Logical TRUE |
| | | | ||
|- | |- | ||
− | | | + | | XOR |
+ | | Logical XOR | ||
| | | | ||
− | |||
− | |||
|} | |} | ||
<br> | <br> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− |
Revision as of 09:37, 11 October 2007
The Sun Report Builder supplies the following functions:
Rounding
Function Name | Description | Parameters | Example |
INT | Returns a number down to the nearest integer |
Information
Function Name | Description | Parameters | Example |
CHOOSE | Uses an index to return a value from a list of values. | ||
HASCHANGED | Checks, whether the columns specified by the given names has changed. | ||
ISBLANK | Checks, whether the value is undefined (null). | ||
ISERR | Tells if the parameter is of error type but returns false if the error is of type NA. | ||
ISERROR | Tells if the parameter is of error type but returns false. | ||
ISEVEN | Checks whatever the value is an even number. | ||
ISLOGICAL | Checks whatever the value is of type Logical. | ||
ISNA | Tells if the parameter is of error type NA. | ||
ISNONTEXT | Checks whatever the value is not of type Text. | ||
ISNUMBER | Checks whatever the value is of type Number. | ||
ISODD | Checks whatever the value is an odd number. | ||
ISREF | Checks whatever the value is a reference. | ||
ISTEXT | Checks whatever the value is of type Text. | ||
NA | Returns the constant error NA. |
Date/Time
Function Name | Description | Parameters | Example | ||
DATE | Returns the number of days since 01.01.1900
|
||||
DATEDIF | Returns the number of years, months, or days between two dates.
|
||||
DATEVALUE | Returns date serial number from given text. | ||||
DAY | Returns the day of a date | ||||
HOUR | Returns the hour (0 through 23) from a time. | ||||
MONTH | Returns the month of a date | ||||
NOW | Returns the current time | ||||
TIME | Returns the time
|
||||
TODAY | Returns the current date | ||||
WEEKDAY | Returns the day of week from a date.
|
||||
YEAR | Returns the year of a date |
Text
Function Name | Description | Parameters | Example | |||
EXACT | Reports if two text values are exactly equal using a case-sensitive comparison.
|
|||||
FIND | Returns the starting position of a given text.
|
|||||
LEFT | Returns a selected number of text characters from the left.
|
|||||
LEN | Returns the lengh in characters of the given value. | |||||
LOWER | Returns the given text in lower case. | |||||
MID | Returns extracted text, given an original text, starting position, and length.
|
|||||
REPLACE | Returns text where an old text is substituted with a new text within the start index and length range.
|
|||||
REPT | Returns text repeated Count times..
|
|||||
RIGHT | Returns a selected number of text characters from the right.
|
|||||
SUBSTITUTE | Returns text where an old text is substituted with a new text. If which is specified, only this occurrance will be replaced otherwise every occurrance will be replaced.
|
|||||
T | Returns the given text value or a zero lenght string for non text type. | |||||
TEXT | Returns the given value as text. | |||||
LOWER | Returns the given text free of leading and trailing spaces. Internal multiple spaces are replaced by one. | |||||
UPPER | Returns the given text in upper case. | |||||
URLENCODE | Applies URL-Encoding to a text given in the first parameter using the encoding specified in the second parameter. If no encoding is given, ISO-8859-1 is assumed.
|
Mathematical
Function Name | Description | Parameters | Example | |
ABS | Returns the absolute (nonnegative) of the value. | |||
AVERAGE | Average a list of numeric values. | |||
Even | Returns the rounding a number up to the nearest even integer. | |||
MAX | Returns the maximum from a set of numbers. | |||
MIN | Returns the minimum from a set of numbers. | |||
MOD | Returns the remainder when one number is divided by another number.
|
|||
ODD | Returns the rounding a number up to the nearest odd integer. | |||
SUM | Sum a list of numeric values. |
Logical
Function Name | Description | Parameters | Example | ||
AND | Logical AND | ||||
FALSE | Logical FALSE | ||||
IF | Conditional execution
|
||||
AND | Logical AND | ||||
OR | Logical OR | ||||
TRUE | Logical TRUE | ||||
XOR | Logical XOR |