Catglobe Wiki - User contributions [en]

File:Fullrow.PNG

2016-02-03T06:51:21Z

Phamminhlap:

File:Fullcolumn2.PNG

2016-02-03T06:47:44Z

Phamminhlap:

File:Fullcolumn.PNG

2016-02-03T06:43:48Z

Phamminhlap:

QcsCustomColumn class

2015-12-23T07:08:58Z

Phamminhlap: Created page with "{{CGscriptClass_Template |Name=QcsCustomColumn |Description=Represents a data cache specification column with data calculated from script. |Constructors= {{CGscriptConstructor..."

{{CGscriptClass_Template
|Name=QcsCustomColumn
|Description=Represents a data cache specification column with data calculated from script.
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=name|Description=Set column name.|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=dataType|Description=Set the data type the script will return (notice this is CgScript type, not DCS type)|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isFullColumn|Description=Does the script evaluate the whole column at a time or not|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=dcs|Description=Dcs the column should belong to}}
|Description=Create a new boolean column true if the user for a row belongs to the given group.}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=Delete|Description=Remove column from the dcs}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=Save|Description=Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=CgScript|HasGetter=1|HasSetter=1|Description=Get/set the cgscript for the column}}
{{CGscriptProperties_Template|ReturnType=string|Name=ColumnType|HasGetter=1|Description=Get the source type of the column data}}
{{CGscriptProperties_Template|ReturnType=string|Name=DataType|HasGetter=1|Description=Get the data type of the column}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IsFullColumn|HasGetter=1|Description=Does the script evaluate the whole column at a time or not}}
{{CGscriptProperties_Template|ReturnType=string|Name=Name|HasGetter=1|HasSetter=1|Description=Get/set the name of the column}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=bool|Name=PresentAsText|HasGetter=1|HasSetter=1|Description=Get/set if Show the data column as the option text}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

QcsQuestionColumn class

2015-12-18T10:49:24Z

Phamminhlap:

{{CGscriptClass_Template
|Name=QcsQuestionColumn
|Description=Represents a data cache specification column with data from collected questions.
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=Delete|Description=Remove column from the dcs}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=Save|Description=Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=number|Name=AnswerOptionIndex|HasGetter=1|Description=Get which answer option is used for this column. -1 if not from answer option.}}
{{CGscriptProperties_Template|ReturnType=string|Name=CgScript|HasGetter=1|HasSetter=1|Description=Get/set the cgscript for the column}}
{{CGscriptProperties_Template|ReturnType=string|Name=ColumnType|HasGetter=1|Description=Get the source type of the column data}}
{{CGscriptProperties_Template|ReturnType=string|Name=DataType|HasGetter=1|Description=Get the data type of the column}}
{{CGscriptProperties_Template|ReturnType=string|Name=Name|HasGetter=1|HasSetter=1|Description=Get/set the name of the column}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=bool|Name=OpenPart|HasGetter=1|Description=Get if this column is the open part of the question.}}
{{CGscriptProperties_Template|ReturnType=bool|Name=PresentAsText|HasGetter=1|HasSetter=1|Description=Get/set if Show the data column as the option text}}
{{CGscriptProperties_Template|ReturnType=string|Name=QuestionLabel|HasGetter=1|Description=Get the questionlabel used for getting data for this column.}}
{{CGscriptProperties_Template|ReturnType=number|Name=QuestionnaireResourceId|HasGetter=1|Description=Get the questionnaire used for getting data for this column.}}
{{CGscriptProperties_Template|ReturnType=number|Name=SubQuestionIndex|HasGetter=1|Description=Get which sub question is used for this column. -1 if not from subquestion.}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

=== '''Examples''' ===

'''Ex1:'''

<source lang="javascript">
DataCacheSpecification dcs = new DataCacheSpecification(15517146);

array aQcsQuestionColumns = dcs.CreateAllColumnsForQuestion("Q1",0); //Create new column(s) for a question and use primary questionnaire

for(number i= 0; i < aQcsQuestionColumns.Count; i++){
aQcsQuestionColumns[i].Save();
}
dcs.Save(); //Must save to make the above statements applied on DCS, but this statement does not REBUILD the DCS
print(dcs.ColumnNames);
</source>

QcsQuestionColumn class

2015-12-18T10:47:30Z

Phamminhlap:

{{CGscriptClass_Template
|Name=QcsQuestionColumn
|Description=Represents a data cache specification column with data from collected questions.
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=Delete|Description=Remove column from the dcs}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=Save|Description=Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=number|Name=AnswerOptionIndex|HasGetter=1|Description=Get which answer option is used for this column. -1 if not from answer option.}}
{{CGscriptProperties_Template|ReturnType=string|Name=CgScript|HasGetter=1|HasSetter=1|Description=Get/set the cgscript for the column}}
{{CGscriptProperties_Template|ReturnType=string|Name=ColumnType|HasGetter=1|Description=Get the source type of the column data}}
{{CGscriptProperties_Template|ReturnType=string|Name=DataType|HasGetter=1|Description=Get the data type of the column}}
{{CGscriptProperties_Template|ReturnType=string|Name=Name|HasGetter=1|HasSetter=1|Description=Get/set the name of the column}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=bool|Name=OpenPart|HasGetter=1|Description=Get if this column is the open part of the question.}}
{{CGscriptProperties_Template|ReturnType=bool|Name=PresentAsText|HasGetter=1|HasSetter=1|Description=Get/set if Show the data column as the option text}}
{{CGscriptProperties_Template|ReturnType=string|Name=QuestionLabel|HasGetter=1|Description=Get the questionlabel used for getting data for this column.}}
{{CGscriptProperties_Template|ReturnType=number|Name=QuestionnaireResourceId|HasGetter=1|Description=Get the questionnaire used for getting data for this column.}}
{{CGscriptProperties_Template|ReturnType=number|Name=SubQuestionIndex|HasGetter=1|Description=Get which sub question is used for this column. -1 if not from subquestion.}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

=== '''Examples''' ===

'''Ex1:'''

<source lang="javascript">
DataCacheSpecification dcs = new DataCacheSpecification(15517146);

array questionColumns = dcs.CreateAllColumnsForQuestion("Q1",0); //Create new column(s) for a question and use primary questionnaire

for(number i= 0; i < questionColumns.Count; i++){
questionColumns[i].Save();
}
dcs.Save(); //Must save to make the above statements applied on DCS, but this statement does not REBUILD the DCS
print(dcs.ColumnNames);
</source>

DataCacheSpecification class

2015-12-18T10:37:54Z

Phamminhlap:

{{CGscriptClass_Template
|Name=DataCacheSpecification
|Description=Represents a DataCache specification.
|Constructors=
{{CGscriptConstructors_Template|Description=Instanciate a new instance using the current context datacache}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=number|Name=ResourceId|Description=Resource Id of the DataCache}}
|Description=Instanciate a new instance using the resource id of a datacache}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=ResourceName|Description=Resource name of the new DataCache|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=Questionnaire Rids|Description=List of Questionnaires to use in the creation. Must all belong to same template}}
|Description=Create a new datacache using quick setup}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=AddFilter|Parameters=
{{CGscriptParameters_Template|Type=string|Name=filterQuestionLabel|Description=Question to apply filter to. If empty, then clear current filters|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=filterValue|Description=Value of the filter}}
|Description=Add a filter to the DataCache}}
{{CGscriptMethods_Template|ReturnType=AnyType|Name=EvalWhere|Parameters=
{{CGscriptParameters_Template|Type=string|Name=whereExpression|Description=The expression to execute. It must contain 'where' and NOT start with a equal sign, and have 1 and only one semicolon in it}}
|Description=Evaluate a single where expression up against the current DataCache}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=EvalWhere|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=whereExpressions|Description=The expressions to execute. They must contain 'where' and MAY start with a equal sign, and have 1 and only one semicolon in it}}
|Description=Evaluate a number of where expressions up against the current DataCache. If there are 2 or more expressions, the result is cached. Context weight and filters are ignored.}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=EvalWhere|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=whereExpressions|Description=The expressions to execute. They must contain 'where' and MAY start with a equal sign, and have 1 and only one semicolon in it|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=weight|Description=Column name of the weight to use in filter}}
|Description=Evaluate a number of where expressions up against the current DataCache using a weight. If there are 2 or more expressions, the result is cached. Context weight and filters are ignored.}}
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=EvalWhere|Parameters=
{{CGscriptParameters_Template|Type=Dictionary|Name=whereExpressions|Description=The expressions to execute. They must contain 'where' and MAY start with a equal sign, and have 1 and only one semicolon in it|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=weight|Description=Column name of the weight to use in filter|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=filters|Description=Extra filters that apply to all where expressions}}
|Description=Evaluate a number of where expressions up against the current DataCache using a weight. If there are 2 or more expressions, the result is cached. Context weight and filters are ignored.}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=MakeContext|Description=Make the current DataCache the context DataCache}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=Save|Description=Save the DataCache}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CreateAllColumnsForQuestion|Parameters=
{{CGscriptParameters_Template|Type=string|Name=question|Description=QuestionLabel for the question you want all the dcs columns for|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=questionnaireResourceId|Description=Set the associated questionnaire. Set to 0 to use primary questionnaire}}
|Description=Find and create all column for a given question. They still need to be saved individually to be added.}}
{{CGscriptMethods_Template|ReturnType=array|Name=CreateAllColumnsForAllQuestions|Parameters=
{{CGscriptParameters_Template|Type=number|Name=questionnaireResourceId|Description=Set the associated questionnaire. Set to 0 to use primary questionnaire}}
|Description=Find and create all column for all questions. They still need to be saved individually to be added.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=bool|Name=AutoUpdate|HasGetter=1|HasSetter=1|Description=Get/Set Auto Update}}
{{CGscriptProperties_Template|ReturnType=bool|Name=BuildWithWeight|HasGetter=1|HasSetter=1|Description=Get/Set if the DataCache should be built using weights}}
{{CGscriptProperties_Template|ReturnType=number|Name=CachedRecords|HasGetter=1|Description=How many records does the DataCache currently hold}}
{{CGscriptProperties_Template|ReturnType=array|Name=ColumnNames|HasGetter=1|Description=List of Column names}}
{{CGscriptProperties_Template|ReturnType=bool|Name=Completed|HasGetter=1|HasSetter=1|Description=Get/Set include completed}}
{{CGscriptProperties_Template|ReturnType=bool|Name=Deleted|HasGetter=1|HasSetter=1|Description=Get/Set include deleted}}
{{CGscriptProperties_Template|ReturnType=string|Name=Description|HasGetter=1|HasSetter=1|Description=Get/Set description of the DataCache}}
{{CGscriptProperties_Template|ReturnType=bool|Name=Disabled|HasGetter=1|HasSetter=1|Description=Get/Set include disabled}}
{{CGscriptProperties_Template|ReturnType=bool|Name=InterviewFailed|HasGetter=1|HasSetter=1|Description=Get/Set include marked as interview failed}}
{{CGscriptProperties_Template|ReturnType=bool|Name=InterviewSucceeded|HasGetter=1|HasSetter=1|Description=Get/Set include marked as interview succeeded}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IsOutOfDate|HasGetter=1|Description=Does the DataCache need to be rebuilt to have the correct content}}
{{CGscriptProperties_Template|ReturnType=string|Name=Language|HasGetter=1|HasSetter=1|Description=Get/Set the iso code used in building the items that depend on a specific language}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=LastUpdated|HasGetter=1|Description=Time of the last rebuild}}
{{CGscriptProperties_Template|ReturnType=string|Name=Name|HasGetter=1|HasSetter=1|Description=Name of the DataCache resource}}
{{CGscriptProperties_Template|ReturnType=bool|Name=Normal|HasGetter=1|HasSetter=1|Description=Get/Set include normal}}
{{CGscriptProperties_Template|ReturnType=bool|Name=NotStarted|HasGetter=1|HasSetter=1|Description=Get/Set include those not yet started}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=bool|Name=OutsideTarget|HasGetter=1|HasSetter=1|Description=Get/Set include those marked outside target}}
{{CGscriptProperties_Template|ReturnType=bool|Name=Partly|HasGetter=1|HasSetter=1|Description=Get/Set include partly completed}}
{{CGscriptProperties_Template|ReturnType=ProfilingResult|Name=ProfileFromLastEval|HasGetter=1|Description=Get the profile result from the last run of EvalWhere.}}
{{CGscriptProperties_Template|ReturnType=array|Name=QuestionnaireIds|HasGetter=1|Description=List of the questionnaires used in the DataCache}}
{{CGscriptProperties_Template|ReturnType=number|Name=QuestionnaireTemplateId|HasGetter=1|Description=The resource id of the questionnaire template used in the DataCache}}
{{CGscriptProperties_Template|ReturnType=bool|Name=QuotaFull|HasGetter=1|HasSetter=1|Description=Get/Set include those with full quota}}
{{CGscriptProperties_Template|ReturnType=number|Name=ResourceId|HasGetter=1|Description=The Id of the DataCache}}
{{CGscriptProperties_Template|ReturnType=bool|Name=Test|HasGetter=1|HasSetter=1|Description=Get/Set include those marked as test}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
{{CGscriptProperties_Template|ReturnType=number|Name=UpdateFrequence|HasGetter=1|HasSetter=1|Description=Get/Set Update Frequence in minutes}}
{{CGscriptProperties_Template|ReturnType=Array of objects|Name=Weights|HasGetter=1|Description=Get list of existing weights.}}
}}

