Difference between revisions of "SUN Report Builder/Functions"

From Apache OpenOffice Wiki
Jump to: navigation, search
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
{{Database/Lang|Base/Reports/Functions}}
+
[[fr:FR/Documentation/Base/Rapports/Fonctions]]
 +
{{Database/Lang|Base/Reports/Functions}}  
  
−
== The Sun Report Builder supplies the following functions: ==
+
'''Date/Time'''<br>
  
−
 
+
{| cellpadding="10" border="1" class="prettytable"
−
=== Rounding ===
+
|-
−
 
+
| '''''Function Name'''''  
−
{| class="prettytable" cellpadding="10" border="1"
+
−
| '''''Function Name'''''
+
 
| '''''Description'''''  
 
| '''''Description'''''  
−
| '''''Example '''''
+
| '''''Example'''''
−
 
+
 
|-
 
|-
−
| INT
+
| DATE
−
| Returns a number down to the nearest integer
+
| Provides an internal number for the date given.
−
|  
+
{| cellpadding="10" border="1" class="prettytable"
 +
|-
 +
| '''''Parameter Name'''''
 +
| '''''Parameter Description'''''
 +
|-
 +
| month
 +
| An integer between 1 and 12 representing the month.
 +
|-
 +
| day
 +
| An integer between 1 and 31 representing the day of the month.
 
|}
 
|}
  
−
=== Information ===
 
−
 
−
{| class="prettytable" cellpadding="10" border="1"
 
−
| '''''Function Name'''''
 
−
| '''''Description'''''
 
−
| '''''Example '''''
 
−
 
−
|-
 
−
| CHOOSE
 
−
| Uses an index to return a value from a list of values.
 
 
|  
 
|  
−
 
 
|-
 
|-
−
| HASCHANGED
+
| DATEDIF
−
| Checks, whether the columns specified by the given names has changed.
+
| Returns the number of years, months, or days between two dates.  
−
|  
+
{| cellpadding="10" border="1" class="prettytable"
−
 
+
 
|-
 
|-
−
| ISBLANK
+
| '''''Parameter Name'''''
−
| Checks, whether the value is undefined (null).
+
| '''''Parameter Description'''''
−
|
+
−
 
+
 
|-
 
|-
−
| ISERR
+
| EndDate
−
| Tells if the parameter is of error type but returns false if the error is of type NA.
+
| Second date.
−
|  
+
|-
 +
| Format
 +
| Format code.
 +
|}
  
−
|-
 
−
| ISERROR
 
−
| Tells if the parameter is of error type but returns false.
 
 
|  
 
|  
−
 
 
|-
 
|-
−
| ISEVEN
+
| DATEVALUE
−
| Checks whatever the value is an even number.
+
| Returns an internal number for a text having a possible date format.  
 
|  
 
|  
−
 
 
|-
 
|-
−
| ISLOGICAL
+
| DAY
−
| Checks whatever the value is of type Logical.
+
| Returns the sequential date of the month as an integer (1-31) in relation to the date value.  
 
|  
 
|  
−
 
 
|-
 
|-
−
| ISNA
+
| DAYS
−
| Tells if the parameter is of error type NA.
+
| Calculates the number of days between two dates.  
−
|  
+
{| cellpadding="10" border="1" class="prettytable"
 +
|-
 +
| '''''Parameter Name'''''
 +
| '''''Parameter Description'''''
 +
|-
 +
| Date_1
 +
| The start date for calculating the difference in days.
 +
|}
  
−
|-
 
−
| ISNONTEXT
 
−
| Checks whatever the value is not of type Text.
 
 
|  
 
|  
−
 
 
|-
 
|-
−
| ISNUMBER
+
| HOUR
−
| Checks whatever the value is of type Number.
+
| Determines the sequential number of the hour of the day (0-23) for the time value.  
 
|  
 
|  
−
 
 
|-
 
|-
−
| ISODD
+
| MINUTE
−
| Checks whatever the value is an odd number.
+
| Determines the sequential number for the minute of the hour (0-59) for the time value.  
 
|  
 
|  
−
 
 
|-
 
|-
−
| ISREF
+
| MONTH
−
| Checks whatever the value is a reference.
+
| Determines the sequential number of a month of the year (1-12) for the date value.  
 
|  
 
|  
−
 
 
|-
 
|-
−
| ISTEXT
+
| NOW
−
| Checks whatever the value is of type Text.
+
| Determines the current time of the computer.  
 
|  
 
|  
−
 
 
|-
 
|-
−
| NA
+
| SECOND
−
| Returns the constant error NA.
+
| Determines the sequential number of the second of a minute (0-59) for the time value.  
 
|  
 
|  
−
|}
 
−
 
−
=== Date/Time ===
 
−
 
−
{| class="prettytable" cellpadding="10" border="1"
 
−
| '''''Function Name'''''
 
−
| '''''Description'''''
 
−
| '''''Example '''''
 
−
 
 
|-
 
|-
−
| DATE
+
| TIME
−
| Returns the number of days since 01.01.1900
+
| Determines a time value from the details for hour, minute and second.  
−
{| class="prettytable" cellpadding="10" border="1"
+
{| cellpadding="10" border="1" class="prettytable"
 +
|-
 
| '''''Parameter Name'''''  
 
| '''''Parameter Name'''''  
−
| '''''Parameter Description'''''  
+
| '''''Parameter Description'''''
−
 
+
 
|-
 
|-
−
| Month
+
| minute
−
| Month
+
| The integer for the minute.
 
|-
 
|-
−
| Day
+
| second
−
| Day
+
| The integer for the second.
 
|}
 
|}
  
 
|  
 
|  
−
 
 
|-
 
|-
−
| DATEDIF
+
| TIMEVALUE
−
| Returns the number of years, months, or days between two dates.
+
| Returns a sequential number for a text shown in a possible time entry format.  
−
{| class="prettytable" cellpadding="10" border="1"
+
|  
−
| '''''Parameter Name'''''
+
−
| '''''Parameter Description'''''
+
−
 
+
 
|-
 
|-
−
| Date1
+
| TODAY
−
| First date.
+
| Determines the current date of the computer.  
 +
|
 
|-
 
|-
−
| Date2
+
| WEEKDAY
−
| Second date.
+
| Returns the day of the week for the date value as an integer (1-7).  
 +
{| cellpadding="10" border="1" class="prettytable"
 
|-
 
|-
−
| Format
+
| '''''Parameter Name'''''
−
| Format code.
+
| '''''Parameter Description'''''
 +
|-
 +
| Type
 +
| Fixes the beginning of the week and the type of calculation to be used.(1 = Sunday is the first day of the week, with value 1; Saturday has value 7, 2 = Monday is the first day of the week, with value 1; Sunday has value 7, 3 = Monday is the first day of the week, with value 0; Sunday has value 6)
 
|}
 
|}
  
 
|  
 
|  
−
 
 
|-
 
|-
−
| DATEVALUE
+
| YEAR
−
| Returns date serial number from given text.
+
| Returns the year of a date value as an integer.  
 
|  
 
|  
 +
|}
  
 +
<br> '''Mathematical'''<br>
 +
 +
{| cellpadding="10" border="1" class="prettytable"
 +
|-
 +
| '''''Function Name'''''
 +
| '''''Description'''''
 +
| '''''Example'''''
 
|-
 
|-
−
| DAY
+
| ABS
−
| Returns the day of a date
+
| Absolute value of a number.
 
|  
 
|  
−
 
 
|-
 
|-
−
| HOUR
+
| AVERAGE
−
| Returns the hour (0 through 23) from a time.
+
| Returns the average of a sample.  
 
|  
 
|  
−
 
 
|-
 
|-
−
| MONTH
+
| AVERAGE
−
| Returns the month of a date
+
| Returns the average of a sample.
 
|  
 
|  
−
 
 
|-
 
|-
−
| NOW
+
| EVEN
−
| Returns the current time
+
| Rounds a positive number up and negative number down to the nearest even integer.
 
|  
 
|  
−
 
 
|-
 
|-
−
| TIME
+
| MAX
−
| Returns the time
+
| Returns the maximum value in a list of arguments.
−
{| class="prettytable" cellpadding="10" border="1"
+
|  
−
| '''''Parameter Name'''''
+
−
| '''''Parameter Description'''''
+
−
 
+
 
|-
 
|-
−
| Minute.
+
| MAXA
−
| Minutes
+
| Returns the maximum value in a list of arguments. Text is evaluated as zero.  
 +
|  
 
|-
 
|-
−
| Second
+
| MIN
−
| Seconds
+
| Returns the minimum value in a list of arguments.
−
|}
+
−
 
+
 
|  
 
|  
−
 
 
|-
 
|-
−
| TODAY
+
| MINA
−
| Returns the current date
+
| Returns the smallest value in a list of arguments. Text is evaluated as zero.
−
| "Insert -> Date and Time"
+
|
−
 
+
|-
 +
| MOD
 +
| Calculates the remainder of a division.
 +
{| cellpadding="10" border="1" class="prettytable"
 
|-
 
|-
−
| WEEKDAY
 
−
| Returns the day of week from a date.
 
−
{| class="prettytable" cellpadding="10" border="1"
 
 
| '''''Parameter Name'''''  
 
| '''''Parameter Name'''''  
−
| '''''Parameter Description'''''  
+
| '''''Parameter Description'''''
−
 
+
 
|-
 
|-
−
| Type
+
| Divisor
−
| The result type (from 1 to 3)
+
| The number by which the dividend is divided.
 
|}
 
|}
  
 
|  
 
|  
−
 
 
|-
 
|-
−
| YEAR
+
| ODD
−
| Returns the year of a date
+
| Rounds a positive number up and negative number down to the nearest odd integer.
 +
|
 +
|-
 +
| SUM
 +
| Returns the sum of all arguments.
 
|  
 
|  
 
|}
 
|}
  
