Changes

Jump to: navigation, search

Expressions

663 bytes added, 13:36, 2 April 2014
Marked this version for translation
<translate>
<!--T:1-->
Expressions allows to manually create and edit [[Filters]] rules by using programming language.
<!--T:2-->
'''Important''': After manually editing the expression, the regular operators can not be used until you ''Clear All'' the filters;
<!--T:3-->
__TOC__
== Basic Expression Structures ==<!--T:4-->
=== Value Operands ===<!--T:5-->
<!--T:6-->
The value operands are values from a [[Columns Data Type|data type]] that are used in expressions as variables.
==== Value type operand ====<!--T:7-->
Are numeric values of the float type (Real numbers domain). These values allow the use of a integer and a fraction part, separated by the dot (.) character (decimal separator).
'''Examples''': 1, 1.05, 2.55;
==== Text type operand ====<!--T:8-->
Are literal string data operands. These values allow the use of characters chain fields (strings), being delimited by the simple quote (') character.
'''Examples''': 'John Snow', 'California', 'Spaghetti';
==== Date type operand ====<!--T:9-->
Are values that express any date. It is possible to determine a date representing it as a string, being delimited by the simple quote (') character and separated by the bar (/) character. The default supported format is "dd/MM/yyyy".
'''Examples''': '01/01/2011', '29/02/2000';
==== Boolean type operand ====<!--T:10-->
Are values from the ''true'' or ''false'' kind. Usually used to validate or not a condition.
'''Examples''': true e false;
==== Identifier type operand ====<!--T:11-->
Are values that represents a field or variable in the expression. Used to make reference to data source columns, delimited by double quotes (").
'''Examples''': "City.City", "Product.Product";
==== Parenthesis ====<!--T:12-->
Used to group and separate expressions parts. Expressions inside parenthesis are processed first.
'''Examples''': ("Profit" / "Total Price" ) + 10
==== System variable type operand ====<!--T:13-->
Are system pre-defined variables. These values are replaced in run-time by pre-determined values, delimited by double quotes (") and preceded by star (#). By now only one variable is available: "#null" that indicates null values or fields.
=== Arithmetic Expressions ===<!--T:14-->
<!--T:15-->
The arithmetic expressions relate two operands (value or another expression) to compose a sum, subtraction, multiplication or division.
==== Sum (+) ====<!--T:16-->
Sum two operands. Represented by the sum (+) character.
Syntax: ''<operand/expression> + <operand/expression>''.
'''Examples''': "Taxes" + "Commissions";
==== Subtraction (-) ====<!--T:17-->
Subtract two operands. Represented by the subtract or hyphen (-) character.
Syntax: ''<operand/expression> - <operand/expression>''.
'''Examples''': "Gross Sale" - "Taxes";
==== Multiplication (*) ====<!--T:18-->
Multiplicate two operands. Represented by the multiplication or star (*) character.
Syntax: ''<operand/expression> * <operand/expression>''.
'''Examples''': "Amount" * "Unit Price";
==== Division(/) ====<!--T:19-->
Divides two operands. Represented by the divide or bar (/) character.
Syntax: ''<operand/expression> / <operand/expression>''.
=== Relational Expressions ===<!--T:20-->
<!--T:21-->
The relational expressions compare two operands (value or another expression) two evaluate if a condition is ''true'' or ''false''. Usually used with decision functions, like the ''IF''.
==== Equal (==) ====<!--T:22-->
Performs the equal comparison expression between two operands. Represented by the equal operator (==).
Syntax: ''<expression> == <expression>''.
'''Examples''': "Unit Price" == "Total Price";
==== Different (!=) ====<!--T:23-->
Performs the different comparison expression between two operands. Represented by the different operator (!=).
Syntax: ''<expression> != <expression>''.
'''Examples''': "City.City" != 'New York';
==== Greater than (>) ====<!--T:24-->
Return ''true'' if the the first expression is greater than the second expression and ''false'' otherwise. Represented by the greater operator (>).
Syntax: ''<expression> > <expression>''.
'''Examples''': "Order Date" > '01/01/2011';
==== Greater or equal than (>=) ====<!--T:25-->
Return ''true'' if the the first expression is greater than or equal to the second expression and ''false'' otherwise. Represented by the greater or equal operator (>=).
Syntax: ''<expression> >= <expression>''.
'''Examples''': IF("Order Date" >= '01/01/2011';"Order Date";0);
==== Lesser than (<) ====<!--T:26-->
Return ''true'' if the the first expression is lesser than the second expression and ''false'' otherwise. Represented by the lesser operator (<).
Syntax: ''<expression> < <expression>''.
'''Examples''': "Profit" < '0';
==== Lesser or equal than (<=) ====<!--T:27-->
Return ''true'' if the the first expression is lesser than or equal to the second expression and ''false'' otherwise. Represented by the lesser or equal operator (<=).
Syntax: ''<expression> <= <expression>''.
=== Logical Expressions ===<!--T:28-->
<!--T:29-->
The logical expressions group two operands (boolean type or another expression) to compose a logic expression, with the objective to evaluate two boolean operands relation into a ''true'' or ''false'' result. Usually used with decision functions, like the ''IF'' and with relational expressions.
==== And (&&) ====<!--T:30-->
Performs the logical operation ''AND'' between two boolean values. The two operands must be ''true'' for the result of the operation to be ''true''. Represented by the ''AND'' operator (&&).
Syntax: ''<expression> && <expression>''.
'''Examples''': IF((Gross Sales > '0') && (Seller == 'John Snow');'Sold';'Not Sold'), IF((City!="#null") && (Date<DAY_FROM_TODAY(0));1;0);
==== Or (||) ====<!--T:31-->
Performs the logical operation ''OR'' between two boolean values. One of the two operands must be ''true'' for the result of the operation to be ''true''. Represented by the ''OR'' operator (||).
Syntax: ''<expression> || <expression>''.
'''Examples''': IF((Gross Sales > '0') || (Sold == 'true');'Sold';'Not Sold'), IF((City!="#null") || (Date<DAY_FROM_TODAY(0));1;0);
==== Not (!) ====<!--T:32-->
Performs the denial logical operation for a boolean value. If the operand are ''true'' the ''NOT'' convert it to ''false'' (and the other way around). Represented by the ''NOT'' operator (!).
Syntax: ''! <expression>''.
== Auxiliary Functions ==<!--T:33-->
=== Basic Functions ===<!--T:34-->
<!--T:35-->
The basic functions are system default functions and implements useful functionalities.
==== Abs ====<!--T:36-->
Returns the absolute value of a base value.
Syntax: ''ABS(<expression>)''. Accept one parameter and process a numeric data type.
'''Examples''': ABS(Gross Sale-Taxes);
==== Avg ====<!--T:37-->
Returns the average value of an array of values.
Syntax: ''AVG(<expression1>;<expression2>[;<expression3>;...;<expressionN>])''. Accept multiple parameter and process a numeric data type.
'''Examples''': AVG(Taxes;Commissions;Costs);
==== Between ====<!--T:38-->
Check if a value is inside the boundaries of the parameters values.
Syntax: ''BETWEEN(<expression_to_test>;<expression_bottom_limit>;<expression_top_limit>)''. Need three parameters (of any data type, but
'''Examples''': BETWEEN("Date";'01/01/2013';'31/12/2013'), BETWEEN("Gross Sales";'0';'1000.00');
==== If then else ====<!--T:39-->
Tests a boolean expression and returns a value in case it is ''true'' and another in case it is ''false''.
Syntax: ''IF(<expression_test>;<expression_for_true>;<expression_for_false>)''. Need three parameters, a boolean for test and returns any
IF("Profit"==0;0;Profit+Taxes);
==== Log ====<!--T:40-->
Returns the log value of a number on a set base.
Syntax: ''LOG(<expression_number>[;<expression_base>])''. Minimum one parameter and maximum two. If just one parameters is given, the
'''Examples''': LOG(Profit);
==== Max ====<!--T:41-->
Returns the greater value between two numbers.
Syntax: ''MAX(<expression_value1>;<expression_value2>)''. Need two value parameters and returns a value data type.
'''Examples''': "Total Value"/MAX("Quantity";"1");
==== Min ====<!--T:42-->
Returns the smaller value between two numbers.
Syntax: ''MIN(<expression_value1>;<expression_value2>)''. Need two value parameters and returns a value data type.
'''Examples''': "Total Value"/MIN("Quantity";"1");
==== Pow ====<!--T:43-->
Returns the power value of a number on a set exponent.
Syntax: ''POW(<expression_number>[;<expression_exponent>])''. Minimum one parameter and maximum two. If the exponent value is not given,
'''Examples''': POW(Value1)+POW(Value1-Value2;3);
==== Random ====<!--T:44-->
Returns a aleatory number inside the boundaries of the limit values.
Syntax: ''RANDOM(<expression_bottom_limit>;<expression_top_limit>)''. Need two parameters, the bottom and the upper limit of the random
'''Examples''': RANDOM(0.0;1.0);
==== Sqrt ====<!--T:45-->
Returns the square root of a value.
Syntax: ''SQRT(<expression>)''. Need one parameters, the value to be calculated.
=== Date Functions ===<!--T:46-->
<!--T:47-->
The date functions are operations that use as parameters and return result of the [[Date|date data type]].
==== Constants list ====<!--T:48-->
** '''0''': DATE_FIELD_YEAR (Year part);
** '''1''': DATE_FIELD_MONTH (Month part);
==== Date part ====<!--T:49-->
Return a part of a date.
Syntax: ''DATE_PART(<expression_date>;<constant>)''. Need two parameters, the first is the reference date and the second the constant
'''Examples''': DATE_PART("Order Date";0) - returns the year part of the "Order Date";
==== Day from today ====<!--T:50-->
Return a backward (negative) or forward (positive) date counting from today.
Syntax: ''DAY_FROM_TODAY(<expression_number_days>)''. Need one parameter, the number of days to add or subtract.
'''Examples''': DAY_FROM_TODAY(-1) - returns the yesterday date;
==== First day of ====<!--T:51-->
Return the first day of a grouping. This function have two variations:
* '''First way''':
'''Examples''': FIRST_DAY_OF(1;0;-1) - first day of the current month (1) from last year (0;-1);
==== Last day of ====<!--T:52-->
Return the last day of a grouping. This function have two variations:
* '''First way''':
'''Examples''': LAST_DAY_OF(1;0;-1) - last day of the current month (1) from last year (0;-1);
==== New date ====<!--T:53-->
Create an object from a day, month and year.
Syntax: ''NEW_DATE(<expression_day>;<expression_month>;<expression_year>)''. Need three parameters, the first is a valid day number (1 to
"Order Date" column;
==== Num of days ====<!--T:54-->
Return the number of days between two dates.
Syntax: ''NUM_OF_DAYS(<expression_date1>;<expression_date2>)''. Need two date data type parameters.
column;
==== Num of months ====<!--T:55-->
Return the number of months between two dates.
Syntax: ''NUM_OF_MONTHS(<expression_date1>;<expression_date2>)''. Need two date data type parameters.
column and the current month of the "Date" column;
==== Previous date ====<!--T:56-->
Return the closest exact previous date given a day and month.
Syntax: ''PREVIOUS_DATE(<expression_day>;<expression_month>)''. Need two parameters, the first is the day of month and the second the

Navigation menu