To match sound-image editor

From PatioWiki

(Difference between revisions)
Jump to: navigation, search
 
(25 intermediate revisions not shown)
Line 1: Line 1:
-
= Class diagrams =
+
= Manual =
 +
 
 +
== Class diagrams ==
The following image shows the summarized class diagram of the manual editor of To match sound-image exercises that is part of [[Tareas]].
The following image shows the summarized class diagram of the manual editor of To match sound-image exercises that is part of [[Tareas]].
-
[[Archivo:Tareas_diagrama_clases_emparejar_manual_es.png|1000px|Diagrama de clases del editor Emparejar Sonido-imagen manual.]]
+
[[File:Tareas_emparejar_manual_class_diagram_en.png|1000px|To match sound-image pairs manual editor class diagram.]]
 +
 
 +
In the diagram above we can see that the information of the exercise that is being edited will be stored in the "CurrentEmparejarExercise" class, which has all static fields. This class also stores the information of all image-sound pairs of the exercise and each of them is represented by an instance of the "PairInfo" class.
-
En el diagrama anterior se puede observar que la información del ejercicio que se está editando se va almacenando en la clase "CurrentEmparejarExercise", cuyos campos son todos estáticos. Esta clase almacena también la información de todos los pares imagen-sonido que posee el ejercicio, siendo cada uno de ellos representado por una instancia de la clase "PairInfo".
+
The main panel is an object of class "EmparejarMainPanel" which contains three subpanels: "Image-sound pairs", "Images" and "Sounds".
-
Por otra parte, el panel principal es un objeto de la clase "EmparejarMainPanel", que está formado por tres subpaneles: ''Pares imagen-sonido", "Imágenes" y "Sonidos".  
+
The '''image-sound pairs''' panel ("leftPanel") is a "PreviewPanel" object which contains a toolbar and the panel that contains all the exercise pairs ("PairsPanel"). The exercise configuration panel is an "ExerciseConfigPanel" object and it is instantiated each time the user clicks on the corresponding button located in the '''image-sound pairs''' panel toolbar.
-
El panel '''Pares imagen-sonido''' ("leftPanel") es de tipo "PreviewPanel" y contiene la barra de herramientas del panel '''Pares imagen-sonido''' y el panel que contiene todos los pares del ejercicio ("PairsPanel"). El panel de configuración del ejercicio es de tipo "ExerciseConfigPanel" y es instanciado cada vez que el usuario pulsa sobre el correspondiente botón situado en la barra de herramientas del panel '''Pares imagen-sonido'''.
+
An object of type "MultimediaResourcesFilterPanel" ("rightPanel") creates two instances of the class "MultimediaFilterPanel". Each of these instances represents a panel that filters all the available multimedia resources by type (images, sounds, videos...). In this case are "Images" and "Sounds" panels.
-
La clase "MultimediaResourcesFilterPanel" ("rightPanel") crea dos instancias de la clase "MultimediaFilterPanel". Cada una de estas instancias representa un panel en el que se filtran los recursos multimedia disponibles que, en este caso, son "Imágenes" y "Sonidos".
 
-
= Use cases =
+
== Use cases ==
-
[[Archivo:Tareas_casos_uso_emparejar_manual_es.png|800px|Diagrama de casos de uso del editor manual de ejercicios Emparejar sonido-imagen.]]
+
[[File:Tareas_emparejar_manual_use_cases_en.png|800px|Use cases diagram: To match sound-image pairs.]]
-
A continuación se realizará una descripción textual de los casos de uso del editor manual de ejercicios Emparejar Sonido-Imagen.  
+
Next, there is a textual description of the use cases of the "To match sound-image pairs" exercises manual editor.  
-
'''1. Caso de uso: '''Configuración inicial.  
+
'''1. Use case: '''Initial configuration.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Se acaba de iniciar este editor de ejercicios para crear un ejercicio nuevo.
+
       '''Preconditions: '''This editor has just started to create a new exercise.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. La herramienta muestra al usuario la ventana de configuración inicial.