=== '''Examples''' ===

'''Ex1:'''

<source lang="javascript">
DCS_use(37244952); // set DCS context
string e1 = "count() where S_Age == [1] && M_Travel == [1,2];";
Dictionary d =
{
"exp1": "count() where S_Age == [1] && M_Travel == [1,2];",
"exp2": "count() where S_Age == [2] && M_Travel == [1];"
};
print(DCS_evaluateWhereExpression(e1)); // 68
DataCacheSpecification dcs = new DataCacheSpecification(); // Represent a DCS which is used as current DCS context
print(dcs.EvalWhere(e1)); // 68
print(dcs.EvalWhere(d)); // {"exp1": 68, "exp2": 46}</source>

<br/>'''Ex2:'''

<source lang="javascript">
string e1 = "count() where S_Age == [1] && M_Travel == [1,2];";
Dictionary d =
{
"exp1": "count() where S_Age == [1] && M_Travel == [1,2];",
"exp2": "count() where S_Age == [2] && M_Travel == [1];"
};
DataCacheSpecification dcs = new DataCacheSpecification(37244952); // Represents a DCS which has Resource Id: 37244952
print(dcs.EvalWhere(e1)); // 68
print(dcs.EvalWhere(d)); // {"exp1": 68, "exp2": 46}
dcs.MakeContext(); // or you can use DCS_use(RID) instead
print(DCS_evaluateWhereExpression(e1)); // without the previous statement (dcs.MakeContext();), you will get error at this line because there is no DCS context is set, so you can not use DCS_evaluateWhereExpression(e1)
dcs.Partly = false; // Not include the partly completed QASs
dcs.NotStarted = false; // Not include the not started QASs
dcs.Save(); // Must save to make the above statements applied on DCS, but this statement does not REBUILD the DCS
</source>

