Tabulation Script - Revision history

Catglobe: /* Document revisions */

2009-08-04T07:33:32Z

Document revisions

← Older revision		Revision as of 07:33, 4 August 2009
Line 148:		Line 148:
	\| '''Changed By'''		\| '''Changed By'''
	\| '''Description'''		\| '''Description'''
			\| '''Svn Revision'''
	\|-		\|-
	\| 0.1		\| 0.1
Line 153:		Line 154:
	\| Nguyen Trung Chinh		\| Nguyen Trung Chinh
	\| Create the first version		\| Create the first version
			\| NA
			\|-
			\| 0.1
			\| 23.07.2009
			\| Nguyen Trung Chinh
			\| Finish first version
			\| 54885
	\|}		\|}

Catglobe: /* Class diagram */

2009-08-04T07:32:42Z

Class diagram

← Older revision		Revision as of 07:32, 4 August 2009
Line 47:		Line 47:
	=== Class diagram ===		=== Class diagram ===
	[[Image:Diagram_-_Tabulation_Script.gif]]		[[Image:Diagram_-_Tabulation_Script.gif]]

			To not making too many changes at the same time, only class ''CGScript_System_Report'' is copied from ''CatGlobe'' to ''CatGlobe.Report''. The remaining classes are still inside ''CatGlobe''.

	=== Point of injections ===		=== Point of injections ===

Catglobe: /* Injecting new processing with least impact */

2009-08-04T07:31:22Z

Injecting new processing with least impact

← Older revision		Revision as of 07:31, 4 August 2009
Line 44:		Line 44:
	Interpreter cgsEngine = dcs.GetReportInterpreter();		Interpreter cgsEngine = dcs.GetReportInterpreter();
	</source>		</source>

			=== Class diagram ===
			[[Image:Diagram_-_Tabulation_Script.gif]]

	=== Point of injections ===		=== Point of injections ===

			==== ''Interpreter'' ====
			''Interpreter'' now must support for an additional constructor which received custom libraries as below:
			<source lang="csharp">
			internal Interpreter(IEnumerable<CGScriptLibrary> additionalLibraries)
			: this()
			{
			Debug.Assert(SymbolTable != null);
			if (additionalLibraries != null)
			foreach (CGScriptLibrary library in additionalLibraries)
			if (library != null)
			library.Register(SymbolTable);
			}

			public Interpreter()
			{
			cultureInfo = CultureInfo.InvariantCulture;
			formatter = cultureInfo.NumberFormat;
			symbolTable = new SymbolTable(true);
			input = string.Empty;
			cgScriptCompiler = new ILCodeGenerator(symbolTable);
			IsInCellCalculationMode = false;
			}
			</source>

			* Modifier of this constructor is ''internal'' to prevent non-friend code to access it
			* The constructor call its counterpart which receives no parameter and create instance of symbolTable
			* Then, for each assembly, register it with the created symbol table. Because symbol table use dictionary as its data store, so the newer registered function would override the existing one. This allow us new engine's scripts override old engine's scripts.

	==== ''TabulationDiagram'' ====		==== ''TabulationDiagram'' ====
	As shown in processing of tabulation script section above, the main idea of ''TabulationDiagram'' is that it is created with enough information for generating a domain's diagram instance, but that instance is created whenever needed only.		As shown in processing of tabulation script section above, the main idea of ''TabulationDiagram'' is that it is created with enough information for generating a domain's diagram instance, but that instance is created whenever needed only.

	So, to inject our processing with least painful, I decided to create a diagram ~~creating~~ delegate. The delegate type is declared in ''DiagramUtility'' class (''CatGlobe'' assembly) but the implementation is inside ''CatGlobe.Report'' assembly. After all, the instance of the delegate will be passed to ''CatGlobe'' from ''CatGlobe.Report'' during execution of a tabulation script. And the ''~~TabulationDiabram~~'' is changed as below:		So, to inject our processing with least painful, I decided to create a diagram factory delegate. The delegate type is declared in ''DiagramUtility'' class (''CatGlobe'' assembly) but the implementation is inside ''CatGlobe.Report'' assembly. After all, the instance of the delegate will be passed to ''CatGlobe'' from ''CatGlobe.Report'' during execution of a tabulation script. And the ''TabulationDiagram'' is changed as below:
	<source lang="csharp">		<source lang="csharp">
	public Diagram InternalDiagram		public Diagram InternalDiagram