+
               1. The tool shows the user the initial configuration window.
-
               2. El usuario selecciona el idioma del ejercicio, el número de pares vacíos que se añadirán al mismo y pulsa el botón “Aceptar”.  
+
               2. The user selects the exercise language and the number of empty pairs that will be added to it and presses the "OK" button.  
-
               3. La herramienta inicia este editor con un nuevo ejercicio que tiene la configuración inicial seleccionada.
+
               3. The tool shows this editor which contains the new exercise with the initial configuration.
-
'''2. Caso de uso: '''Añadir un nuevo par.  
+
'''2. Use case: '''Add a new pair.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución.
+
       '''Preconditions: '''This editor must be running.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa el botón “Añadir” situado en la barra de herramientas del “Panel Pares imagen-sonido”.
+
               1. The user presses the "Add" button located in the "Image-sound pairs" panel.
-
               2. La herramienta añade un nuevo par vacío al final de la lista de pares imagen-sonido.  
+
               2. The tool adds a new empty pair at the end of the image-sound pairs list.  
-
'''3. Caso de uso: '''Eliminar el par seleccionado.  
+
'''3. Use case: '''Delete the selected pair.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución y tener un par imagen-sonido seleccionado.
+
       '''Preconditions: '''This editor must be running and an image-sound pair has been selected.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa el botón “Eliminar” situado en la barra de herramientas del “Panel Pares imagen-sonido”.
+
               1. The user presses the "Delete" button located in the "Image-sound pairs" panel toolbar.
-
               2. La herramienta elimina el par seleccionado en la lista de pares imagen-sonido.  
+
               2. The tool removes the selected pair from the image-sound pairs list.
-
'''4. Caso de uso: '''Subir una posición el par seleccionado.  
+
'''4. Use case: '''The selected pair goes up.
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución, tener un par imagen-sonido seleccionado y debe tener al menos un par situado por encima de él.
+
       '''Preconditions: '''This editor must be running, an image-sound pair has been selected and there must be at least one pair placed above.
-
       '''Escenario de éxito principal: '''  
+
       '''Main success scenario: '''  
-
               1. El usuario pulsa el botón “Subir” situado en la barra de herramientas del “Panel Pares imagen-sonido”.
+
               1. The user presses the "Up" button located in the "Image-sound pairs" panel toolbar.
-
               2. La herramienta sube una posición al par seleccionado en la lista de pares imagen-sonido.  
+
               2. The tool raises the selected pair one position in the image-sound pairs list.  
-
'''5. Caso de uso: '''Bajar una posición el par seleccionado.  
+
'''5. Use case: '''The selected pair goes down.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución, tener un par imagen-sonido seleccionado y debe tener al menos un par situado por debajo de él.
+
       '''Preconditions: '''This editor must be running, an image-sound pair has been selected and there must be at least one pair placed below.
-
       '''Escenario de éxito principal: '''  
+
       '''Main success scenario: '''  
-
               1. El usuario pulsa el botón “Bajar” situado en la barra de herramientas del “Panel Pares imagen-sonido”.
+
               1. The user presses the "Down" button located in the "Image-sound pairs" panel toolbar.
-
               2. La herramienta baja una posición al par seleccionado en la lista de pares imagen-sonido.  
+
               2. The tool lowers the selected pair one position in the image-sound pairs list.
-
'''6. Caso de uso: '''Cambiar el estado correcto/incorrecto de un par.  
+
'''6. Use case: '''Change the correct/incorrect state.
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución y debe existir al menos un par en la lista de pares imagen-sonido.
+
       '''Preconditions: '''This editor must be running and the image-sound pairs list can't be empty.
-
       '''Escenario de éxito principal: '''  
+
       '''Main success scenario: '''  
-
               1. El usuario pulsa sobre la columna "Correcto" de un par determinado.
+
               1. The user clicks in the "Correct" column of a pair.
