quarta-feira, 10 de setembro de 2014

Finalizei a função de documentação da relação entre as anotações e as camadas da aplicação.

O BeanMaker é todo governado por anotações (principalmente) a partir da classe da camada modelo, todas as demais camadas podem ser impactadas por elas.

Assim, é fundamental que as ações provocadas por cada anotação nas diversas camadas estejam muito bem documentadas. Essa funcionalidade nova atende a essa necessidade.

Exemplo de documentação das ações produzidas por anotações entre as camadas:

Anotação "@Id" da JPA:
1)Na camada DAO serve para:
1.a) Recuperar um exemplar da classe (uma linha da tabela) através dos métodos getById e getByIdLock.
1.b) Eliminar um exemplar da classe (uma linha da tabela) através do método delete.
2)Na camada View serve para:
2.a) Definir se o campo pode ser alterado em uma manutenção (update). Assim, se o campo estiver vinculado a uma propriedade com essa marcação terá que ser somente para leitura (readonly).

Anotação "@GeneratedValue" da JPA:
3)Na camada DAO serve para:
3.a) Indicar que o método insert não deverá ter para a coluna vinculada a propriedade atribuição de valor no comando insert do sql (MySql com colunas autonumeradas). Indica também que o valor atribuído pelo banco deve ser recuperado depois da execução do comando sql.
4)Na camada View serve para:
4.a) Definir que o campo associado à propriedade deverá ser "readonly" inclusive na inclusão.

Nenhum comentário:

Postar um comentário