<br/>'''Ex 3:'''

<source lang="javascript">
ProfilingResult pr;
DataCacheSpecification dcs = new DataCacheSpecification(12006923);
pr = dcs.ProfileFromLastEval;
pr.EnableProfiling = true;
dcs.EvalWhere({
"ex1": "count() where true"
});

print(pr.CompileTime); // 0.1694
print(pr.CountResult); // {"5": {"2": 1}, "9": {"4": 1}}
print(pr.DependencyGraphTime); // 0
print(pr.TimeResult); // {"10": {"-1": 0.0158, "4": 0.0158}, "11": {"-1": 0.0021, "4": 0.0021}, "5": {"-1": 1.1024, "2": 1.1024}, "9": {"-1": 0.0063, "4": 0.0063}}
print(pr.WhereExpTime); // 0
</source>

<br/>'''Ex 4:'''

<source lang="javascript">
DataCacheSpecification dcs = new DataCacheSpecification(15517146);

array questionColumns = dcs.CreateAllColumnsForQuestion("Q1",0); //Create new column(s) for a question and use primary questionnaire

for(number i= 0; i < questionColumns.Count; i++){
questionColumns[i].Save(); //or method .Delete() in case removing column from dcs
}
dcs.Save(); //Must save to make the above statements applied on DCS, but this statement does not REBUILD the DCS
print(dcs.ColumnNames);

</source>

<br/>'''Ex 5:'''

<source lang="javascript">
DataCacheSpecification dcs = new DataCacheSpecification(15517146);

array questionColumns = dcs.CreateAllColumnsForAllQuestions(15517148); //Create ALL columns for ALL questions.Set to 0 to use primary questionnaire

for(number i= 0; i < questionColumns.Count; i++){
questionColumns[i].Save();
}
dcs.Save(); //Must save to make the above statements applied on DCS, but this statement does not REBUILD the DCS
print(dcs.ColumnNames);
</source>

DataCacheSpecification class

2015-12-17T07:35:42Z

Phamminhlap: