Entidade COMPONENTES

ADS_COMPS.COMPONENTES

Descri��o

Um componente � elemento chave para o detalhamentos dos sistemas feito pelo ADS.
Um componente � qualquer elemento que faz parte do sistema. Cada componente deve ser devidamente classificado, pode ser dividido em sub-componentes, referenciar-se a outros componentes, etc.

Existem componente extremamente complexos (ex: um sistema � representado por um componente) da mesma forma que existem componentes extremamente simples (ex: o par�metro de uma fun��o).

Alguns exemplos de componentes s�o:

Um sistema
Uma classe
Uma interface
Um evento
Uma tabela
Um m�todo
etc.

Os componentes estabelecem necessidades e funcionalidades de forma descritiva e permite contextualizar estas necessidades vinculando-as umas com as outras.

Durante o processo de desenvolvimento, os componentes s�o incialmente criados com uma conota��o conceitual e v�o sendo sistematicamente especializados at� poderem ser implementados fisicamente em alguma linguagem de programa��o.

Alguns componentes s�o criados apenas para criar defini��es gerais, tais como tipos de dados, eventos, etc.. Nestes componentes pode-se definir como eles dever�o ser implementados.

Atributos

Atributo	Dom�nio	Regras	Descri��o
ID	ID(18)	Rqd PK	ID: N�mero de identifica��o do componente.
TIPO_COMPONENTE_ID	ID(18)	Rqd FK	Tipo de componente Refer�ncia para TIPOS_COMPONENTES
NOME	UPPER(80)	Rqd UK AK	Nome: Nome dado para identificar o componente.
NOME_CURTO	UPPER(80)		Nome curto: Nome curto do componente. Normalmente � uma abrevia��o ou alias de seu nome completo.
NOME_GLOBAL	UPPER(300)	UK	Nome global: Indica o nome global do componente. Se o componente for raiz (n�o tem pai), ent�o o nome global ser� igual ao nome do componente. Se o componente n�o for raiz (tem pai), ent�o o nome global � formado pelo nome global do componente pai + "." + nome do componente. Ex: ADS, ADS.COMPONENTES, ADS.COMPONENTES.NOME_GLOBAL
TITULO	TEXT(300)		T�tulo: T�tulo do componente para fins conceituais.
DESCRICAO	TEXT_LONG		Descri��o: Texto livre para descri��o do componente. Esta descri��o inclui o que o componente representa, quais as funcionalidades que ele tem, o que ele representa e quando necess�rio d� um breve resumo de como ele funciona. Ver ADS_COMPS.TIPOS_COMPONENTES
DESCRICAO_CURTA	TEXT_LONG		Descri��o curta: Texto que descreve o componente resumido em uma �nica linha. Usado para documenta��o do sistema em locais onde n�o � necess�rio entrar em detalhes (ex: "hint" de uma interface). Dependendo do tipo de componente, a descri��o curta � o seu objetivo (porque o sistema precisa deste componente?).
VALOR	TEXT(300)		Valor: Valor inicial do componente quando aplic�vel.
OPCIONAL	FLAG(1)		Opcional: Indica quando o preenchimento do componente � considerado opcional ou n�o. Em alguns casos, tamb�m pode indicar quando um componente � p�blico. Valor padr�o = S
PAI_COMP_ID	ID(18)	UK FK	Pai Refer�ncia para COMPONENTES
REF_COMP_ID	ID(18)	FK	Referencia Refer�ncia para COMPONENTES
DOMINIO_COMP_ID	ID(18)	FK	Dom�nio: Quando preenchido, indica que o componente atual herda todas as funcionalidades de um outro componente. Muitas vezes est� associado ao tipo de dado que o componente retorna ou representa. Refer�ncia para COMPONENTES
SEQUENCIA	INTEGER		Sequencia: N�mero de sequencia deste componente. Normalmente define a ordem dos componentes com rela��o ao seu escopo.
TAMANHO	INTEGER		Tamanho: Determina o tamanho do componente.
LARGURA	INTEGER		Largura: Estabelece a largura do componente onde isso faz algum sentido. Ex: Para atributos, a largura indica o n�mero de caracteres utilizados pelos ��tens de interface relacionados com o mesmo.
ALTURA	INTEGER		Altura: Estabelece a altura do componente onde isso faz sentido. Ex: Para atributos, a altura indica o n�mero de linhas utilizados pelos ��tens de interface relacionados com o mesmo.
NOTAS	TEXT_LONG		Notas
SITUACAO	OPCAO(1)		Situa��o: Informa qual a situa��o do componente com rela��o ao seu ciclo de vida. Este atributo � calculado automaticamente conforme as diversas datas de controles existentes. O ciclo normal de um componente �: Candidato > Pendente > Implementado > Aprovado. Valores permitidos: A - Aprovado - O componente foi aprovado. Isso significa que ele foi devidamente conceituado, implementado, testado e aprovado pelo cliente final. Componentes aprovados n�o podem ser alterados a n�o ser atrav�s de um processo de revis�o. P - Pendente - O componente ainda n�o foi aprovado.
VERSAO	INTEGER		Vers�o: N�mero de vers�o do componente. Informa quantos ciclos de aprova��o/revis�o j� ocorreram no mesmo. Valor padr�o = 1
DATA_APROVACAO	DATE		Data de aprova��o: Data em que este componente foi aprovado.
DATA_INCLUSAO	DATE		Data da inclus�o: Data em que o componente foi criado. Valor padr�o = [SYSDATE]
DATA_MODIFICACAO	DATE		Data da modifica��o: Data em que o registro foi modificado da �ltima vez. Pode ser a data da inclus�o. Valor padr�o = [SYSDATE]
USUARIO_INCLUSAO_ID	ID(18)	FK	Usu�rio da inclus�o: Indica o usu�rio que inseriu o componente no sistema. Valor padr�o = [USER_ID] Refer�ncia para USUARIOS
USUARIO_MODIFICACAO_ID	ID(18)	FK	Usu�rio da modifica��o: Indica o usu�rio que fez a �ltima altera��o no componente (pode ser a pr�pria inclus�o). Valor padr�o = [USER_ID] Refer�ncia para USUARIOS
POLITICA_ACESSO	OPCAO(1)		Pol�tica de acesso: Determina como deve ser o controle de acesso deste componente. Valores permitidos: R - Restrito - A opera��o � restrita a usu�rios que tenham acesso espec�fico a mesma. Para os outros usu�rios, a opera��o � sequer apresentada. E - Exige credencial - A opera��o exige a credencial de um usu�rio com este direito de acesso no momento da sua execu��o. Neste caso, caso o usu�rio da sess�o corrente n�o possuir esta credencial, o sistema ir� pedir as credenciais de um usu�rio que as tenha. Ao contr�rio da pol�tica de acesso "Restrito", a opera��o � vis�vel para qualquer usu�rio que tenha acesso a uma opera��o de entrada do bloco, mas caso ele n�o tenha o direito de acesso espec�fico, o sistema ir� pedir as credencias de algu�m que tenha este direito. Ver Pol�tica de acesso "Exige credencial" U - Usu�rio - Todos os usu�rios logados tem acesso a este elemento. P - P�blico - Qualquer um tem acesso a este elemento (mesmo usu�rios n�o logados)
TEXT_04	TEXT		Texto livre 4: Atributo gen�rico de texto 4.
RAIZ_ID	ID(18)	FK	Raiz: Componente raiz ao qual o componente faz parte. Este atributo contribui para diversas regras que s�o definidas atrav�s do sistema do componente. Quando o componente tem pai, o seu componente raiz ser� sempre igual ao do pai, caso contr�rio, o seu sistema ser� o pr�prio componente. Refer�ncia para COMPONENTES
DATA_MODIFICACAO_ESTRUTURA	DATE_TIME		Ultima altera��o estrutura: Data em que este componente ou algum de seus filhos foi alterada. Esta data � automaticamente atualizada sempre que este componentes ou algum dos componentes filhos � alterado. Valor padr�o = [SYSDATE]
USUARIO_MODIFICACAO_ESTRUTURA_ID	ID(18)	FK	Usu�rio que modificou estrutura: Indica o ultimo usu�rio que modificou algum componente da estrutura deste componente. Valor padr�o = [USER_ID] Refer�ncia para USUARIOS
INDEXAR	FLAG(1)	Rqd AK	Indexar: Indica se este componente dever� ser inclu�do no mecanismo de indexa��o para acelerar as pesquisas de documenta��o. Este valor � automaticamente atualizado sempre que o componente que os valores do t�tulo ou descri��o do componente forem alterados e ele for de um tipo de componente que deve ser indexado. Valor padr�o = N
SUBSTITUIDO_POR_ID	ID(18)	FK	Substitu�do por: Quando informado indica que este componente foi substitu�do por outro e est� obsoleto. - ERROR: N�o foi poss�vel encontrar um registro em COMPONENTES onde NOME_GLOBAL = !. Refer�ncia para COMPONENTES