Line 80:		Line 111:
	</source>		</source>

	It can be understood as if there is a custom diagram ~~generating~~ delegate, use that. Otherwise, use the default method.		It can be understood as if there is a custom diagram factory delegate, use that. Otherwise, use the default method.

	==== ''CatGlobe.Report'''s code ====		==== ''CatGlobe.Report'''s code ====
	First of all, we need an implementation of the diagram ~~generating~~ delegate:		First of all, we need an implementation of the diagram factory delegate:

	<source lang="csharp">		<source lang="csharp">

Catglobe at 07:29, 30 July 2009

2009-07-30T07:29:08Z

← Older revision		Revision as of 07:29, 30 July 2009
Line 1:		Line 1:
	[[New Report Design 2009]] => [[Tabulation Script]]		[[New Report Design - 2009]] => [[Tabulation Script]]

	== Tabulation Script ==		== Tabulation Script ==

Catglobe: add breadscrump

2009-07-30T07:28:47Z

add breadscrump

← Older revision		Revision as of 07:28, 30 July 2009
Line 1:		Line 1:
			[[New Report Design 2009]] => [[Tabulation Script]]

	== Tabulation Script ==		== Tabulation Script ==
	Tabulation Script is a CGScript library allowing user to create diagram/report. It's also capable of setting stylesheet (both external and internal).		Tabulation Script is a CGScript library allowing user to create diagram/report. It's also capable of setting stylesheet (both external and internal).

Catglobe: Create first version

2009-07-23T07:14:52Z

Create first version

Show changes

Catglobe: /* Moving script location */

2009-07-23T06:50:41Z

Moving script location

← Older revision		Revision as of 06:50, 23 July 2009
Line 19:		Line 19:

	=== Moving script location ===		=== Moving script location ===
	Due to the fact that tabulation script belongs to REPORT DOMAIN rather RUNTIME DOMAIN, it MUST be in the same assembly with REPORT. And to not change so much at the same time, the file ''CGScript_System_Report'' is '<u>''copied'''</u> to ''CatGlobe.Report'' assembly under folder ''Script''. The namespace was also changed to '''~~TODO~~'''.		Due to the fact that tabulation script belongs to REPORT DOMAIN rather RUNTIME DOMAIN, it MUST be in the same assembly with REPORT. And to not change so much at the same time, the file ''CGScript_System_Report'' is '<u>''copied'''</u> to ''CatGlobe.Report'' assembly under folder ''Script''. The namespace was also changed to '''CatGlobe.Framework.Report.Script'''.

	~~Now, we have a class diagram:~~

	~~CGScript_System_Report = TabulationDiagram, TabulationConfiguration~~

			Due to the fact that CGScript engine was designed to hide all unnecessary information from the outside (good point). But we need some references to some internal classes in order to implement a ''CGScriptLibrary''. Thus, the CatGlobe assembly must be internal visible to ''CatGlobe.Report''.

	=== Custom static Instance ===		=== Custom static Instance ===

Catglobe: First version, NOT COMPLETED

2009-07-20T11:09:40Z

First version, NOT COMPLETED

New page

== Tabulation Script ==
Tabulation Script is a CGScript library allowing user to create diagram/report. It's also capable of setting stylesheet (both external and internal).

=== Some classes ===
* ''CGScript_System_Report'': CGScript library implementation, contains all entry points to diagram/report generation process
* ''TabulationModuleUtilities'': contains utility methods
* ''DiagramUtilities'': also contains utility methods
* ''TabulationDiagram'': wrapper class for the REAL report diagram
* ''TabulationConfiguration'': contains all result of tabulation diagram ''(the name ??!!!!)''

