Gerador de Relatórios

Exercício Programa de Computação Orientada a Objetos, com aplicação de Padrões de Projeto.

Objetivo

Este Exercício-Programa consiste em refatorar o código de um “Gerador de Relatórios” com o emprego de dois padrões de projeto estudados durante o semestre: o padrão Strategy e o Decorator. O projeto do sistema é composto por uma interface (Produto) e duas classes (ProdutoPadrao e GeradorDeRelatorios). A classe GeradorDeRelatorios é a classe principal do sistema. Seu papel é processar um array de Produtos e gerar uma listagem de produtos, seguindo certos critérios de ordenação e filtragem. A listagem gerada é salva em um arquivo html que pode ser visualizado em qualquer navegador.

Além de definir o critério de ordenação e o critério de filtragem (para definir quais produtos devem fazer parte da listagem gerada), é possível escolher também qual o algoritmo de ordenação a ser utilizado. A classe GeradorDeRelatorios incorpora dois algoritmos de ordenação velhos conhecidos de vocês: o Quicksort e o Insertion Sort (pode parecer sem sentido oferecer a opção de escolha pelo Insertion Sort, mas lembrem-se de que tal algoritmo pode ter desempenho linear se o array a ser ordenado tiver poucos elementos fora do lugar). Uma quarta opção de personalização na geração dos relatórios permite definir a formatação do texto apresentado no arquivo html resultante.

De forma resumida, o “Gerador de Relatórios” recebe um array de Produtos e:

1. Os ordena usando o algoritmo de ordenação escolhido
2. Segundo um determinado critério de ordenação;
3. Seleciona os produtos que satisfazem o critério de filtragem;
4. E aplica opções de formatação para gerar o arquivo html resultante

Há, portanto, quatro aspectos comportamentais do “Gerador de Relatórios” que podem ser personalizados. O conjunto completo de opções de configuração existente, na versão atual do código, para cada um dos quatro aspectos listados acima são

1. algoritmo de ordenação: Quicksort e Insertion Sort.
2. critério de ordenação: ordem crescente pelo atributo descrição de um produto; ordem crescente pelo atributo preço de um produto; e ordem crescente pelo atributo quantidade em estoque de um produto
3. critério de filtragem: todos (ou seja, todos os produtos entram na listagem gerada); produtos cujo estoque seja menor ou igual a uma certa quantidade; e produtos de uma determinada categoria.
4. opções de formatação: padrão (nenhuma opção aplicada); itálico; e negrito. As formatações são implementadas usando tags html que aplicam o efeito desejado a um texto.

Em relação aos três primeiros aspectos que podem ser configuráveis, cada opção é mutuamente exclusiva. Já em relação às opções de formatação elas podem ser combinadas. É possível, por exemplo, definir que o texto de saída deve ser formatado em itálico e negrito ao mesmo tempo. Uma limitação relavante deste esquema de formatação, na atual versão do código, é que a formatação escolhida é aplicada a todos os produtos que entram na listagem resultante. Esse comportamento deverá ser corrigido com a aplicação de um dos padrões de projeto, de modo que as opções de formatação possam ser especificadas individualmente para cada instância de produto (desta forma, será possível destacar apenas um ou outro produto, e de várias formas distintas).

Apesar da diversidade de opções de personalização, devido ao fato de o código não estar bem estruturado, ele apresenta diversos problemas: poderia ser mais legível e fácil de entender; há código redundante; e eventuais extensões de funcionalidade demandam modificações em partes prontas do sistema e em diversos pontos do código. Com a refatoração a aplicação dos padrões, todos estes problemas devem ser resolvidos. Estender o sistema (acrescentar novos algoritmos de ordenação, novos critérios de ordenação e filtragem, e novas opções de formatação) ficará bem mais fácil e prático.

O que deve ser feito

Devem ser aplicados os padrões Strategy e Decorator. O Strategy deve ser aplicado à classe GeradorDeRelatorios para melhorar a personalização desta em relação aos aspectos comportamentais 1, 2 e 3 listados. O aspecto comportamental 4, referente à formatação, deve deixar de ser responsabilidade da classe GeradorDeRelatorios e ser incorporado ao tipo Produto através da aplicação do padrão Decorator.

Após aplicação dos padrões as seguintes novas funcionalidades devem ser implementadas:

• critérios de ordenação em ordem decrescente para os atributos descrição, preço e estoque de um produto (são 3 critérios no total);
• critério de filtragem para selecionar produtos com preço dentro de um intervalo determinado;
• critério de filtragem para selecionar produtos cuja descrição contenha uma determinada substring;
• decorador de formatação para definir a cor do texto referente a um produto.

Uma restrição que deve ser respeitada é que a interface Produto e a classe ProdutoPadrao não podem ser alteradas. Além disso, os decoradores implementados devem funcionar corretamente com qualquer produto.

Além da aplicação dos padrões e implementação das funcionalidades extras, também deve ser entregue um pequeno relatório bem sucinto, que deve explicar resumidamente as mudanças que foram realizadas no código, bem como justificá-las.