Technical Documentation LogProcessor
From PatioWiki
(→Use Case) |
(Proofreading) |
||
| (3 intermediate revisions not shown) | |||
| Line 1: | Line 1: | ||
| - | In the [[LogProcessor]] module we have implemented the analysis of the [[Log]] of the exercises and the exportation of the | + | In the [[LogProcessor]] module we have implemented the analysis of the [[Log]] of the exercises and the exportation of the results to a [http://es.wikipedia.org/wiki/CSV CSV] file. Besides, you can produce graphs and pattern analyses of some type of exercises. |
__TOC__ | __TOC__ | ||
| Line 5: | Line 5: | ||
= Use Case = | = Use Case = | ||
| - | In the use case diagram you can | + | In the use case diagram you can see the available actions that you can perform with this module, such as '''Analyse a log''', '''Export analysis to a CSV file''', '''Analyse patterns''' or '''Produce graphs''' using data form [[Log]] files of the exercises. |
[[File:Log_UC.png|400px|Case use diagram of the processor of logs]] | [[File:Log_UC.png|400px|Case use diagram of the processor of logs]] | ||
| Line 11: | Line 11: | ||
= Class Diagram of the Log Reader = | = Class Diagram of the Log Reader = | ||
| - | In the class diagram of the log reader you can | + | In the class diagram of the log reader you can see the '''AbstractCommonLogGraph''' class which is used to produce graphs ('''CommonLogGraph''') and the pattern analyses ('''CommonLogPattern'''). The diagram also contains the '''AbstractCommonLogProcessor''' class which is used to read logs from the database ('''CommonLogProcessor''') or from a disk file ('''CommonFileLogProcessor'''). |
[[File:Log_reader_diagram.png|800px|Class diagram of the log reader]] | [[File:Log_reader_diagram.png|800px|Class diagram of the log reader]] | ||
| Line 17: | Line 17: | ||
= Class Diagram of the Log Events = | = Class Diagram of the Log Events = | ||
| - | In the class diagram of the log events you can | + | In the class diagram of the log events you can see the events hierarchy that the program use. As you can see, there is a division between events of the pointing device ('''AbstractPointerEvent''') and the exercise events ('''LogEvent'''). |
[[File:Log_events_diagram.png|600px|Class diagram of the log events]] | [[File:Log_events_diagram.png|600px|Class diagram of the log events]] | ||
| Line 23: | Line 23: | ||
= Class Diagram of the Log Processor = | = Class Diagram of the Log Processor = | ||
| - | In the class diagram of the log processor you can | + | In the class diagram of the log processor you can see the existing division between the processors of the [[Aprendo]] module exercises ('''AbstractAprendoProcessor''') and the [[Leo]] module exercises ('''AbstractLeoProcessor'''). Note that there is a specific class for processing logs of each type of exercises. |
[[File:Log_processor_diagram.png|800px|Class diagram of the log processor]] | [[File:Log_processor_diagram.png|800px|Class diagram of the log processor]] | ||
| Line 29: | Line 29: | ||
= Class Diagram of the Graphs of Logs = | = Class Diagram of the Graphs of Logs = | ||
| - | In the class diagram of the graphs | + | In the class diagram of the log graphs you can see several classes ('''DirectionalGraph''', '''PointsDensityGraph''' and '''AllPointsGraph''') which can be included into the panel containing graphs called '''GraphPanel'''. Note that the '''GraphPanel''' can also be included into the panel of pattern analysis ('''PatternStudyPanel''') which contains two classes; '''PatternList''' and '''PatternUserList'''. |
[[File:Log_graph_diagram.png|800px|Class diagram of the graphs of logs]] | [[File:Log_graph_diagram.png|800px|Class diagram of the graphs of logs]] | ||
| Line 35: | Line 35: | ||
= Class Diagram of the Results Exporter = | = Class Diagram of the Results Exporter = | ||
| - | In the class diagram of the results exporter you can | + | In the class diagram of the results exporter you can see a division between the classes of the [[Aprendo]] module exercises (they inherit from '''AbstractAprendoExporter''' class) and the [[Leo]] ones (they inherit from '''AbstractLeoExporter'''). |
[[File:Log_exporter_diagram.png|800px|Class diagram of the results exporter]] | [[File:Log_exporter_diagram.png|800px|Class diagram of the results exporter]] | ||
| Line 41: | Line 41: | ||
= Class Diagram of the Log Player = | = Class Diagram of the Log Player = | ||
| - | In the class diagram of the log player you can | + | In the class diagram of the log player you can see a division between the classes of the [[Aprendo]] module ('''AbstractAprendoPlayer''') and the [[Leo]] module ones ('''AbstractLeoPlayer'''). There is a specific class for each exercise. These classes implement the proper engine for the player depending on the exercise to be played. Note that the class used for replaying exercise events ('''AbstractExercisePlayer''') and the class for pointing device events ('''MouseEventsGlassPane''') inherit from the '''AbstractPlayerComponent''' class. |
[[File:Log_player_diagram.png|600px|Class diagrama of the log player]] | [[File:Log_player_diagram.png|600px|Class diagrama of the log player]] | ||
Current revision as of 13:27, 27 October 2011
In the LogProcessor module we have implemented the analysis of the Log of the exercises and the exportation of the results to a CSV file. Besides, you can produce graphs and pattern analyses of some type of exercises.
Contents |
Use Case
In the use case diagram you can see the available actions that you can perform with this module, such as Analyse a log, Export analysis to a CSV file, Analyse patterns or Produce graphs using data form Log files of the exercises.
Class Diagram of the Log Reader
In the class diagram of the log reader you can see the AbstractCommonLogGraph class which is used to produce graphs (CommonLogGraph) and the pattern analyses (CommonLogPattern). The diagram also contains the AbstractCommonLogProcessor class which is used to read logs from the database (CommonLogProcessor) or from a disk file (CommonFileLogProcessor).
Class Diagram of the Log Events
In the class diagram of the log events you can see the events hierarchy that the program use. As you can see, there is a division between events of the pointing device (AbstractPointerEvent) and the exercise events (LogEvent).
Class Diagram of the Log Processor
In the class diagram of the log processor you can see the existing division between the processors of the Aprendo module exercises (AbstractAprendoProcessor) and the Leo module exercises (AbstractLeoProcessor). Note that there is a specific class for processing logs of each type of exercises.
Class Diagram of the Graphs of Logs
In the class diagram of the log graphs you can see several classes (DirectionalGraph, PointsDensityGraph and AllPointsGraph) which can be included into the panel containing graphs called GraphPanel. Note that the GraphPanel can also be included into the panel of pattern analysis (PatternStudyPanel) which contains two classes; PatternList and PatternUserList.
Class Diagram of the Results Exporter
In the class diagram of the results exporter you can see a division between the classes of the Aprendo module exercises (they inherit from AbstractAprendoExporter class) and the Leo ones (they inherit from AbstractLeoExporter).
Class Diagram of the Log Player
In the class diagram of the log player you can see a division between the classes of the Aprendo module (AbstractAprendoPlayer) and the Leo module ones (AbstractLeoPlayer). There is a specific class for each exercise. These classes implement the proper engine for the player depending on the exercise to be played. Note that the class used for replaying exercise events (AbstractExercisePlayer) and the class for pointing device events (MouseEventsGlassPane) inherit from the AbstractPlayerComponent class.
