Technical Documentation Edito
From PatioWiki
| Line 9: | Line 9: | ||
[[File:Edito_concepts_UC.png|350px|Use case diagram of the concepts management]] | [[File:Edito_concepts_UC.png|350px|Use case diagram of the concepts management]] | ||
| - | In the class diagram of the concept management you can visualize the main classes used for | + | In the class diagram of the concept management you can visualize the main classes used for handling concepts. There are panels for concept management ('''ConceptPropertiesPanel'''), concept association management ('''ConceptAssociationPanel''') and relation type management ('''ConceptRelationTypePanel''') included into the main panel ('''ConceptPresenterPanel'''). Furthermore, you can visualize the class '''ConceptImagesPanel''' which manages the relations between concepts and multimedia resources, as well as the class '''ConceptTreePanel''' which contains the tree for selecting concepts. |
[[File:Edito_concept_diagram.png|800px|Class diagram of the concepts management]] | [[File:Edito_concept_diagram.png|800px|Class diagram of the concepts management]] | ||
| Line 19: | Line 19: | ||
[[File:Edito_multimedia_resources_UC.png|600px|Use case diagram of the multimedia resources management]] | [[File:Edito_multimedia_resources_UC.png|600px|Use case diagram of the multimedia resources management]] | ||
| - | In the class diagram of the multimedia resource management you can visualize the main classes used for | + | In the class diagram of the multimedia resource management you can visualize the main classes used for handling multimedia resources. Note that tabs for editing resources ('''MultimediaEditionPanel'''), addition of resources ('''MultimediaAdditionPanel''') and addition of batches of resources ('''MultimediaBatchAdditionPanel''') are included into the main tab panel ('''MultimediaTabbedPane'''). Furthermore, you can visualize the class '''MultimediaTreePanel''' which is used to contain the tree for selecting multimedia resources. |
[[File:Edito_multimedia_resource_diagram.png|800px|Class diagram of the multimedia resources management]] | [[File:Edito_multimedia_resource_diagram.png|800px|Class diagram of the multimedia resources management]] | ||
| - | + | In the next diagram you can visualize the classes of the available data types which can be used to insert multimedia resources into the multimedia resources tree. | |
[[File:Edito_multimedia_Item_diagram.png|600px|Class diagram of the multimedia items management]] | [[File:Edito_multimedia_Item_diagram.png|600px|Class diagram of the multimedia items management]] | ||
| - | = | + | = Pupil management = |
| - | + | In the use case diagram of the pupil management you can visualize the available action that you can perform on a pupil's record, such as '''Add pupil''', '''Modify pupil''', '''Delete pupil''' (provided that she has not been included in [[Sessions]] or [[Log]]s) and '''Change of group'''. | |
[[File:Edito_students_UC.png|600px|Use case diagram of the students management]] | [[File:Edito_students_UC.png|600px|Use case diagram of the students management]] | ||
| - | + | In the class diagram of the pupil management you can visualize the main classes used for handling pupils. Note that the diagram includes the panel for editing pupils ('''StudentEditionPanel'''), the panel for the pupil's tree ('''StudentsTreeEditionPanel''') and the panel that contains the data of the pupil is being edited ('''StudentsPropertiesPanel'''). Furthermore, you can visualize the class hierarchy for the types of nodes which can be included into the pupils tree. Each node can be an instance of '''SchoolTreeItem''' if it is for a school, '''GroupTreeItem''' for a group or '''StudentTreeItem''' for a pupil. | |
[[File:Edito_student_diagram.png|800px|Class diagram of the students management]] | [[File:Edito_student_diagram.png|800px|Class diagram of the students management]] | ||
| - | = | + | = Syllable division management = |
En el diagrama de casos de uso para la gestión de las separaciones en sílabas se observan las operaciones disponibles que se pueden realizar, tales como '''Añadir Separación en Sílabas''' o '''Eliminar Separación en Sílabas'''. | En el diagrama de casos de uso para la gestión de las separaciones en sílabas se observan las operaciones disponibles que se pueden realizar, tales como '''Añadir Separación en Sílabas''' o '''Eliminar Separación en Sílabas'''. | ||
Revision as of 09:17, 27 October 2011
In the Edito module we have implemented the management of concepts, multimedia resources, pupils and syllable division.
Contents |
Concept Management
In the use case diagram of the concept management you can visualize the available actions that you can perform on a concept, such as Add concept, Modify concept, Delete concept and Relate concepts.
In the class diagram of the concept management you can visualize the main classes used for handling concepts. There are panels for concept management (ConceptPropertiesPanel), concept association management (ConceptAssociationPanel) and relation type management (ConceptRelationTypePanel) included into the main panel (ConceptPresenterPanel). Furthermore, you can visualize the class ConceptImagesPanel which manages the relations between concepts and multimedia resources, as well as the class ConceptTreePanel which contains the tree for selecting concepts.
Multimedia Resource Management
In the use case diagram of the multimedia resource management you can visualize the available action that you can perform on a multimedia resource, such as Add multimedia resource, Modify multimedia resource, Delete multimedia resource y Add a batch. Note that when you add or modify a multimedia resource you can also Associate it with a concept.
In the class diagram of the multimedia resource management you can visualize the main classes used for handling multimedia resources. Note that tabs for editing resources (MultimediaEditionPanel), addition of resources (MultimediaAdditionPanel) and addition of batches of resources (MultimediaBatchAdditionPanel) are included into the main tab panel (MultimediaTabbedPane). Furthermore, you can visualize the class MultimediaTreePanel which is used to contain the tree for selecting multimedia resources.
In the next diagram you can visualize the classes of the available data types which can be used to insert multimedia resources into the multimedia resources tree.
Pupil management
In the use case diagram of the pupil management you can visualize the available action that you can perform on a pupil's record, such as Add pupil, Modify pupil, Delete pupil (provided that she has not been included in Sessions or Logs) and Change of group.
In the class diagram of the pupil management you can visualize the main classes used for handling pupils. Note that the diagram includes the panel for editing pupils (StudentEditionPanel), the panel for the pupil's tree (StudentsTreeEditionPanel) and the panel that contains the data of the pupil is being edited (StudentsPropertiesPanel). Furthermore, you can visualize the class hierarchy for the types of nodes which can be included into the pupils tree. Each node can be an instance of SchoolTreeItem if it is for a school, GroupTreeItem for a group or StudentTreeItem for a pupil.
Syllable division management
En el diagrama de casos de uso para la gestión de las separaciones en sílabas se observan las operaciones disponibles que se pueden realizar, tales como Añadir Separación en Sílabas o Eliminar Separación en Sílabas.
En el diagrama de clases de la gestión de las separaciones en sílabas se visualizan las clases principales involucradas en la gestión de las separaciones en sílabas. Nótese la inclusión del panel de edición SyllableEditionPanel, el panel destinado al árbol de conceptos SyllableTreeEditionPanel y el panel contenedor de las separaciones en sílabas SyllablePropertiesPanel. También se han incluido las clases para los items para el árbol siendo LeoLetterSyllableTreeItem y LeoWordSyllableTreeItem los nodos que heredan de la clase AbstractSyllableTreeItem.