−
=== Text ===
+
<br> '''Logical'''<br>
−
{| class="prettytable" cellpadding="10" border="1"
+
−
| '''''Function Name'''''
+
−
| '''''Description'''''
+
−
| '''''Example '''''
+
  
 +
{| cellpadding="10" border="1" class="prettytable"
 
|-
 
|-
−
| EXACT
+
| '''''Function Name'''''  
−
| Reports if two text values are exactly equal using a case-sensitive comparison.
+
| '''''Description'''''  
−
{| class="prettytable" cellpadding="10" border="1"
+
| '''''Example'''''
−
| '''''Parameter Name'''''  
+
−
| '''''Parameter Description'''''  
+
−
 
+
 
|-
 
|-
−
| Text2
+
| AND
−
| The second text.
+
| Returns TRUE if all arguments are TRUE.  
−
|}
+
−
 
+
 
|  
 
|  
−
 
 
|-
 
|-
−
| FIND
+
| FALSE
−
| Returns the starting position of a given text.
+
| Defines the logical value as FALSE.
−
{| class="prettytable" cellpadding="10" border="1"
+
|
 +
|-
 +
| IF
 +
| Specifies a logical test to be performed.  
 +
{| cellpadding="10" border="1" class="prettytable"
 +
|-
 
| '''''Parameter Name'''''  
 
| '''''Parameter Name'''''  
−
| '''''Parameter Description'''''  
+
| '''''Parameter Description'''''
−
 
+
 
|-
 
|-
−
| Text
+
| Then_value
−
| The text source.
+
| The result of the function if the logical test returns a TRUE.
 
|-
 
|-
−
| Index
+
| Otherwise_value
−
| The index to start from.
+
| The result of the function if the logical test returns FALSE.
 
|}
 
|}
  
 
|  
 
|  
−
 
 
|-
 
|-
−
| LEFT
+
| NOT
−
| Returns a selected number of text characters from the left.
+
| Reverses the value of the argument.  
−
{| class="prettytable" cellpadding="10" border="1"
+
|  
−
| '''''Parameter Name'''''
+
−
| '''''Parameter Description'''''
+
−
 
+
 
|-
 
|-
−
| Length
+
| OR
−
| The length.
+
| Returns TRUE if an argument is TRUE.  
−
|}
+
−
 
+
 
|  
 
|  
−
 
 
|-
 
|-
−
| LEN
+
| TRUE
−
| Returns the lengh in characters of the given value.
+
| Returns the logical value TRUE.  
 
|  
 
|  
−
 
 
|-
 
|-
−
| LOWER
+
| XOR
−
| Returns the given text in lower case.
+
| Returns TRUE if a odd number of arguments are TRUE.  
 
|  
 
|  
 +
|}
 +
 +
<br> '''Information'''<br>
  
 +
{| cellpadding="10" border="1" class="prettytable"
 +
|-
 +
| '''''Function Name'''''
 +
| '''''Description'''''
 +
| '''''Example'''''
 +
|-
 +
| CHOOSE
 +
| Selects a value from a list of up to 30 value arguments.
 +
{| cellpadding="10" border="1" class="prettytable"
 
|-
 
|-
−
| MID
 
−
| Returns extracted text, given an original text, starting position, and length.
 
−
{| class="prettytable" cellpadding="10" border="1"
 
 
| '''''Parameter Name'''''  
 
| '''''Parameter Name'''''  
−
| '''''Parameter Description'''''  
+
| '''''Parameter Description'''''
−
 
+
−
|-
+
−
| Start
+
−
| The start index.
+
 
|-
 
|-
−
| Length
+
| value
−
| The length.
+
| Value 1, value 2,... The list of arguments from which a value is chosen.
 
|}
 
|}
  
 
|  
 
|  
−
 
 
|-
 
|-
−
| REPLACE
+
| COUNT
−
| Returns text where an old text is substituted with a new text within the start index and length range.
+
| Counts how many numbers are in the list of arguments.  
−
{| class="prettytable" cellpadding="10" border="1"
+
|  
−
| '''''Parameter Name'''''
+
−
| '''''Parameter Description'''''
+
−
 
+
 
|-
 
|-
−
| Start
+
| COUNTA
−
| The start index.
+
| Counts how many values are in the list of arguments.  
 +
|
 
|-
 
|-
−
| Len
+
| COUNTBLANK
−
| The length.
+
| Counts the blank cells in a specified range.  
 +
|
 
|-
 
|-
−
| New
+
| HASCHANGED
−
| The new text.
+
| Checks whether the columns specified by the given names has changed. Place a column name between double quotes.
−
|}
+
−
 
+
 
|  
 
|  
−
 
 
|-
 
|-
−
| REPT
+
| ISBLANK
−
| Returns text repeated Count times..
+
| Returns TRUE if value refers to an empty cell.  
−
{| class="prettytable" cellpadding="10" border="1"
+
|  
−
| '''''Parameter Name'''''
+
−
| '''''Parameter Description'''''
+
−
 
+
 
|-
 
|-
−
| Count
+
| ISERR
−
| The count.
+
| Returns TRUE if the value is an error value not equal to #N/A.  
−
|}
+
−
 
+
 
|  
 
|  
−
 
 
|-
 
|-
−
| RIGHT
+
| ISERROR
−
| Returns a selected number of text characters from the right.
+
| Returns TRUE if the value is an error value.  
−
{| class="prettytable" cellpadding="10" border="1"
+
|  
−
| '''''Parameter Name'''''
+
−
| '''''Parameter Description'''''
+
−
 
+
 
|-
 
|-
−
| Count
+
| ISEVEN
−
| The count.
+
| Returns TRUE if value is an even integer.  
−
|}
+
−
 
+
 
|  
 
|  
−
 
 
|-
 
|-
−
| SUBSTITUTE
+
| ISLOGICAL
−
| 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.
+
| Returns TRUE if the value carries a logical number format.  
−
{| class="prettytable" cellpadding="10" border="1"
+
|  
−
| '''''Parameter Name'''''
+
−
| '''''Parameter Description'''''
+
−
 
+
 
|-
 
|-
−
| Old
+
| ISNA
−
| The old text.
+
| Returns TRUE if value equals #N/A.  
 +
|
 
|-
 
|-
−
| New
+
| ISNONTEXT
−
| The new text.
+
| Returns TRUE if the value is not text.  
 +
|
 
|-
 
|-
−
| Which
+
| ISNUMBER
−
| The occurrance number.
+
| Returns TRUE if value is a number.  
−
|}
+
−
 
+
 
|  
 
|  
−
 
 
|-
 
|-
−
| T
+
| ISODD
−
| Returns the given text value or a zero lenght string for non text type.
+
| Returns TRUE if value is an odd integer.  
 
|  
 
|  
−
 
 
|-
 
|-
−
| TEXT
+
| ISREF
−
| Returns the given value as text.
+
| Returns TRUE if value is a reference.  
 
|  
 
|  
−
 
 
|-
 
|-
−
| LOWER
+
| ISTEXT
−
| Returns the given text free of leading and trailing spaces. Internal multiple spaces are replaced by one.
+
| Returns TRUE if value is text.  
 
|  
 
|  
 +
|-
 +
| NA
 +
| Not available. Returns the error value #N/A.
 +
|
 +
|}
  
 +
<br> '''User-Defined'''<br>
 +
 +
{| cellpadding="10" border="1" class="prettytable"
 +
|-
 +
| '''''Function Name'''''
 +
| '''''Description'''''
 +
| '''''Example'''''
 
|-
 
|-
−
| UPPER
+
| NULL
−
| Returns the given text in upper case.
+
| Returns a NULL-Value
 
|  
 
|  
 +
|}
  
 +
<br> '''Text'''<br>
 +
 +
{| cellpadding="10" border="1" class="prettytable"
 +
|-
 +
| '''''Function Name'''''
 +
| '''''Description'''''
 +
| '''''Example'''''
 +
|-
 +
| EXACT
 +
| Specifies whether two texts are identical.
 +
{| cellpadding="10" border="1" class="prettytable"
 
|-
 
|-
−
| 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 Name'''''  
 
| '''''Parameter Name'''''  
−
| '''''Parameter Description'''''  
+
| '''''Parameter Description'''''
−
 
+
 
|-
 
|-
−
| Encoding
+
| text_2
−
| The Encoding to be used.
+
| The second text for comparing texts.
 
|}
 
|}
  
 
|  
 
|  
 +
|-
 +
| FIND
 +
| Looks for a string of text within another (case sensitive)
 +
{| cellpadding="10" border="1" class="prettytable"
 +
|-
 +
| '''''Parameter Name'''''
 +
| '''''Parameter Description'''''
 +
|-
 +
| text
 +
| The text in which a search is to be made.
 +
|-
 +
| position
 +
| The position in the text from which the search starts.
 
|}
 
|}
  
−
=== Mathematical ===
 
−
{| class="prettytable" cellpadding="10" border="1"
 
−
| '''''Function Name'''''
 
−
| '''''Description'''''
 
−
| '''''Example '''''
 
−
 
−
|-
 
−
| ABS
 
−
| Returns the absolute (nonnegative) of the value.
 
 
|  
 
|  
−
 
 
|-
 
|-
−
| AVERAGE
+
| LEFT
−
| Average a list of numeric values.
+
| Returns the first character or characters of a text.  
−
|  
+
{| cellpadding="10" border="1" class="prettytable"
−
 
+
 
|-
 
|-
−
| Even
+
| '''''Parameter Name'''''
−
| Returns the rounding a number up to the nearest even integer.
+
| '''''Parameter Description'''''
−
|  
+
|-
 +
| number
 +
| The number of characters for the start text.
 +
|}
  
 +
|
 
|-
 
|-
−
| MAX
+
| LEN
−
| Returns the maximum from a set of numbers.
+
| Calculates length of a text string.  
 
|  
 
|  
−
 
 
|-
 
|-
−
| MIN
+
| LOWER
−
| Returns the minimum from a set of numbers.
+
| Converts text to lowercase.  
 
|  
 
|  
−
 
 
|-
 
|-
−
| MOD
+
| MID
−
| Returns the remainder when one number is divided by another number.
+
| Returns a partial text string of a text.  
−
{| class="prettytable" cellpadding="10" border="1"
+
{| cellpadding="10" border="1" class="prettytable"
 +
|-
 
| '''''Parameter Name'''''  
 
| '''''Parameter Name'''''  
−
| '''''Parameter Description'''''  
+
| '''''Parameter Description'''''
−
 
+
−
|-
+
−
| Divisor
+
−
| A divisor value.
+
 
|-
 
|-
 +
| start
 +
| The position from which the part word is to be determined.
 
|-
 
|-
 +
| number
 +
| The number of characters for the text.
 +
|}
 +
 +
|
 
|-
 
|-
 +
| REPLACE
 +
| Replaces characters within a text string with a different text string.
 +
{| cellpadding="10" border="1" class="prettytable"
 
|-
 
|-
 +
| '''''Parameter Name'''''
 +
| '''''Parameter Description'''''
 
|-
 
|-
 +
| position
 +
| The character position from which text is to be replaced.
 
|-
 
|-
 +
| length
 +
| The number of characters to be replaced.
 
|-
 
|-
 +
| new text
 +
| The text to be inserted.
 +
|}
 +
 +
|
 
|-
 
|-
 +
| REPT
 +
| Repeats text a given number of times.
 +
{| cellpadding="10" border="1" class="prettytable"
 
|-
 
|-
 +
| '''''Parameter Name'''''
 +
| '''''Parameter Description'''''
 
|-
 
|-
 +
| number
 +
| The number of times the text is to be repeated.
 
|}
 
|}
  
 
|  
 
|  
−
 
 
|-
 
|-
−
| ODD
+
| RIGHT
−
| Returns the rounding a number up to the nearest odd integer.
+
| Returns the last character or characters of a text.  
−
|  
+
{| cellpadding="10" border="1" class="prettytable"
−
 
+
 
|-
 
|-
−
| SUM
+
| '''''Parameter Name'''''
−
| Sum a list of numeric values.
+
| '''''Parameter Description'''''
−
|  
+
|-
 +
| number
 +
| The number of characters for the end text.
 
|}
 
|}
  
−
=== Logical ===
 
−
{| class="prettytable" cellpadding="10" border="1"
 
−
| '''''Function Name'''''
 
−
| '''''Description'''''
 
−
| '''''Example '''''
 
−
 
−
|-
 
−
| AND
 
−
| Logical AND
 
 
|  
 
|  
−
 
 
|-
 
|-
−
| FALSE
+
| SUBSTITUTE
−
| Logical FALSE
+
| Substitutes new text for old text in a string.
−
|  
+
{| cellpadding="10" border="1" class="prettytable"
−
 
+
 
|-
 
|-
−
| IF
 
−
| Conditional execution
 
−
{| class="prettytable" cellpadding="10" border="1"
 
 
| '''''Parameter Name'''''  
 
| '''''Parameter Name'''''  
−
| '''''Parameter Description'''''  
+
| '''''Parameter Description'''''
−
 
+
|-
 +
| search_text
 +
| The partial string to be (repeatedly) replaced.
 
|-
 
|-
−
| A term that is evaluated if the condition evaluates to true.
+
| new text
−
| True-Term
+
| The text which is to replace the text string.
 
|-
 
|-
−
| A term that is evaluated if the condition evaluates to false.
+
| occurrence
−
| False-Term
+
| Which occurence of the old text is to be replaced.
 
|}
 
|}
  
 
|  
 
|  
−
 
 
|-
 
|-
−
| AND
+
| T
−
| Logical AND
+
| Converts a value into text.
 
|  
 
|  
−
 
 
|-
 
|-
−
| OR
+
| TEXT
−
| Logical OR
+
| Converts a number to text according to a given format.
 
|  
 
|  
−
 
 
|-
 
|-
−
| TRUE
+
| TRIM
−
| Logical TRUE
+
| Removes extra spaces from text.
 
|  
 
|  
−
 
 
|-
 
|-
−
| XOR
+
| UNICHAR
−
| Logical XOR
+
| Converts a code number into a Unicode character or letter.
 
|  
 
|  
 +
|-
 +
| UNICODE
 +
| Returns the numeric code for the first Unicode character in a text string.
 +
|
 +
|-
 +
| UPPER
 +
| Converts text to uppercase.
 +
|
 +
|-
 +
| 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.
 +
{| cellpadding="10" border="1" class="prettytable"
 +
|-
 +
| '''''Parameter Name'''''
 +
| '''''Parameter Description'''''
 +
|-
 +
| Encoding
 +
| The Encoding to be used.
 
|}
 
|}
−
<br>
 
−
''Code to get the function form the libformula jar file
 
−
<source lang="java">
 
−
import java.util.Locale;
 
−
import org.jfree.formula.DefaultFormulaContext;
 
  
−
/*
+
|
−
* To change this template, choose Tools | Templates
+
|}
−
* and open the template in the editor.
+
−
*/
+
−
import org.jfree.formula.function.FunctionCategory;
+
−
import org.jfree.formula.function.FunctionDescription;
+
−
import org.jfree.formula.function.FunctionRegistry;
+
  
−
/**
+
CONCAT or CONCATENATE functions not supported, but you can use [Textfieldname]&" "&[Textfieldname] to concatenate text fields.
−
*
+
−
* @author Ocke Janssen
+
−
*/
+
−
public class NewMain {
+
  
−
    /**
+
<br> '''Rounding'''<br>  
−
    * @param args the command line arguments
+
−
    */
+
−
    public static void main(String[] args) {
+
−
        DefaultFormulaContext obj = new DefaultFormulaContext();
+
−
        FunctionRegistry func = obj.getFunctionRegistry();
+
−
        FunctionCategory[] categories = func.getCategories();
+
−
        for ( int i = 0 ; i < categories.length;++i)
+
−
        {
+
−
            String display = categories[i].getDisplayName(Locale.ENGLISH);
+
−
            System.out.println( "'''" + display +"'''<br>");
+
−
            System.out.println( "{| class=\"prettytable\" cellpadding=\"10\" border=\"1\"");
+
−
            System.out.println( "| '''''Function Name'''''");
+
−
            System.out.println( "| '''''Description''''' ");
+
−
            System.out.println( "| '''''Example '''''");
+
−
           
+
−
            String[] functions = func.getFunctionNamesByCategory(categories[i]);
+
−
            for(int j= 0; j < functions.length;++j)
+
−
            {
+
−
                FunctionDescription desc = func.getMetaData(functions[j]);
+
−
                System.out.println( "");
+
−
                System.out.println( "|-");
+
−
                System.out.println("| "+ desc.getDisplayName(Locale.ENGLISH));
+
−
                System.out.println("| "+ desc.getDescription(Locale.ENGLISH));
+
−
                int count = desc.getParameterCount();
+
−
                if ( count > 1 ){
+
−
                    System.out.println( "{| class=\"prettytable\" cellpadding=\"10\" border=\"1\"");
+
−
                    System.out.println( "| '''''Parameter Name''''' ");
+
−
                    System.out.println( "| '''''Parameter Description''''' ");
+
−
                    System.out.println( "");
+
−
                }
+
−
                for(int k= 1;k < count;++k){
+
−
                    try{
+
−
                        System.out.println( "|-");
+
−
                        System.out.println("| " + desc.getParameterDisplayName(k,Locale.ENGLISH) );
+
−
                        System.out.println("| " + desc.getParameterDescription(k,Locale.ENGLISH) );
+
−
                    } catch(Exception e){
+
−
                    }
+
−
                }
+
−
                if ( count > 1 ){
+
−
                    System.out.println("|}");
+
−
                    System.out.println("");
+
−
                }                   
+
−
               
+
−
                System.out.println("| ");
+
−
            }
+
−
            System.out.println("|}");
+
−
            System.out.println("<br>");
+
−
        }
+
−
    }
+
  
−
}
+
{| cellpadding="10" border="1" class="prettytable"
−
</source>
+
|-
 +
| '''''Function Name'''''
 +
| '''''Description'''''
 +
| '''''Example'''''
 +
|-
 +
| INT
 +
| Rounds a number down to the nearest integer.
 +
|
 +
|}
  
−
 
+
<br>
−
[[Category: Database]]
+
[[Category:Database]] [[Category:Extensions]]
−
[[Category: Base Documentation]]
+

Latest revision as of 11:50, 11 May 2010

There are documents also in DE - FR - ES -PT


Date/Time

Function Name Description Example
DATE Provides an internal number for the date given.
Parameter Name Parameter Description
month An integer between 1 and 12 representing the month.
day An integer between 1 and 31 representing the day of the month.
DATEDIF Returns the number of years, months, or days between two dates.
Parameter Name Parameter Description
EndDate Second date.
Format Format code.
DATEVALUE Returns an internal number for a text having a possible date format.
DAY Returns the sequential date of the month as an integer (1-31) in relation to the date value.
DAYS Calculates the number of days between two dates.
Parameter Name Parameter Description
Date_1 The start date for calculating the difference in days.
HOUR Determines the sequential number of the hour of the day (0-23) for the time value.
MINUTE Determines the sequential number for the minute of the hour (0-59) for the time value.
MONTH Determines the sequential number of a month of the year (1-12) for the date value.
NOW Determines the current time of the computer.
SECOND Determines the sequential number of the second of a minute (0-59) for the time value.
TIME Determines a time value from the details for hour, minute and second.
Parameter Name Parameter Description
minute The integer for the minute.
second The integer for the second.
TIMEVALUE Returns a sequential number for a text shown in a possible time entry format.
TODAY Determines the current date of the computer.
WEEKDAY Returns the day of the week for the date value as an integer (1-7).
Parameter Name Parameter Description
Type Fixes the beginning of the week and the type of calculation to be used.(1 = Sunday is the first day of the week, with value 1; Saturday has value 7, 2 = Monday is the first day of the week, with value 1; Sunday has value 7, 3 = Monday is the first day of the week, with value 0; Sunday has value 6)
YEAR Returns the year of a date value as an integer.


Mathematical

Function Name Description Example
ABS Absolute value of a number.
AVERAGE Returns the average of a sample.
AVERAGE Returns the average of a sample.
EVEN Rounds a positive number up and negative number down to the nearest even integer.
MAX Returns the maximum value in a list of arguments.
MAXA Returns the maximum value in a list of arguments. Text is evaluated as zero.
MIN Returns the minimum value in a list of arguments.
MINA Returns the smallest value in a list of arguments. Text is evaluated as zero.
MOD Calculates the remainder of a division.
Parameter Name Parameter Description
Divisor The number by which the dividend is divided.
ODD Rounds a positive number up and negative number down to the nearest odd integer.
SUM Returns the sum of all arguments.


Logical

Function Name Description Example
AND Returns TRUE if all arguments are TRUE.
FALSE Defines the logical value as FALSE.
IF Specifies a logical test to be performed.
Parameter Name Parameter Description
Then_value The result of the function if the logical test returns a TRUE.
Otherwise_value The result of the function if the logical test returns FALSE.
NOT Reverses the value of the argument.
OR Returns TRUE if an argument is TRUE.
TRUE Returns the logical value TRUE.
XOR Returns TRUE if a odd number of arguments are TRUE.


Information

Function Name Description Example
CHOOSE Selects a value from a list of up to 30 value arguments.
Parameter Name Parameter Description
value Value 1, value 2,... The list of arguments from which a value is chosen.
COUNT Counts how many numbers are in the list of arguments.
COUNTA Counts how many values are in the list of arguments.
COUNTBLANK Counts the blank cells in a specified range.
HASCHANGED Checks whether the columns specified by the given names has changed. Place a column name between double quotes.
ISBLANK Returns TRUE if value refers to an empty cell.
ISERR Returns TRUE if the value is an error value not equal to #N/A.
ISERROR Returns TRUE if the value is an error value.
ISEVEN Returns TRUE if value is an even integer.
ISLOGICAL Returns TRUE if the value carries a logical number format.
ISNA Returns TRUE if value equals #N/A.
ISNONTEXT Returns TRUE if the value is not text.
ISNUMBER Returns TRUE if value is a number.
ISODD Returns TRUE if value is an odd integer.
ISREF Returns TRUE if value is a reference.
ISTEXT Returns TRUE if value is text.
NA Not available. Returns the error value #N/A.


User-Defined

Function Name Description Example
NULL Returns a NULL-Value


Text

Function Name Description Example
EXACT Specifies whether two texts are identical.
Parameter Name Parameter Description
text_2 The second text for comparing texts.
FIND Looks for a string of text within another (case sensitive)
Parameter Name Parameter Description
text The text in which a search is to be made.
position The position in the text from which the search starts.
LEFT Returns the first character or characters of a text.
Parameter Name Parameter Description
number The number of characters for the start text.
LEN Calculates length of a text string.
LOWER Converts text to lowercase.
MID Returns a partial text string of a text.
Parameter Name Parameter Description
start The position from which the part word is to be determined.
number The number of characters for the text.
REPLACE Replaces characters within a text string with a different text string.
Parameter Name Parameter Description
position The character position from which text is to be replaced.
length The number of characters to be replaced.
new text The text to be inserted.
REPT Repeats text a given number of times.
Parameter Name Parameter Description
number The number of times the text is to be repeated.
RIGHT Returns the last character or characters of a text.
Parameter Name Parameter Description
number The number of characters for the end text.
SUBSTITUTE Substitutes new text for old text in a string.
Parameter Name Parameter Description
search_text The partial string to be (repeatedly) replaced.
new text The text which is to replace the text string.
occurrence Which occurence of the old text is to be replaced.
T Converts a value into text.
TEXT Converts a number to text according to a given format.
TRIM Removes extra spaces from text.
UNICHAR Converts a code number into a Unicode character or letter.
UNICODE Returns the numeric code for the first Unicode character in a text string.
UPPER Converts text to uppercase.
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.
Parameter Name Parameter Description
Encoding The Encoding to be used.

CONCAT or CONCATENATE functions not supported, but you can use [Textfieldname]&" "&[Textfieldname] to concatenate text fields.


Rounding

Function Name Description Example
INT Rounds a number down to the nearest integer.


Retrieved from "https://wiki.openoffice.org/w/index.php?title=SUN_Report_Builder/Functions&oldid=167078"
Personal tools
In other languages