-
               2. La herramienta cambia el estado del par de correcto a incorrecto o viceversa.  
+
               2. The tool changes the state of that pair from correct to incorrect or viceversa.
-
'''7. Caso de uso: '''Asociar un sonido a un par.  
+
'''7. Use case: '''Associate a sound with a pair.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución y debe existir al menos un par en la lista de pares imagen-sonido.
+
       '''Preconditions: '''This editor must be running and the image-sound pairs list can't be empty.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario buscará el sonido deseado en el panel "Sonidos". Una vez localizado el sonido, pulsará sobre él para seleccionarlo y, sin soltarlo, lo arrastrará y soltará sobre la columna "Sonido" del par situado
+
               1. The user looks for the desired sound in the "Sounds" panel. Once the sound is located, the user clicks on it to select it and, without releasing the button, he drags and drops it onto the "Sound" column
-
                 en el panel de pares imagen-sonido al que se le quiera asociar.  
+
                 of the desired pair located in the image-sound pairs panel.  
-
               2. La herramienta asocia el sonido al par sobre el que fue soltado.  
+
               2. The tool associates the sound with that pair.  
-
'''8. Caso de uso: '''Quitar un sonido de un par.  
+
'''8. Use case: '''Remove the sound of a pair.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución y debe existir al menos un par en la lista de pares imagen-sonido.
+
       '''Preconditions: '''This editor must be running and the image-sound pairs list can't be empty.
-
       '''Escenario de éxito principal: '''  
+
       '''Main success scenario: '''  
-
               1. El usuario pulsa con el botón derecho del ratón sobre el par al que quiere quitarle el sonido que tiene asociado.
+
               1. The user clicks with the mouse right button over the pair that he wants to remove its associated sound.
-
               2. La herramienta muestra al usuario un pequeño menú de opciones.
+
               2. The tool shows a small menu of options.
-
               3. El usuario selecciona la opción "Quitar sonido".  
+
               3. The user selects the "Remove sound" option.  
-
               4. La herramienta quita el sonido que tenía asociado el par.  
+
               4. The tool removes the associated sound of that pair.  
-
'''9. Caso de uso: '''Asociar una imagen a un par.  
+
'''9. Use case: '''Associate an image with a pair.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución y debe existir al menos un par en la lista de pares imagen-sonido.
+
       '''Preconditions: '''This editor must be running and the image-sound pairs list can't be empty.
-
       '''Escenario de éxito principal: '''  
+
       '''Main success scenario: '''  
-
               1. El usuario buscará la imagen deseada en el panel "Imágenes". Una vez localizada la imagen, pulsará sobre ella para seleccionarla y, sin soltarla, la arrastrará y soltará sobre la columna "Imagen" del par situado
+
               1. The user looks for the desired image in the "Images" panel. Once the image is located, the user clicks on it to select it and, without releasing the button, he drags and drops it onto the "Image" column
-
                 en el panel de pares imagen-sonido al que se le quiera asociar.  
+
                 of the desired pair located in the image-sound pairs panel.
-
               2.La herramienta asocia la imagen al par sobre el que fue soltado.  
+
               2. The tool associates the image with that pair.  
-
'''10. Caso de uso: '''Quitar una imagen a un par.  
+
'''10. Use case: '''Remove the image of a pair.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución y debe existir al menos un par en la lista de pares imagen-sonido.
+
       '''Preconditions: '''This editor must be running and the image-sound pairs list can't be empty.
-
       '''Escenario de éxito principal: '''  
+
       '''Main success scenario: '''  
-
               1.El usuario pulsa con el botón derecho del ratón sobre el par al que quiere quitarle la imagen que tiene asociada.
+
               1. The user clicks with the mouse right button over the pair that he wants to remove its associated image.
-
               2.La herramienta muestra al usuario un pequeño menú de opciones.
+
               2. The tool shows a small menu of options.
-
               3.El usuario selecciona la opción "Quitar imagen".  
+
               3. The user selects the "Remove image" option.  
