documentss

18
ESTÁNDARES DEFINIDOS PARA EL MODELO LÓGICO 1. DISEÑO DE CLASES El nombre de los diagramas de clases debe cumplir el siguiente estándar: NombreSubsistemaFuncionalidad La clase se diseña: - Empezando con el estereotipo que se define más adelante. - El nombre de la clase empieza con mayúscula, sin espacios, si tiene mas de una palabra cada una de ellas empezara con mayúscula. El nombre de la clase no debe contener acentos (aunque la palabra los tenga) y ningún otro símbolos (por ejemplo: _, -, $, #, etc.) - En el siguiente recuadro entran los atributos de la clase - El nombre del atributo comienza con minúscula, si el atributo estuviera conformado por dos palabras la segunda palabra comenzara con Mayúscula - En el tercer recuadro se coloca los métodos de la clase. Para escribir el nombre del método se seguirá el mismo estándar definido para el nombre del atributo Clase Estereotipo Estereotipo Gráfico Color Clase Contribuyent <<Contribuyente>>

Upload: mail3shen

Post on 17-Nov-2015

212 views

Category:

Documents


0 download

DESCRIPTION

ss

TRANSCRIPT

DISEO

Estndares Definidos para el Modelo Lgico

1.DISEO DE CLASES

El nombre de los diagramas de clases debe cumplir el siguiente estndar:

NombreSubsistemaFuncionalidad

La clase se disea:

Empezando con el estereotipo que se define ms adelante.

El nombre de la clase empieza con mayscula, sin espacios, si tiene mas de una palabra cada una de ellas empezara con mayscula. El nombre de la clase no debe contener acentos (aunque la palabra los tenga) y ningn otro smbolos (por ejemplo: _, -, $, #, etc.)

En el siguiente recuadro entran los atributos de la clase El nombre del atributo comienza con minscula, si el atributo estuviera conformado por dos palabras la segunda palabra comenzara con Mayscula En el tercer recuadro se coloca los mtodos de la clase. Para escribir el nombre del mtodo se seguir el mismo estndar definido para el nombre del atributo

ClaseEstereotipoEstereotipo GrficoColor

Clase Contribuyente

Clase ActEco

Clase Inmueble

Clase Vehculo

Clase Paramtrica

Clase Lista

Depende del Rubro

Clase Elemento Comun

Clase Almacen

El tipo de Clases puede ir aumentando conforme se avance en el desarrollo del proyecto.

Cada clase debe pertenecer al menos a uno de los Estereotipos mencionados en la tabla anterior y debe ser identificada mediante el color definido. Los colores utilizados para el primer subsistema se encuentran en la primer fila de la figura que se muestra a continuacin, para el segundo Sub Sistema se utilizara la segunda fila de Colores pero manteniendo el orden de las columnas y as sucesivamente:

1er Sub sistema

2do Sub sistema

3ro Sub sistema

4to Sub sistema

2.DISEO DE ATRIBUTOSLos estndares para definir un atributo son:

Los atributos siempre deben ser privados.

El nombre del atributo debe empezar con minscula

Si tiene ms de una palabra no debe tener espacios y a partir de la segunda palabra debe empezar la primera letra con mayscula.

El nombre de cada atributo no debe contener ningn otro smbolo adems de las letras del alfabeto

El nombre del atributo debe ser lo mas descriptivo posible, donde el formato es:

nombreAtributo : TipoDato

Luego de escribir el nombre del atributo se debe colocar el tipo de dato que ser de acuerdo a la siguiente tabla y su posterior generacin en el Modelo de Datos.

Tipos de datos

Modelo LgicoModelo de Datos*

BooleanVARCHAR2(1)

ByteNUMBER(5,0)

DateDATE

DoubleNUMBER(10,2)

IntegerNUMBER(10,0)

StringVARCHAR2(255)

* La longitud del tipo de datos en el Modelo de Datos puede variar en funcin a la necesidad de cada atributo

Es importante mantener el nombre tal y como est descrito en la tabla los tipos de datos, respetando la mayscula y minsculas

El orden de los atributos est determinado de la siguiente manera:

atributoNombre (atributos que describen o dan identificacin a la clase)

atributoValores (atributos que muestran el valor numrico de datos que corresponden a la clase)

atributosOtros (atributos que no estn contemplados en los anteriores, a excepcin de los que indican valores de otras tablas)

atributoEstado (atributos que indican valores de otras tablas, como por ejemplo estadoID, unidadID, etc)

3.DISEO DE MTODOSNo se especifican mtodos en el modelo lgico, esto es competencia de codificacin.

4.DISTRIBUCIN DE LAS TABLAS

TablasDescripcinUbicacin

Tablas por RubroTablas propias de cada uno de los rubrosSe encuentran en el paquete de cada rubro

Tablas ParamtricasTablas que se utilizan en diferentes rubrosSe encuentran en el paquete parmetros generales

ListasTablas tipo lista por cada uno de los rubrosSe encuentran en el paquete parmetros de cada rubro.

Ejemplo:

- Parmetros Contribuyente

5.DISEO DE LA DOCUMENTACIN Cada clase debe tener una documentacin que justifique su existencia de manera clara y directa. De la misma manera cada atributo debe estar documentado.El formato de la documentacin es el siguiente:

Descripcin

Esta es la documentacin y explicacin breve de la clase o atributo que se esta diseando, la explicacin debe ser sencilla y acompaada de algn ejemplo si es necesario

Ejemplo1

Descripcin de la conformacin de la clase o atributo y/o un listado corto de los posibles valores que tendr este atributo o clase

Ejemplo2

Otra descripcin corta de ejemplo de atributo o clase

Ejemplo n

..

5.DISEO DE RELACIONESLas relaciones que se pueden utilizar son las siguientes:

-Asociacin

La relacin de asociacin ser utilizada cuando exista conexin directa entre dos clases.

-Composicin

La relacin de composicin ser utilizada cuando exista relacin entre dos clases entre las cuales existe una relacin de dependencia. Agregacin

La relacin de agregacin ser utilizada cuando exista relacin entre dos clases entre las cuales existe una relacin de pertenencia.

-Herencia

La relacin de herencia ser utilizada cuando exista una descripcin de lo general a lo especfico (padre - hijo).

-Clase de AsociacinLa clase de asociacin ser utilizada a partir de una relacin de muchos a muchos.

Anexo N 3Estndares Definidos para el Modelo de Datos1.OBJETIVOEl objetivo de este documento es especificar los estndares para el Modelo de Datos, determinar estndares para Tablas, Campos, Mtodos, Tipos de Datos, Longitud de Campo, Orden de Campos y Documentacin.

2.DISTRIBUCIN DE RUBROSPara diferenciar en el Modelo de Datos las tablas que pertenecen a cada rubro, se utilizarn colores, tambin se diferencian aquellas tablas que pertenecen a parmetros generales y las tablas lista.

La disposicin de colores variar dependiendo del subsistema

La distribucin de los colores es la siguiente:

S1

S2

El color de las tablas lista es el mismo que del Rubro al que pertenecen.2.ESTNDARES PARA DIAGRAMA DE DATOS

El nombre de los diagramas de datos debe cumplir el siguiente estndar:NombreSubsistemaFuncionalidad

3.ESTNDARES EN TABLAS

Las tablas se generan a partir del modelo lgico, sin embargo, el resultado de esta generacin no siempre cumple con un formato, por este motivo se definen los siguientes estndares.

Las tablas para cualquier rubro deben cumplir con las siguientes caractersticas:

La primera letra del nombre de tabla debe ser mayscula.

Si es un nombre compuesto por varias palabras, cada palabra debe empezar con mayscula.

El nombre de la tabla no debe tener espacios.

El nombre de la tabla debe estar en singular.

El nombre de la tabla no debe tener artculos.

El nombre de tabla no debe tener abreviaturas a excepcin de Actividades Econmicas (ActEco).

El nombre de tabla no debe tener smbolos (_, -, $, #), tildes, etc.

4.ESTNDARES EN CAMPOS

Los campos para cualquier tabla deben cumplir con las siguientes caractersticas:

La primera letra del nombre de campo debe ser minscula.

Si es un nombre compuesto por varias palabras, la palabra intermedia debe empezar con mayscula.

El nombre del campo no debe tener espacios.

El nombre del campo no debe tener abreviaturas.

El nombre del campo no debe tener smbolos (_, -, $, #), tildes, etc.

Ejemplo:

4.1Tipos de Datos

Los tipos de datos que se utilizan son los siguientes:

Tipo de Datos *

VARCHAR2

NUMBER

DATE

* Ms adelante se especfica la longitud de cada tipo de dato, ya que esta depende del campo.

La conversin del modelo lgico al modelo de datos es la siguiente:

Tipos de datos

Modelo LgicoModelo de Datos*

BooleanVARCHAR2(1)

ByteNUMBER(5,0)

DateDATE

DoubleNUMBER(10,2)

IntegerNUMBER(10,0)

StringVARCHAR2(255)

4.2Longitud de Datos

La longitud de los datos depende del campo, ms adelante, se tiene un estndar para campos comunes entre los rubros.

5.CLASIFICACIN Y DISTRIBUCIN DE TABLAS

5.1Clasificacin de las Tablas

TablasDescripcinUbicacin

Tablas por RubroTablas propias de cada uno de los rubrosSe encuentran en el paquete de cada rubro

Tablas ParamtricasTablas que se utilizan en diferentes rubrosSe encuentran en el paquete parmetros generales

ListasTablas tipo lista por cada uno de los rubrosEn el modelo de datos se encuentran en el mismo paquete que las Tablas Rubro, en el modelo lgico, se encuentran en el paquete parmetros por rubro

5.2Distribucin de Campos en Tablas

Dentro de cada tabla tenemos la siguiente distribucin de campos:

CampoDescripcin

Llave PrimariaDependiendo del tamao de la tabla se distinguen dos tipos de datos y tres longitudes.

Si la tabla es de Asociacin, la llave primaria ser la composicin de las llaves de las tablas origen.

Campos de TablaLos campos pertenecientes a listas tienen un estndar

Los otros campos dependen de la tabla

Llaves ForneasLas llaves forneas dependen de la tabla origen

EstadoIDTodas las tablas tienen este campo

5.2.1Llave Primaria

La llave primaria debe contar con las siguientes caractersticas:

Cumplir con las mismas caracterstica de los campos

Debe ser Privada

El Tipo de Dato debe ser Number o Varchar2 dependiendo de la tabla

La longitud varia dependiendo de la tabla

No tiene valor nulo

5.2.2Campos de Tabla

A pesar de que los campos dependen de la tabla, se tiene los siguientes estndares:

CampoTipo de DatoLongitudTipo Tabla

LlavesNumber

Varchar2 (Listas)10 13(PMC)

5

3 5 (Listas)Todas

NombreVarchar250

80Lista

DescripcinVarchar2100

255

Otros Todas

FechaDateTodas

AbreviaturasVarchar25Todas

SiglaVarchar210Todas

CdigosVarchar220Otras

NmerosNumber3

10Otras

ObservacionesVarchar2255Todas

CantidadNumber10Otras

ValorNumber10,2Otras

Valor especficoNumber10,4

20,6Otras

TiempoNumber5Otras

GestinNumber4Otras

EstadoIDVarchar23Todas

Se debe tomar en cuenta que la longitud de los campos vara segn la tabla. y la necesidad

5.2.3Llaves Forneas

Las caractersticas que deben cumplir las llaves forneas son similares a las de las llaves primarias, a excepcin de que pueden tener valor nulo.

La disposicin de las llaves forneas es como se describi anteriormente, sin embargo, si existen campos que dependan de la llave fornea la distribucin cambia de la siguiente manera:

CampoDescripcin

Llave Primaria

Campo ACampo que depende de la llave fornea

Llave Fornea ALas llaves forneas dependen de la tabla a la que pertenecen

Campo B

Llave Fornea B

EstadoIDTodas las tablas tienen este campo

6.RELACIONES ENTRE TABLASComo el modelo de datos se genera a partir del modelo lgico, la generacin de llaves depende de las relaciones plasmadas en el modelo lgico.

Se debe considerar el siguiente estndar para las mismas:

6.1Relacin de Asociacin

Modelo Lgico

Modelo Datos

Como se puede observar este tipo de relacin genera una Llave Fornea en la tabla que tiene como multiplicidad muchos (Usuario), esta ltima genera su propia llave primaria.6.2Relacin de Composicin

Modelo Lgico

Modelo Datos

La composicin genera la llave de la tabla compuesta (Proceso) en la tabla que compone (Subproceso), en esta ltima se genera una llave primaria.6.3Relacin de Herencia

Modelo Lgico

Modelo DatosComo se puede observar, la herencia genera la llave de la tabla padre (Persona) en la tabla hijo (Usuario), en esta ultima no se genera ninguna otra llave. 6.4Clase de Asociacin

Se presentan dos tipos de asociacin, aquella en la que la tabla de asociacin tiene como llave principal, las llaves de las tablas origen; y aquella en la que la tabla de asociacin tiene su propia llave principal.

Tipo Asociacin 1

Modelo Lgico

Modelo Datos

Tipo Asociacin 2

Modelo Lgico

Modelo Datos

Si la tabla de asociacin se relaciona con otras tablas, entonces se debe utilizar el Tipo de Asociacin 2, caso contrario se utilizar el Tipo de Asociacin 1. 7.ESTNDARES DE DOCUMENTACIN

Al igual que en el modelo lgico, en el modelo de datos las tablas y los campos deben estar documentados; partiendo de que el modelo de datos se genera a partir del modelo de lgico, toda la documentacin del modelo lgico pasa al modelo de datos, sin embargo, para aquellas tablas, campos y relaciones que se creen directamente en el modelo de datos, se debe seguir los siguientes estndares.

.

Herencia

EMBED Visio.Drawing.11

Clase de Asociacin

Agregacin

Asociacin

RUBROS

S1

S2

S3

S4

S5

S6

S7

S8

SUB SISTEMAS

Contribuyentes

Actividades Econmicas

Vehculos

Inmuebles

Parmetros

Almacenes

Almacenes

Parmetros

Inmuebles

Vehculos

Actividades Econmicas

Contribuyentes

Forma Incorrecta

Forma Correcta

Descripcin

Explicacin breve y sencilla ya sea de la tabla o del campo.

Ejemplo 1

Descripcin ejemplo 1

Ejemplo 2

Descripcin ejemplo 2.

Composicin

_1156865553.vsd

Nota Interna