This requirements, are the list of functionalities that are expected from the solution that this project will produce.
The idea is that the requirements go from the basics, the most needed functionalities to the less frequent used ones.
The order of the things touch to make a change is first reconcile the new requirements with the previous ones in this document, then make changes in the design and then make the changes in the files of the source code.
This project consists of 2 sub-parts. The core, the base part, a library that facilitates text files management, fixed with ones, as well as delimited ones, through predefine file formats. The second part a graphical interface to elaborate, formats and also to work with files in those formats. Work with this files means create them, edit, but also convert them to other formats.
Esta es la parte de la librería que es el núcleo del proyecto. Este núcleo va a requerir las siguientes funcionalidades:
- La librería tiene que ser escrita en HAXE
- Apartir de la versión de HAXE tienen que construirse otras versiones
- Versión para python
- Versión para csharp
- La librería puede abrir ficheros a partir de un formato.
- Pueden ser ficheros de texto de columnas de ancho fijo.
- Pueden ser fichero de texto separados por coma
- Se puede elegir el formato de las columnas:
- Columnas de texto
- Columnas de números enteros
- Columnas de números decimales con precisión arbitrária elegida por el usuario.
- Columnas de fecha y hora.
- Columnas con solo fecha.
- Columnas con solo hora.
- Se pueden crear reglas de validación para esos ficheros.
- Validar que una columna solo debe contener digitos decimales.
- Validar que una columna debe contener un número decimal válido.
- Validar que los registros de un fichero de ancho fijo tengan la cantidad de texto esperado y no más y no menos.
- Validar que un fichero separado por comas tenga la cantidad de columnas que se esperan, o sea la cantidad de separadores correctos.
- Validar que una columna contenga en todos los registros fechas válidas.
- Validar que una columna de texto todos los caracteres se puedan codificar en la codificación de texto actual.
- Una validación que establezca que una columna no puede estar en blanco.
- Una validación que establezca una lista blanca de valores que puede tener una columna.
- Una validación que establezca una lista negra de valores que no puede contener una columna.
- Una validación que establezca que en una columna todos los registros deben coincidir con una expresión regular.
- La librería tiene que ir acompañada de un banco de pruebas y de un programita para ejecutar esas pruebas.
- Un fichero puede tener varios bloques
- Se le puede pedir al programa que haga un sumario de una o de varias columnas númericas.
- se le puede pedir al programa que cuente los registros que contiene un fichero en un bloque.
- La librería hace conversión entre el texto y la data que representa en forma de tipos de datos nativos.
- La librería debería ser lo más fácil de usar que sea posible (tomar como ejemplo la librería csv de python).
- El formato de un fichero puede establecer columnas con valores literales fijos.
- Los ficheros de formato son ficheros que pueden ser manejados por el propio programa.
- Los ficheros de formato tienen que cumplir con un formato, el formato de los formatos.
Para el futuro
- La librería puede manejar ficheros de gran volúmen, ej: 9GB, 10GB evitando cargar toda la data en memoria al mismo tiempo, cargando partes del fichero a demanda según el usuario se va moviendo por el texto.
- The library can be used to parse text streams that behave like fixed width text files, just intead of files, network data packages.
- Se puede poner en el formato la codificación de texto que usa el fichero.
- Soporta data en formato XML.
- Soporta data en formato json.
- Que el programa trate de adivinar el formato de un fichero.
- Se puede abrir ficheros de texto de ancho fijo y separados por coma.
- Se puede editar los campos de texto del fichero.
- Se puede salvar el fichero modificado.
- Se puede crear un fichero que tiene el formato del fichero de texto.
- El usuario puede mantener un inventario de formatos de ficheros.
- El usuario puede abrir un fichero de texto que contiene datos y seleccionar el formato de ese fichero.
- El programa muestra el contenido de ese fichero de datos en una cuadrícula.
- El programa permite ordenar la tabla del texto por cualquiera de las columnas que posee los datos.
- El programa pone automáticamente de primero una columna con el número de cada registro.
- El programa está implementado en python tk con la versión moderna del GUI.
- El programa usa libteddet para abrir los ficheros y los formatos y para escribir la data y los formatos.
- Cuando se abre un fichero de columnas de ancho fijo se muestra en la parte superior de la tabla una regla en la que se ve el tamaño en caracteres de cada campo alineado con las columnas de la tabla.
- El texto en la tabla usa un tipo de letra mono, de ancho fijo de modo que no se distorcione el ancho del texto.
- Se puede leer un fichero en un formato, por ejemplo CSV y luego exportarlo a otro formato, a un fichero de columnas de ancho-fijo y viceversa.
- Tiene que soportar drag and drop para abrir ficheros que se sueltan dentro de la ventana.
- Al formato se le pueden poner validaciones para el fichero.
- El programa tiene que mostrar una lista con los errores de validación.
- Las validaciones tienen mensajes explicitos entendibles que se pueden usar para endender porque una validación no está pasando.
- Cuando se hace clic en el mensaje de error la grilla enfoca ese elemento que tiene problemas.
- Dentro de la propia tabla se marcan los elementos que infringen alguna validación, si es una sola celda, esa celda, si es toda una colmuna esa columna, si es una fila completa, esa fila.
- Si un elemento está marcado porque tiene un error, fila, columna, celda, cuando se toca ese elemento se muestra un mensaje con la validación que está infringiendo.
Para el futuro:
- El programa puede manejar fichero de gran volúmen, ej: 9GB, 10GB cargando pedazos del fichero en la memoria por partes según vaya siendo necesario.