-
               4.La herramienta quita la imagen que tenía asociada el par.  
+
               4. The tool removes the associated image of that pair.
-
'''11. Caso de uso: '''Reproducir un sonido de un par.  
+
'''11. Use case: '''Play a sound of a pair.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución y debe existir al menos un par en la lista de pares imagen-sonido que tenga un sonido asociado.
+
       '''Preconditions: '''This editor must be running, the image-sound pairs list can't be empty and there must be at least one pair with an associated sound in the list.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa sobre el contenido de la columna "Sonido" de un par determinado.
+
               1. The user clicks in the "Sound" column of a pair.
-
               2. La herramienta reproduce el sonido asociado a dicho par.  
+
               2. The tool plays the associated sound of that pair.  
-
'''12. Caso de uso: '''Obtener información.  
+
'''12. Use case: '''Get information.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución.
+
       '''Preconditions: '''This editor must be running.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario sitúa el cursor del ratón sobre cualquier componente del editor.
+
               1. The user places the mouse cursor over any component of the editor.
-
               2. La herramienta muestra información emergente de dicho componente.  
+
               2. The tool shows the popup information about that component.  
-
'''13. Caso de uso: '''Editar el nombre del ejercicio.  
+
'''13. Use case: '''Edit the exercise name.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución.
+
       '''Preconditions: '''This editor must be running.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa el botón “Configuración del ejercicio” situado en la barra de herramientas del “Panel Pares imagen-sonido”.
+
               1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
-
               2. La herramienta muestra el panel de configuración del ejercicio.
+
               2. The tool shows the exercise configuration panel.
-
               3. El usuario introduce el nombre del ejercicio en su campo correspondiente y pulsa el botón “Aceptar”.
+
               3. The user enters the exercise name in the "Name" field and presses the "OK" button.
-
               4. La herramienta asocia el nuevo nombre al ejercicio que se está editando.
+
               4. The tool associates the new name to the exercise.
-
'''14. Caso de uso: '''Editar enunciado del ejercicio.  
+
'''14. Use case: '''Edit the exercise sentence.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución.
+
       '''Preconditions: '''This editor must be running.
-
       '''Escenario de éxito principal:'''  
+
       '''Main success scenario:'''  
-
               1. El usuario pulsa el botón “Configuración del ejercicio” situado en la barra de herramientas del “Panel Pares imagen-sonido”.
+
               1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
-
               2. La herramienta muestra el panel de configuración del ejercicio.
+
               2. The tool shows the exercise configuration panel.
-
               3. El usuario introduce el enunciado del ejercicio en su campo correspondiente y pulsa el botón “Aceptar”.
+
               3. The user enters the exercise sentence in the "Sentence" field and presses the "OK" button.
-
               4. La herramienta asocia el nuevo enunciado al ejercicio que se está editando.
+
               4. The tool associates the new sentence to the exercise.
-
'''15. Caso de uso: '''Cambiar el tiempo mostrando imagen.  
+
'''15. Use case: '''Change the time showing image.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución.
+
       '''Preconditions: '''This editor must be running.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa el botón “Configuración del ejercicio” situado en la barra de herramientas del “Panel Pares imagen-sonido”.
+
               1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
-
               2. La herramienta muestra el panel de configuración del ejercicio.
+
               2. The tool shows the exercise configuration panel.
-
               3. El usuario introduce el tiempo mostrando imagen  (en milisegundos) en su campo correspondiente y pulsa el botón “Aceptar”.
+
               3. The user enters the time showing image in the "Time showing image" field and presses the "OK" button.
-
               4. La herramienta asocia el nuevo tiempo mostrando imagen al ejercicio que se está editando.
+
               4. The tool associates the new time showing image to the exercise.
-
'''16. Caso de uso: '''Cambiar tiempo entre imagen y sonido.  
+
'''16. Use case: '''Change the time between image and sound.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución.
+
       '''Preconditions: '''This editor must be running.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa el botón “Configuración del ejercicio” situado en la barra de herramientas del “Panel Pares imagen-sonido”.
