doc/gui.lyx

   1 #LyX 1.3 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 221
   3 \textclass article
   4 \language spanish
   5 \inputencoding auto
   6 \fontscheme palatino
   7 \graphics default
   8 \paperfontsize 10
   9 \spacing single
  10 \papersize Default
  11 \paperpackage a4
  12 \use_geometry 1
  13 \use_amsmath 0
  14 \use_natbib 0
  15 \use_numerical_citations 0
  16 \paperorientation portrait
  17 \leftmargin 2cm
  18 \topmargin 1cm
  19 \rightmargin 1cm
  20 \bottommargin 2cm
  21 \secnumdepth 3
  22 \tocdepth 3
  23 \paragraph_separation indent
  24 \defskip medskip
  25 \quotes_language english
  26 \quotes_times 2
  27 \papercolumns 1
  28 \papersides 1
  29 \paperpagestyle default
  30 \bullet 1
  31         0
  32         24
  33         -1
  34 \end_bullet
  35
  36 \layout Title
  37
  38 EMUFS Viewer
  39 \layout Section
  40
  41 Introducción
  42 \layout Standard
  43
  44 La interfaz de visualización de EMUFS permite interactuar con los distintos
  45  tipos de archivos para cada conjunto de datos almacenado (ya sean facturas,
  46  articulos, o notas de facturas).
  47 \layout Section
  48
  49 Línea de comandos
  50 \layout Standard
  51
  52 El programa acepta varios parámetros, algunos de ellos opcionales, otros
  53  obligatorios dependiendo de las elecciones realizadas.
  54 \layout Standard
  55
  56 Para obtener una completa descripción de los parámetros el programa acepta
  57
  58 \begin_inset Quotes eld
  59 \end_inset
  60
  61 -h
  62 \begin_inset Quotes erd
  63 \end_inset
  64
  65  o
  66 \begin_inset Quotes eld
  67 \end_inset
  68
  69 --help
  70 \begin_inset Quotes erd
  71 \end_inset
  72
  73  para mostrar una ayuda en línea.
  74 \layout Standard
  75
  76 Si el programa es ejecutado sin parámetros tratará de recuperar los artículos
  77  y las facturas desde archivo previamente creados.
  78 \layout Standard
  79
  80 Para crear un archivo de artículos a partir de un archivo XML bien formado,
  81  se debe ejecutar el programa con la opción
  82 \begin_inset Quotes eld
  83 \end_inset
  84
  85 -a
  86 \begin_inset Quotes erd
  87 \end_inset
  88
  89 .
  90  Dicha opción espera que el siguiente parámetro sea el nombre del archivo
  91  a leer, y que éste útimo tenga extensión xml (notar que es solo minúsculas).
  92  A continuación espera encontrar el tipo de archivo que se quiere crear,
  93  pudiendo ser éste último 1, 2 ó 3.
  94  De ser el tipo de archivo con bloques, se le exigirá que ingrese como último
  95  parámetro el tamaño del mismo.
  96 \layout Standard
  97
  98 Para crear el archivo de facturas es el mismo procedimiento, solo que utilizando
  99  el parámetro
 100 \begin_inset Quotes eld
 101 \end_inset
 102
 103 -f
 104 \begin_inset Quotes erd
 105 \end_inset
 106
 107 .
 108  El archivo de notas es creado por el sistema de tipo 2 por defecto y no
 109  puede ser cambiado desde la línea de comandos.
 110  Para ello puede utilizar la opción correspondiente del menú mantenimiento.
 111 \layout Standard
 112
 113 Debe saber que estos parámetros no son mutuamente excluyentes, por lo que
 114  podrá utilizarlos al mismo tiempo.
 115 \layout Section
 116
 117 Características
 118 \layout Standard
 119
 120 A continuación se da una lista detallada de las operaciones que son posibles
 121  hacerse desde esta interfaz :
 122 \layout Itemize
 123
 124 Alta, baja y modificación de Artículos.
 125  Para ello se abrirá una ventana donde se podrá editar comodamente los datos.
 126 \layout Itemize
 127
 128 Alta, baja y modificación
 129 \begin_inset Foot
 130 collapsed true
 131
 132 \layout Standard
 133
 134 En la modificación de una factura no se podrán cambiar ni la cantidad de
 135  items y los datos de los mismo!
 136 \end_inset
 137
 138  de Facturas.
 139 \layout Itemize
 140
 141 Ver registros.
 142  Ver fisicamente los registros de cualquiera de los archivos sin importar
 143  el tipo al que pertenezcan.
 144  Desde aquí podrá tambien eliminar, agregar o modificar el registro actual.
 145 \layout Itemize
 146
 147 Ver Bloques.
 148  Para aquellos archivos que hallan sido creados con un tipo con bloques,
 149  podrá verlos fisicamente, viendo el bloque actual y los anteriores/posteriores.
 150 \layout Itemize
 151
 152 Ver las estadísticas de cada archivo según su tipo, para realizar comparativas
 153 \layout Itemize
 154
 155 Cambiar el formato de cualquier tipo o parametros de archivo.
 156 \layout Itemize
 157
 158 Compactar los archivos.
 159 \layout Section
 160
 161 Decisiones de Diseño
 162 \layout Standard
 163
 164 Durante el desarrollo se han tomado ciertas decisiones en el diseño o restriccio
 165 nes.
 166  En este punto nos centraremos en las especificas tomadas por la interfaz
 167  de visualización, y no tomaremos en cuenta las que ponen los tipos de archivo
 168  por si solos.
 169 \layout Enumerate
 170
 171 La cantidad de items por factura es igual a 10 para archivos de registro
 172  de longitud fija y bloque parametrizado (TIPO 3).
 173  Esta decición fue tomada por poner un valor típico de items que puede haber
 174  en una factura.
 175  Como el tipo de archivo permite cortar un registro y guardarlo en varios
 176  bloques consecutivos, la restricción de cantidad solo es un hecho de elección,
 177  y así pusieramos 100, 1000, 10000 no habría diferencia, ya que el tipo
 178  de archivo lo guardaría sin problemas.
 179 \layout Enumerate
 180
 181 Si el archivo es de TIPO 3 y se agregan más de 10 items estos son truncados
 182  y descartados sin aviso al usuario.
 183  Esta fue una desición basada en el tiempo del proyecto.
 184  De tener que validar y consultar al usuario se hubiera perdido tiempo de
 185  mucho valor para completar objetivos más importantes del TP.
 186 \layout Enumerate
 187
 188 Los campos son delimitados por el caracter nulo (en caso de los strings)
 189  y por la longitud del tipo de dato en caso de los campos numéricos.
 190  De esta forma se aprovechan las características de manejo de string en
 191  C.
 192 \layout Enumerate
 193
 194 Cuando se leen registros que ocupan más de un bloque, solo se jutan todos
 195  los bloques que ocupa dicho registro y eso es mostrado al usuario.
 196  Fue diseñado de esta manera debido a que parsear la data binaria que contiene
 197  el archivo requiere saber donde esta, cuanto ocupa y como tratarla.
 198  De permitir mostrar registros incompletos, complicaría mucho más le parser
 199  actual, ya que por ejemplo podríamos tener que un campo entero (un int
 200  de 4 bytes) empiece en el registro actual y termine en el siguiente.
 201 \layout Section
 202
 203 Vista de Registros
 204 \layout Standard
 205
 206 Un ejemplo de vista de registros es la que se observa a continuación :
 207 \layout Standard
 208
 209
 210 \begin_inset Graphics
 211         filename /home/share/programacion/FIUBA/Datos/emufs/doc/gui_ver_registros.eps
 212         scale 95
 213         keepAspectRatio
 214
 215 \end_inset
 216
 217
 218 \layout Standard
 219
 220 Como puede verse el registro actual se ve resaltado respecto de los demás.
 221  También se puede observar que en este caso (el bloque es de 2000 bytes)
 222  no entra toda la información en pantalla, pero es posible desplazar utilizando
 223  las teclas A y Z.
 224 \layout Standard
 225
 226 Los datos binarios son convertidos a texto para ser mostrados, siendo la
 227  representación elegida :
 228 \layout Itemize
 229
 230 [XXX] : Son valores numéricos perteneciente a los datos (numero de factura,
 231  numero de artículo, etc)
 232 \layout Itemize
 233
 234 (XXX) : Representa un ID.
 235  En el caso de las facturas también aparece en los datos el número de índice
 236  de la nota asociada con esta representación.
 237 \layout Itemize
 238
 239 {XXX} : Representa el tamaño de los datos.
 240  Esto siempre y cuando el registro sea de longitud variable (TIPO1 y TIPO2).
 241 \layout Standard
 242
 243 También es posible ejecutar acciones de edición sobre el registro seleccioado,
 244  así como buscar por ID de registro.
 245 \the_end