Difference between revisions of "DCS evaluateWhereExpression"
(→DCS_evaluateWhereExpression) (Tag: visualeditor) |
|||
(4 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | =DCS_evaluateWhereExpression = | + | = DCS_evaluateWhereExpression = |
[[Category:Data_Cache_Functions]] | [[Category:Data_Cache_Functions]] | ||
+ | __NOTOC__ | ||
− | Evaluate a WHERE expression | + | Evaluate a WHERE expression. See also [[DCS evaluateWhereExpressions]] for faster evalution of multiple expressions. |
− | === Syntax === | + | This function is an alias to EvalWhere in [[DataCacheSpecification class]]. |
+ | |||
+ | === Syntax === | ||
DCS_evaluateWhereExpression(whereExpression) | DCS_evaluateWhereExpression(whereExpression) | ||
− | === Arguments === | + | === Arguments === |
*whereExpression: is string. ex: "selectColumn(Id) where true;" | *whereExpression: is string. ex: "selectColumn(Id) where true;" | ||
− | === Return value === | + | === Return value === |
Execute the where expression and return an object depending on where expression: | Execute the where expression and return an object depending on where expression: | ||
− | {| | + | {| class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101" width="438" cellpadding="2" border="1" |
|- valign="top" align="left" | |- valign="top" align="left" | ||
− | | width="216" bgcolor="#C0C0C0 | + | | style="border: 1px solid #010101" width="216" bgcolor="#C0C0C0" | |
'''WhereExpression''' | '''WhereExpression''' | ||
− | | width="222" bgcolor="#C0C0C0 | + | | style="border: 1px solid #010101" width="222" bgcolor="#C0C0C0" | |
'''Return type''' | '''Return type''' | ||
|- valign="top" align="left" | |- valign="top" align="left" | ||
− | | | + | | style="border: 1px solid #010101" width="216" | |
average | average | ||
− | | | + | | style="border: 1px solid #010101" width="222" | |
empty | empty | ||
|- valign="top" align="left" | |- valign="top" align="left" | ||
− | | | + | | style="border: 1px solid #010101" width="216" | |
count | count | ||
− | | | + | | style="border: 1px solid #010101" width="222" | |
number | number | ||
|- valign="top" align="left" | |- valign="top" align="left" | ||
− | | | + | | style="border: 1px solid #010101" width="216" | |
max | max | ||
− | | | + | | style="border: 1px solid #010101" width="222" | |
number | number | ||
|- valign="top" align="left" | |- valign="top" align="left" | ||
− | | | + | | style="border: 1px solid #010101" width="216" | |
median | median | ||
− | | | + | | style="border: 1px solid #010101" width="222" | |
number | number | ||
|- valign="top" align="left" | |- valign="top" align="left" | ||
− | | | + | | style="border: 1px solid #010101" width="216" | |
min | min | ||
− | | | + | | style="border: 1px solid #010101" width="222" | |
number | number | ||
|- valign="top" align="left" | |- valign="top" align="left" | ||
− | | | + | | style="border: 1px solid #010101" width="216" | |
percentile | percentile | ||
− | | | + | | style="border: 1px solid #010101" width="222" | |
number | number | ||
|- valign="top" align="left" | |- valign="top" align="left" | ||
− | | | + | | style="border: 1px solid #010101" width="216" | |
quantile | quantile | ||
− | | | + | | style="border: 1px solid #010101" width="222" | |
number | number | ||
|- valign="top" align="left" | |- valign="top" align="left" | ||
− | | | + | | style="border: 1px solid #010101" width="216" | |
select | select | ||
− | | | + | | style="border: 1px solid #010101" width="222" | |
empty | empty | ||
|- valign="top" align="left" | |- valign="top" align="left" | ||
− | | | + | | style="border: 1px solid #010101" width="216" | |
selectColumn | selectColumn | ||
− | | | + | | style="border: 1px solid #010101" width="222" | |
array | array | ||
|- valign="top" align="left" | |- valign="top" align="left" | ||
− | | | + | | style="border: 1px solid #010101" width="216" | |
stdev | stdev | ||
− | | | + | | style="border: 1px solid #010101" width="222" | |
number | number | ||
|- valign="top" align="left" | |- valign="top" align="left" | ||
− | | | + | | style="border: 1px solid #010101" width="216" | |
sterr | sterr | ||
− | | | + | | style="border: 1px solid #010101" width="222" | |
number | number | ||
|- valign="top" align="left" | |- valign="top" align="left" | ||
− | | | + | | style="border: 1px solid #010101" width="216" | |
sum | sum | ||
− | | | + | | style="border: 1px solid #010101" width="222" | |
number | number | ||
|- valign="top" align="left" | |- valign="top" align="left" | ||
− | | | + | | style="border: 1px solid #010101" width="216" | |
variance | variance | ||
− | | | + | | style="border: 1px solid #010101" width="222" | |
number | number | ||
+ | |} | ||
− | === Example === | + | ===== Example ===== |
− | |||
− | |||
− | number | + | ''number dcsResourceId1 = DCS_getCurrentDcsResourceId(); '' |
− | + | ''number dcsResourceId2 = 123456; '' | |
− | string | + | ''string expression1 = "average(Single2) where true;"; '' |
− | + | ''string expression2 = "min(Single2) where true;"; '' | |
− | + | ''DCS_use(dcsResourceId2); '' | |
− | print(DCS_evaluateWhereExpression( | + | ''print(DCS_evaluateWhereExpression(expression1)); //return average value of question Single2 '' |
− | + | ''print(DCS_evaluateWhereExpression(expression2)); //return minimum value of question Single2 '' |
Latest revision as of 09:57, 5 December 2018
DCS_evaluateWhereExpression
Evaluate a WHERE expression. See also DCS evaluateWhereExpressions for faster evalution of multiple expressions.
This function is an alias to EvalWhere in DataCacheSpecification class.
Syntax
DCS_evaluateWhereExpression(whereExpression)
Arguments
- whereExpression: is string. ex: "selectColumn(Id) where true;"
Return value
Execute the where expression and return an object depending on where expression:
WhereExpression |
Return type |
average |
empty |
count |
number |
max |
number |
median |
number |
min |
number |
percentile |
number |
quantile |
number |
select |
empty |
selectColumn |
array |
stdev |
number |
sterr |
number |
sum |
number |
variance |
number |
Example
number dcsResourceId1 = DCS_getCurrentDcsResourceId();
number dcsResourceId2 = 123456;
string expression1 = "average(Single2) where true;";
string expression2 = "min(Single2) where true;";
DCS_use(dcsResourceId2);
print(DCS_evaluateWhereExpression(expression1)); //return average value of question Single2
print(DCS_evaluateWhereExpression(expression2)); //return minimum value of question Single2