+
               1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
-
               2. La herramienta muestra el panel de configuración del ejercicio.
+
               2. The tool shows the exercise configuration panel.
-
               3. El usuario introduce el tiempo entre imagen y sonido (en milisegundos) del ejercicio en su campo correspondiente y pulsa el botón “Aceptar”.
+
               3. The user enters the time between image and sound in the "Time between image and sound" field and presses the "OK" button.
-
               4. La herramienta asocia el nuevo tiempo entre imagen y sonido al ejercicio que se está editando.
+
               4. The tool associates the new time between image and sound to the exercise.
-
'''17. Caso de uso: '''Cambiar tiempo entre sonido e imagen.  
+
'''17. Use case: '''Change the time between sound and image.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución.
+
       '''Preconditions: '''This editor must be running.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa el botón “Configuración del ejercicio” situado en la barra de herramientas del “Panel Pares imagen-sonido”.
+
               1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
-
               2. La herramienta muestra el panel de configuración del ejercicio.
+
               2. The tool shows the exercise configuration panel.
-
               3. El usuario introduce el tiempo entre sonido e imagen (en milisegundos) del ejercicio en su campo correspondiente y pulsa el botón “Aceptar”.
+
               3. The user enters the time between sound and image in the "Time between sound and image" field and presses the "OK" button.
-
               4. La herramienta asocia el nuevo tiempo entre sonido e imagen al ejercicio que se está editando.
+
               4. The tool associates the new time between sound and image to the exercise.
-
'''18. Caso de uso: '''Cambiar orden de aparición de los pares.  
+
'''18. Use case: '''Change pairs order.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución.
+
       '''Preconditions: '''This editor must be running.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa el botón “Configuración del ejercicio” situado en la barra de herramientas del “Panel Pares imagen-sonido”.
+
               1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
-
               2. La herramienta muestra el panel de configuración del ejercicio.
+
               2. The tool shows the exercise configuration panel.
-
               3. El usuario pulsa sobre la casilla “Orden de imágenes aleatorio” y pulsa el botón “Aceptar”.
+
               3. The user checks/unchecks the “Random image order” checkbox and presses the "OK" button.
-
               4. La herramienta cambia el orden de aparición que tendrán los pares durante la ejecución del ejercicio de normal a aleatorio o viceversa.
+
               4. The tool toggles, from normal to random or viceversa, the order that the pairs will have while playing the exercise.
-
'''19. Caso de uso: '''Cambiar modo del ejercicio.  
+
'''19. Use case: '''Change the exercise mode.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución.
+
       '''Preconditions: '''This editor must be running.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa el botón “Configuración del ejercicio” situado en la barra de herramientas del “Panel Pares imagen-sonido”.
+
               1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
-
               2. La herramienta muestra el panel de configuración del ejercicio.
+
               2. The tool shows the exercise configuration panel.
-
               3. El usuario selecciona el modo (Aprendizaje o Evaluación) en el campo “Modo” y pulsa el botón “Aceptar”.
+
               3. The user selects the mode (Learning or Evaluation) from the "Mode" field and presses the "OK" button.
-
               4. La herramienta establece el modo seleccionado para el ejercicio que se está editando.
+
               4. the tool sets the mode of the exercise that is being edited.
-
'''20. Caso de uso: '''Asignar un sonido general.  
+
'''20. Use case: '''Assign a general sound.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución.
+
       '''Preconditions: '''This editor must be running.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa el botón “Configuración del ejercicio” situado en la barra de herramientas del “Panel Pares imagen-sonido”.
+
               1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
-
               2. La herramienta muestra el panel de configuración del ejercicio.
+
               2. The tool shows the exercise configuration panel.
-
               3. El usuario busca el sonido deseado en la parte inferior del panel “Sonidos generales del ejercicio”.   