Regras

Criar FK para atributo

(Depois de inserir, Depois de alterar)

Quando o atributo apontar para uma entidade, criar uma FK e alterar o dom�nio para ID.

Calcular situa��o

(Antes de inserir, Antes de alterar)

Ver documenta��o do atributo

Zerar os dominios dos filhos

(Antes de excluir)

Limpa em cascata os dom�nios de todos os filhos deste componente. Este procedimento � necess�rio para eliminar inter-depend�ncias entre os componentes antes de fazer uma exclus�o em cascata.

Garantir um nome para o componente

(Antes de alterar, Antes de inserir)

Caso o nome n�o tenha sido informado, calcula um automaticamente da seguinte forma:
1) Se for um REQUISITO, ser� REQ-9999 onde 9999 � o n�mero de requisitos j� cadastrados + 1 (max da sequencia)
2) Nome do tipo de componente + ID.

Calcular nome global

(Antes de inserir, Antes de alterar)

Se o componente n�o tem pai, ent�o o seu nome global � igual ao nome. Se o componente tem pai, ent�o o seu nome global � igual ao nome global do pai, concatenado com um ponto (".") e com o seu pr�prio nome. Se o nome global do pai for ".", ent�o o nome global do filho ser� apenas "." + o seu pr�prio nome.