=== Understanding tabulation script processing ===
The processing of tabulation script can be understand as below:
# Create new ''Interpreter'' (which create also an instance of ''TabulationConfiguration'' as properties named ''TabulationConfig'' )
# Run the tabulation script => the result diagrams (if any) is stored inside ''DiagramCharts'' variable of ''TabulationConfiguration''
# If has to show result, get the result diagram objects from ''DiagramCharts'' and set to session
# Show a SPECIFIC viewer that takes diagram objects from session and draw on screen (why do we need a SPECIFIC viewer?)

== Injecting new processing with least impact ==

=== Moving script location ===
Due to the fact that tabulation script belongs to REPORT DOMAIN rather RUNTIME DOMAIN, it MUST be in the same assembly with REPORT. And to not change so much at the same time, the file ''CGScript_System_Report'' is '<u>''copied'''</u> to ''CatGlobe.Report'' assembly under folder ''Script''. The namespace was also changed to '''TODO'''.

Now, we have a class diagram:

CGScript_System_Report = TabulationDiagram, TabulationConfiguration

=== Custom static Instance ===
* HashTable
* static string

=== Point of injections ===

==== ''TabulationDiagram'' ====
As shown in processing of tabulation script section above, we need to HACK the ''TabulationDiagram'' o create the REAL report diagram because it wraps the REAL report inside. The original code looks as below:

<source lang="csharp">
private void CreateInternalDiagram()
{
...

// Provide outside
InternalDiagram = DiagramUtilities.CreateDiagram(this.ReportTemplate
, this.CrossStruct
, this.Parameter.InternalStyle
, this.ChartName
, this.Generator.Header
, this.Generator.Title
, this.Generator.Parameter.ChartType
, DiagramType.CrossDiagram
, subtitle1, string.Empty, string.Empty);
, subtitle1, string.Empty, string.Empty);
...
}
</source>

To inject our processing

After checking the current code, I come to the final place that all the processing of tabulation script must go through to create a diagram. And that is the perfect candidate for injecting new report processing. It is method ''CreateDiagram'' of ''CGScript_System_Report'', the code is as below:
<source lang="csharp">
private static int CreateDiagram(List<Axis> columns, List<Axis> rows, FunctionIdentifier function)
{
if (columns.Count > 2 || rows.Count > 2)
throw new RuntimeException(string.Format("Crossing too many rows and columns may crash the server. A limit of 2 rows and 2 columns is set at the moment. Function '{0}' failed.", function.Name));

Interpreter interpreter = function.Interpreter;
TabulationConfiguration config = interpreter.TabulationConfig;

Parameter p = config.DiagramParameter;
p.Weight = interpreter.WeightColumnName;
p.Filters = interpreter.FilterExpressionList.ToArray();
p.DataCache = interpreter.DataCacheSpecification;
p.ColumnList = columns;
p.RowList = rows;
p.SourceTable = function.Interpreter.SourceTable;

ValidateConfiguration(function);

config.DiagramGenerator = new CrossDiagramGenerater { Parameter = p };

//generate the expression table and result table
CrossDiagramGenerater.CrossStructure crossStruct = config.DiagramGenerator.BuildCrossEx();
DataTableFunctions.FormatDataTableValue(crossStruct.DataTable, TabulationModuleConstants.DEFAULT_DECIMAL_POSITION, TabulationModuleConstants.DEFAULT_CULTURE, config.ShowErrorInResult);

//generate the xml string based on the configuration
TabulationDiagram diagram = TabulationModuleUtilities.CreateDiagramObject(crossStruct, config);

if (diagram == null)
throw new RuntimeException(string.Format("Cannot generate this type of chart: '{0}'. Function '{1}' failed.", config.DiagramParameter.ChartType, function.Name));

config.DiagramCharts.Add(diagram);

return config.DiagramCharts.Count;
}
</source>