+
               3. The user looks for the desired sound in the bottom of the "General sounds of the exercise" panel.   
-
               4. Una vez localizado el sonido, el usuario pulsa sobre él para seleccionarlo y, sin soltarlo, lo arrastrará y soltará sobre uno de los sonidos generales (Enunciado, Correcto, Incorrecto y Despedida)  
+
               4. Once the sound is located, the user clicks on it to select it and, without releasing the button, he drags and drops it onto one of the general sounds (Sentence, correct, incorrect or farewell).  
-
                situados encima de este panel para asignárselo.  
+
               5. The tool associates the selected sound with that general sound.
-
               5. La herramienta asocia el sonido seleccionado al sonido general sobre el que fue soltado.  
+
-
'''21. Caso de uso: '''Quitar un sonido general.  
+
'''21. Use case: '''Remove a general sound.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución.
+
       '''Preconditions: '''This editor must be running.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa el botón “Configuración del ejercicio” situado en la barra de herramientas del “Panel Pares imagen-sonido”.
+
               1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
-
               2. La herramienta muestra el panel de configuración del ejercicio.
+
               2. The tool shows the exercise configuration panel.
-
               3. El usuario pulsa el botón "Quitar sonido" (representado por una cruz roja) que estará situado a la derecha de sonido general al que se le quiere quitar el sonido.  
+
               3. The user presses the "Remove sound" button (represented by a red cross) that is located to the right of the general sound that he wants to remove.  
-
               4. La herramienta quita el sonido general del ejercicio.
+
               4. The tool removes that general sound from the exercise.
-
'''22. Caso de uso: '''Reproducir un sonido general.  
+
'''22. Use case: '''Play a general sound.  
-
       '''Actor principal: '''Usuario.  
+
       '''Main actor: '''User.  
-
       '''Precondiciones: '''Este editor debe estar en ejecución y el sonido general debe haber sido asignado previamente.
+
       '''Preconditions: '''This editor must be running and the general sound must have been previously assigned.
-
       '''Escenario de éxito principal: '''
+
       '''Main success scenario: '''
-
               1. El usuario pulsa el botón “Configuración del ejercicio” situado en la barra de herramientas del “Panel Pares imagen-sonido”.
+
               1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
-
               2. La herramienta muestra el panel de configuración del ejercicio.
+
               2. The tool shows the exercise configuration panel.
-
               3. El usuario pulsa sobre el sonido general a reproducir (representado por la imagen de un altavoz) .  
+
               3. The user presses on the general sound that he wants to play (represented by a speaker) .  
-
               4. La herramienta reproduce el sonido general.
+
               4. The tool plays that general sound.
[[Category: Tareas]]
[[Category: Tareas]]

Current revision as of 16:54, 10 November 2011

Manual

Class diagrams

The following image shows the summarized class diagram of the manual editor of To match sound-image exercises that is part of Tareas.


To match sound-image pairs manual editor class diagram.


In the diagram above we can see that the information of the exercise that is being edited will be stored in the "CurrentEmparejarExercise" class, which has all static fields. This class also stores the information of all image-sound pairs of the exercise and each of them is represented by an instance of the "PairInfo" class.

The main panel is an object of class "EmparejarMainPanel" which contains three subpanels: "Image-sound pairs", "Images" and "Sounds".

The image-sound pairs panel ("leftPanel") is a "PreviewPanel" object which contains a toolbar and the panel that contains all the exercise pairs ("PairsPanel"). The exercise configuration panel is an "ExerciseConfigPanel" object and it is instantiated each time the user clicks on the corresponding button located in the image-sound pairs panel toolbar.

An object of type "MultimediaResourcesFilterPanel" ("rightPanel") creates two instances of the class "MultimediaFilterPanel". Each of these instances represents a panel that filters all the available multimedia resources by type (images, sounds, videos...). In this case are "Images" and "Sounds" panels.


Use cases

Use cases diagram: To match sound-image pairs.


Next, there is a textual description of the use cases of the "To match sound-image pairs" exercises manual editor.