Calcular componente raiz

(Antes de inserir, Antes de alterar)

Se componente tem um pai informado, ter� a mesma raiz que seu pai, caso contr�rio, a raiz ser� o pr�prio componente.

Aprovar componentes filhos

(Depois de alterar)

Quando um componente � aprovado, todos os filhos s�o aprovados em cascata.

Calcular sequencia das usages

(Antes de inserir, Antes de alterar)

Quando o componente for uma entity-usage, ent�o o n�mero de sequencia dever� ser o n�mero de entidades que est�o a "esquerda". A entidade base ser� sempre "0". As primeiras lookups ser�o 1, as lookups das lookups ser�o 2 e assim sucessivamente.

Atualizar usu�rio e data das modifica��es

(Antes de alterar)

Considera modificado apenas se um dos atributos l�gicos foi alterado. Para atributo l�gico considera-se apenas aqueles que d�o valor ao componente. N�o considera:

Nome global
Datas e usu�rios de inclus�o, modifica��o e de estrutura

Note que se um nome for alterado, os nomes globais dos filhos ser�o alterados em cascata mas apenas o registro que originou a altera��o ter� seus dados de auditoria alterados.

Atualizar o nome global e raiz dos filhos

(Depois de alterar)

Verifica e corrige se necess�rio o nome global ou a raiz de todos os componentes que s�o filhos deste componente. A atualiza��o somente � executada caso o componente altere se nome global ou a sua raiz.

Atualiza depend�ncias indiretas

(Depois de inserir, Depois de excluir)

Na exclus�o ou inclus�o de uma depend�ncia do sistema, recalcula as suas depend�ncias indiretas.
Se mudar alguma coisa, atualiza as depend�ncias de todos os sistemas que s�o dependentes deste sistema.

Atualizar os dados do componente pai

(Depois de excluir, Depois de inserir, Depois de alterar)

Sempre que incluir, alterar ou excluir um componente, deve alterar a data e usu�rio de modifica��o da estrutura do componente pai.

Substituir referencias de documenta��o feitas com nome global pelo respectivo ID

(Antes de inserir, Antes de alterar)

Sempre que a descri��o, notas ou a descri��o curta forem alteradas, substituir referencias realizadas por macros do tipo

[t:nome-global]

pelos respectivos IDs:

[t:#id]

Atualizar referencias de documenta��o

(Depois de inserir, Depois de alterar)

Atualizar as depend�ncias deste elemento, formando registros que vinculam este elemento ao elemento referenciado e removendo aqueles que n�o s�o mais referenciados.

Atualizar informa��es da estrurura

(Antes de inserir, Antes de alterar)

Sempre que o registro for alterado, registrar esta altera��o no pr�prio registro e em todos os registros-pai at� alcan�ar a raiz.

Calcular identa��o dos requisitos

(Antes de inserir, Antes de alterar)

Calcula a altura do requisito considerando 1 caso ele esteja no escopo no sistema ou 1 + altura do requisito do seu escopo.
Caso modificada, atualiza dos respectivos sub-requisitos.

Propagar altera��es nos requisitos

(Depois de inserir, Depois de alterar)

           // Reordenar irm�os
           EntComponentes irmaos = new EntComponentes(ctx);
           irmaos.filterBy()
                   .in(irmaos.getTipoComponenteId(), new Integer[] {5, 7})
                   .equal(irmaos.getRefCompId(), valueOfRefCompId())
                   .equal(irmaos.getPaiCompId(), valueOfPaiCompId())
                   .notEqual(irmaos.getId(), valueOfId())
                   .ge(irmaos.getSequencia(), valueOfSequencia())
                   ;
           irmaos.orderBy().asc(irmaos.getSequencia());
           int seq = valueOfSequencia();
           while (irmaos.next()) {
               seq++;
               if (irmaos.valueOfSequencia() != seq) {
                   irmaos.setSequencia(seq);
                   irmaos.upd();
               }
           }
           
           // Propagar sub-escopos
           if (getId().isNotNull() && isAlturaModified()) {
               EntComponentes child = findAllComponentesRefComp();
               while (child.next()) {
                   child.upd();
               }
           }

Atualizar indexa��o

(Antes de inserir, Antes de alterar)

Verifica se o registro deve ou n�o ser indexado.

S� pode incluir/excluir filhos de componentes pendentes

(Antes de inserir, Antes de excluir)

N�o � permitido incluir elementos abaixo de registros aprovados. O mesmo ocorre para a exclus�o de componentes.

S� pode alterar componentes pendentes

(Antes de alterar, Antes de excluir)

Apenas o processo especial "Revisar" pode ser usado quando um componente estiver aprovado.

Set property value(propriedade, valor, tipo, per_user)

Define um valor para uma propriedade.
A propriedade ser� considerada de design.

Atualizar auditoria da estrutura em cascata subindo at� a raiz

Atualizar os dados de auditoria de estrutura (usu�rio, data e hora) do registro e de seus elementos-pai at� a raiz.

Calcular depend�ncias(mudou)

Rotina que revisa as depend�ncias do sistema.
Se o componente n�o for um sistema, encerra sem fazer nada.

Consulta quais s�o as dependencias diretas do sistema que j� est�o cadastradas e completa com as dependencias indiretas.
Verifica se existem dependencias diretas que precisam ser exclu�das.
Verifica se existem dependencias que precisam ser inclu�das.
Se mudou alguma coisa, atualiza todos sistemas que s�o dependentes deste sistema.

Clonar

Este procedimento duplica o componente atual junto com seus filhos.

As rela��es entre os componentes que pertencem � �rvore clonada (atrav�s de dom�nios e refer�ncias) s�o devidamente traduzidas para os respectivos clones.

Toda nova estrutura entra em situa��o pendente.

Criar PK

Se o componente for uma entidade, cria a PK automaticamente.

Criar UK

Quando o componente � uma Entidade, cria um atributo e uma regra UK com o nome singular ele.

Del property(propriedade)

Remove uma propriedade do componente.

Excluir FKs para entidades exclu�das

(Antes de excluir)

Quando excluir uma entidade, todas as FKs relacionadas a ela devem ser exclu�das.

Find by pai nome(pai_id, nome)

Apenas para compatibilidade de vers�es anteriores.

Get Childs(force)

Retorna uma lista com todos os elementos filhos deste componente.

Get childs of type(tipo)

Retorna os filhos de um componente filtrando pelo tipo.

Get component property(propriedade)

Retorna uma propriedade do componente desconsiderando qualquer tipo de heran�a.
Caso n�o encontrado, retorna null.

Get propriedade do componente(id, property)

Retorna o valor de uma propriedade do componente
sem considerar a possibilidade de heran�a.

Get propriedade do dom�nio(property)

Retorna o valor de uma propriedade do componente
considerando a possibilidade de heran�a
atrav�s da hierarquia de dom�nios.
Caso n�o encontre, retorna NULL.

Get domain related component(tipo_componente_id)

Retorna um componente relacionado com o atual atrav�s do dom�nio e que seja de um tipo espec�fico. Retorna NULO se n�o encontrar.

Pend�ncias do componente

Verifica se o componente tem pend�ncias de acordo com seu tipo.

Pend�ncias do componente do tipo entidade

Verifica os seguintes �tens:

Deve ter uma REGRA_PK.
O nome da REGRA_PK deve estar de acordo com o padr�o.
O nome das regras UK devem ter o nome no padr�o UK_ALIAS.
O nome das regras de FK devem iniciar com FK_ALIAS_ALIAS

Get Property(property)

Retorna o valor de uma propriedade do componente.

Get property (com default)(name, default_value)

Mesmo que GET_PROPERTY mas aceita informar um default.

Get System

Retorna o componente que representa o sistema deste componente.

Nome global do sistema

Varre a �rvore do componente e retorna o nome global do sistema onde ele est� inserido.

Get Usages

Esta fun��o retorna uma rela��o de componentes que referenciam este componente atrav� dos atributos "Refer�ncia" ou "Dom�nio".

HTML descrevendo parametros

Retorna um HTML descrevendo os parametros do componente.

Revisar

Cria uma revis�o do componente. Se o componente estiver pendente, n�o tem qualquer efeito.
Se o componente est� aprovado, tira a data de aprova��o (retornando sua situa��o para Pendente), incrementa o n�mero de vers�o, e caso o componente tenha pai, revisa-o tamb�m (em cascata at� a raiz).

Set property(propriedade, valor)

Define uma propriedade de design para o componente.