1. Use case: Initial configuration. 

     Main actor: User. 
     Preconditions: This editor has just started to create a new exercise.
     Main success scenario: 
             1. The tool shows the user the initial configuration window.
             2. The user selects the exercise language and the number of empty pairs that will be added to it and presses the "OK" button. 
             3. The tool shows this editor which contains the new exercise with the initial configuration.

2. Use case: Add a new pair. 

     Main actor: User. 
     Preconditions: This editor must be running.
     Main success scenario: 
             1. The user presses the "Add" button located in the "Image-sound pairs" panel.
             2. The tool adds a new empty pair at the end of the image-sound pairs list.

3. Use case: Delete the selected pair. 

     Main actor: User. 
     Preconditions: This editor must be running and an image-sound pair has been selected.
     Main success scenario: 
             1. The user presses the "Delete" button located in the "Image-sound pairs" panel toolbar.
             2. The tool removes the selected pair from the image-sound pairs list.

4. Use case: The selected pair goes up. 

     Main actor: User. 
     Preconditions: This editor must be running, an image-sound pair has been selected and there must be at least one pair placed above.
     Main success scenario:  
             1. The user presses the "Up" button located in the "Image-sound pairs" panel toolbar.
             2. The tool raises the selected pair one position in the image-sound pairs list.

5. Use case: The selected pair goes down. 

     Main actor: User. 
     Preconditions: This editor must be running, an image-sound pair has been selected and there must be at least one pair placed below.
     Main success scenario:  
             1. The user presses the "Down" button located in the "Image-sound pairs" panel toolbar.
             2. The tool lowers the selected pair one position in the image-sound pairs list.

6. Use case: Change the correct/incorrect state. 

     Main actor: User. 
     Preconditions: This editor must be running and the image-sound pairs list can't be empty.
     Main success scenario:  
             1. The user clicks in the "Correct" column of a pair.
             2. The tool changes the state of that pair from correct to incorrect or viceversa.

7. Use case: Associate a sound with a pair. 

     Main actor: User. 
     Preconditions: This editor must be running and the image-sound pairs list can't be empty.
     Main success scenario: 
             1. The user looks for the desired sound in the "Sounds" panel. Once the sound is located, the user clicks on it to select it and, without releasing the button, he drags and drops it onto the "Sound" column 
                of the desired pair located in the image-sound pairs panel. 
             2. The tool associates the sound with that pair.

8. Use case: Remove the sound of a pair. 

     Main actor: User. 
     Preconditions: This editor must be running and the image-sound pairs list can't be empty.
     Main success scenario:  
             1. The user clicks with the mouse right button over the pair that he wants to remove its associated sound.
             2. The tool shows a small menu of options.
             3. The user selects the "Remove sound" option. 
             4. The tool removes the associated sound of that pair.

9. Use case: Associate an image with a pair. 

     Main actor: User. 
     Preconditions: This editor must be running and the image-sound pairs list can't be empty.
     Main success scenario:  
             1. The user looks for the desired image in the "Images" panel. Once the image is located, the user clicks on it to select it and, without releasing the button, he drags and drops it onto the "Image" column 
                of the desired pair located in the image-sound pairs panel.
             2. The tool associates the image with that pair.

10. Use case: Remove the image of a pair. 

     Main actor: User. 
     Preconditions: This editor must be running and the image-sound pairs list can't be empty.
     Main success scenario:  
             1. The user clicks with the mouse right button over the pair that he wants to remove its associated image.
             2. The tool shows a small menu of options.
             3. The user selects the "Remove image" option. 
             4. The tool removes the associated image of that pair.

11. Use case: Play a sound of a pair. 

     Main actor: User. 
     Preconditions: This editor must be running, the image-sound pairs list can't be empty and there must be at least one pair with an associated sound in the list.
     Main success scenario: 
             1. The user clicks in the "Sound" column of a pair.
             2. The tool plays the associated sound of that pair.

12. Use case: Get information. 

     Main actor: User. 
     Preconditions: This editor must be running.
     Main success scenario: 
             1. The user places the mouse cursor over any component of the editor.
             2. The tool shows the popup information about that component.

13. Use case: Edit the exercise name. 

     Main actor: User. 
     Preconditions: This editor must be running.
     Main success scenario: 
             1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
             2. The tool shows the exercise configuration panel.
             3. The user enters the exercise name in the "Name" field and presses the "OK" button.
             4. The tool associates the new name to the exercise.

14. Use case: Edit the exercise sentence. 

     Main actor: User. 
     Preconditions: This editor must be running.
     Main success scenario: 
             1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
             2. The tool shows the exercise configuration panel.
             3. The user enters the exercise sentence in the "Sentence" field and presses the "OK" button.
             4. The tool associates the new sentence to the exercise.

15. Use case: Change the time showing image. 

     Main actor: User. 
     Preconditions: This editor must be running.
     Main success scenario: 
             1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
             2. The tool shows the exercise configuration panel.
             3. The user enters the time showing image in the "Time showing image" field and presses the "OK" button.
             4. The tool associates the new time showing image to the exercise.

16. Use case: Change the time between image and sound. 

     Main actor: User. 
     Preconditions: This editor must be running.
     Main success scenario: 
             1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
             2. The tool shows the exercise configuration panel.
             3. The user enters the time between image and sound in the "Time between image and sound" field and presses the "OK" button.
             4. The tool associates the new time between image and sound to the exercise.

17. Use case: Change the time between sound and image. 

     Main actor: User. 
     Preconditions: This editor must be running.
     Main success scenario: 
             1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
             2. The tool shows the exercise configuration panel.
             3. The user enters the time between sound and image in the "Time between sound and image" field and presses the "OK" button.
             4. The tool associates the new time between sound and image to the exercise.

18. Use case: Change pairs order. 

     Main actor: User. 
     Preconditions: This editor must be running.
     Main success scenario: 
             1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
             2. The tool shows the exercise configuration panel.
             3. The user checks/unchecks the “Random image order” checkbox and presses the "OK" button.
             4. The tool toggles, from normal to random or viceversa, the order that the pairs will have while playing the exercise.

19. Use case: Change the exercise mode. 

     Main actor: User. 
     Preconditions: This editor must be running.
     Main success scenario: 
             1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
             2. The tool shows the exercise configuration panel.
             3. The user selects the mode (Learning or Evaluation) from the "Mode" field and presses the "OK" button.
             4. the tool sets the mode of the exercise that is being edited.

20. Use case: Assign a general sound. 

     Main actor: User. 
     Preconditions: This editor must be running.
     Main success scenario: 
             1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
             2. The tool shows the exercise configuration panel.
             3. The user looks for the desired sound in the bottom of the "General sounds of the exercise" panel.  
             4. Once the sound is located, the user clicks on it to select it and, without releasing the button, he drags and drops it onto one of the general sounds (Sentence, correct, incorrect or farewell). 
             5. The tool associates the selected sound with that general sound.

21. Use case: Remove a general sound. 

     Main actor: User. 
     Preconditions: This editor must be running.
     Main success scenario: 
             1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
             2. The tool shows the exercise configuration panel.
             3. The user presses the "Remove sound" button (represented by a red cross) that is located to the right of the general sound that he wants to remove. 
             4. The tool removes that general sound from the exercise.

22. Use case: Play a general sound. 

     Main actor: User. 
     Preconditions: This editor must be running and the general sound must have been previously assigned.
     Main success scenario: 
             1. The user clicks the "Exercise configuration" button located in the "Image-sound pairs" panel toolbar.
             2. The tool shows the exercise configuration panel.
             3. The user presses on the general sound that he wants to play (represented by a speaker) . 
             4. The tool plays that general sound.
Retrieved from "http://patio.lcc.uma.es/patio-wiki-en/index.php/To_match_sound-image_editor"
Personal tools