CSVGenerator - Histórico de revisão

Rodrigogml: /* CSVGenerator */

2017-09-04T23:15:36Z

CSVGenerator

← Edição anterior		Edição das 23h15min de 4 de setembro de 2017
Linha 159:		Linha 159:

	O CSVGenerator também suporta outras funções como 'MIN' (Valor Mínimo), 'MAX (Valor Máximo), etc. Consulte o JavaDoc dos elementos da enum CSVGroupByFunction para mais detalhes sobre as funções.		O CSVGenerator também suporta outras funções como 'MIN' (Valor Mínimo), 'MAX (Valor Máximo), etc. Consulte o JavaDoc dos elementos da enum CSVGroupByFunction para mais detalhes sobre as funções.


			== Iterabilidade dos Objetos ==

			A definição padrão dos dados para escrita em um CSV é uma tabela bi-dimensional. Sendo assim algumas estruturas de dados são difíceis (ou impossíveis) de se converter em uma tabela 2D. O CSVGenerator é capaz de iterar atributos que apresentem coleções automaticamente, inclusive em cascata. Desde que não tenhamos múltiplas "árvores" de iteração.


			Imagine a seguinte estrutura de objetos:
			<pre>
			voA
			+- voB
			+- voC
			\| +- listD<voD>
			\| +- voE
			\| +- listF<voF>
			\| +- voG
			+- voJ
			+- listH<voH>
			+- voI
			</pre>

			Imagine que cada VO tenha seus atributos chamados at1, at2, etc.... Imagine que temos uma coleção de dados com 10 instâncias do voA, da qual desejamos criar nossos CSV, e que cada lista representada no diagrama acima também terá 10 instâncias dos seus objetos. Para essa mesma coleção de dados, teremos arquivos com quantidades diferentes de linhas dependendo das colunas que configurarmos. Por exemplo:

			'''Caso 1:'''
			Configuramos as seguintes colunas:
			<pre>
			"at1"
			"voB.at1",
			"voB.at2",
			"voC.at1"
			</pre>

			Neste caso teremos um arquivo final com 10 linhas, pois apenas a lista principal (coleção de voA) foi iterada e escrita uma linha para cada instância.


			'''Caso 2:'''
			Configuramos as seguintes colunas:
			<pre>
			"at1"
			"voB.at1",
			"voB.at2",
			"voC.at1",
			"voC.listD.at1",
			"voC.listD.voE.at1"
			</pre>

			Neste caso, as duas últimas linhas passam por um atributo que é uma coleção de dados. Ao se deparar com um conjunto de objetos o CSV passa a iterar esse novo objeto e repete todos os valores dos objetos que estão fora da iteração atual. Assim, para cada objeto principal (voA) iteramos a sua lista D. E como citamos acima, cada listaD também tem 10 instâncias, resultando em um arquivo de 100 linhas (10x10).

			'''Caso 3:'''
			Tomando como base o caso 2, acrescentemos apenas a seguinte coluna adicional:
			<pre>
			"voC.listD.voE.listF.voG.at1"
			</pre>

			Note que agora que dentro de cada iteração da listD o CSVGenerator vai encontrar outra lista de voF, chamada de listF. Isso fará com que para cada voF encontrado dentro da listF todo o conteúdo das colunas anteriores seja repetido, modificando apenas o conteúdo dessa última coluna, que terá os valores do at1 do voG. Se o resultado do arquivo so caso 2 era de 100 linhas, e tivermos 10 objetos em cada listF encontrado, teremos agora um arquivo com 1000 linhas, sendo a cada 10 só teremos diferença na última coluna.


			'''Caso 4:'''
			Se continuarmos o caso 2 ou caso 3, mas colocamos uma coluna que pertença a uma lista "fora" da cadeira que já estamos iterando, por exemplo:
			<pre>
			"voJ.listH.at1"
			</pre>

			Note que diferentemente da listF, que estava "dentro" da listD, a listH agora está "fora" das outras iterações. Desta forma não há como estabelecer uma relação entre os dados de cada instância dessa iteração com as iterações anteriores. Esse caso resultará em erro.


			{{Nota\|Ideia de implementação do caso 4:\|Durante a escrita desta documentação, uma ideia de conseguir gerar um arquivo com iterações independentes (só para evitar o erro), seria deixar nulo os valores dos campos que pertencem a iteração de "fora" da iteração atual. De forma que primeiro iteramos 1 caminho, seguindo as interações possível e deixando nulo os campos da outra iteração, e posteriormente iteramos a outra lista zerando os campos da iteração já realizada.

			O resultado disso seria um arquivo com toda a informação desejada, com a repetição dos campos comuns (relacionáveis). Teríamos a quantidade de dados equivalente aos dois arquivos gerados com as colunas separadas, com a vantagem de ter uma única tabela para cruzamento com os dados já alinhados.}}

Rodrigogml: /* CSVGenerator */

2017-09-04T22:46:15Z

CSVGenerator

@@ Linha 34: / Linha 34: @@
 </syntaxhighlight>}}
 {{nota|Colunas Repetidas|Note que o nome da coluna é o identificador da coluna, por isso o CSVGenerator não aceita colunas com o mesmo nome, ou, no caso, colunas repetidas. Para inserir a mesma coluna duas vezes, (há vários casos para isso explicados mais a seguir) é necessário incluir uma coluna "personalizada". Também explicada mais a seguir. }}
@@ Linha 53: / Linha 54: @@
 </syntaxhighlight>}}

Rodrigogml: /* CSVGenerator */

2017-09-04T22:05:07Z

CSVGenerator

← Edição anterior		Edição das 22h05min de 4 de setembro de 2017
Linha 27:		Linha 27:
	});		});

	~~final CSVGenerator<PersonVO> gen = new CSVGenerator<PersonVO>(options);~~ //Construtor vazio cria um CSVGeneratorOptions com a opções padrão. Mas depois tem que pegar o options para colocar as colunas ou terá um CSV vazio.		// Construtor vazio cria um CSVGeneratorOptions com a opções padrão. Mas depois tem que pegar o options para colocar as colunas ou terá um CSV vazio.
			final CSVGenerator<PersonVO> gen = new CSVGenerator<PersonVO>(options);

	~~return gen.generate(personList);~~ //Retorna o CSV com as colunas selecionadas.		// Retorna o CSV com as colunas selecionadas.
			return gen.generate(personList);

	</syntaxhighlight>}}		</syntaxhighlight>}}

			{{nota\|Colunas Repetidas\|Note que o nome da coluna é o identificador da coluna, por isso o CSVGenerator não aceita colunas com o mesmo nome, ou, no caso, colunas repetidas. Para inserir a mesma coluna duas vezes, (há vários casos para isso explicados mais a seguir) é necessário incluir uma coluna "personalizada". Também explicada mais a seguir. }}


Linha 38:		Linha 42:

	=== Formatando os Dados ===		=== Formatando os Dados ===

			A formatação dos dados é feita de forma simples e de acordo com o locale passado. São formatados os números e datas apenas. De resto os campos são escritos utilizando o equivalente ao .toString() do objeto, e apenas dos objetos conhecidos pelo CSVGenerator, como String, BigDecimal, Enum, Float, Double, etc.. Outros formatos geram exception crítica para forçar um tratamento mais adequado do desenvolvedor.

			O CSVGenerator permite a configuração das colunas utilizando a interface [[BISDataFormatter]]. Para isso defina a instância do [[BISDataFormatter]] desejado na coluna através do CSVGeneratorOptions:

			{{java\|Exemplos de Uso\|<syntaxhighlight lang="java">

			// inclui o formatador de cpf/cnpj na coluna com o valor do documento
			options.getColumnFormatter().put(PersonVO_.VO.cpfcnpj(), BISCPFOrCNPJDataFormatter.getInstance());

			</syntaxhighlight>}}

Rodrigogml: Criou página com 'O '''CSVGenerator''' tem o objeto de permitir a geração de arquivos CSV a partir da estrutura de dados utilizada pelo BIS. Aproveito a estrutura dos VOs e BISMetaObjects (VO...'

2017-09-04T21:46:59Z

Criou página com 'O '''CSVGenerator''' tem o objeto de permitir a geração de arquivos CSV a partir da estrutura de dados utilizada pelo BIS. Aproveito a estrutura dos VOs e BISMetaObjects (VO...'

Página nova

O '''CSVGenerator''' tem o objeto de permitir a geração de arquivos CSV a partir da estrutura de dados utilizada pelo BIS. Aproveito a estrutura dos VOs e BISMetaObjects (VO_), isto é, aceita uma lista de VOs, e gera o arquivo CSV a partir das colunas selecionadas de dentro desses objetos.

Para exemplificar o funcionamento de todas as partes do '''CSVGenerator''' vamos imaginar que queremos exportar como CSV nosso cadastro de pessoas, lista de PersonVO.

== CSVGeneratorOptions ==

O '''CSVGeneratorOptions''' carrega praticamente toda a configuração de como o arquivo deve ser gerado. Desta forma é possível realizar toda a definição em qualquer cama (UI por exemplo) e passar para o gerador de uma única vez. Permite que seja criado um componente único para manipular o objeto para as UIs e reaproveitado em todas as telas, útil principalmente quando o gerador ganha novas opções.

Entre as configurações básicas do arquivo estão:
* '''Delimitador''' - utilizado para separar os campos do arquivo
* '''Localidade''' - Define a localidade para formatação básica dos valores, como caractere de decimais, data, etc.
* '''Títulos das Colunas''' - Define se deve ser escrito uma linha no começo com os títulos das colunas.
* '''Valor de Nulo''' - Valor que deve ser utilizado caso o objeto tenha um valor nulo. Por padrão não é escrito nada, o equivalente á "", mas pode ser necessário distinguir o "" do null.

== CSVGenerator ==

Todos os atributos de configuração já tem um valor padrão, de forma que para gerar um CSV, basta definir as colunas desejadas e passar a coleção de dados no método '''.generate()'''.

{{java|Exemplos de Uso|<syntaxhighlight lang="java">

// Define as colunas no options
options.setColumns(new String[]{
PersonVO_.VO.displayname(),
PersonVO_.VO.fullname(),
PersonVO_.VO.cpfcnpj()
});

final CSVGenerator<PersonVO> gen = new CSVGenerator<PersonVO>(options); //Construtor vazio cria um CSVGeneratorOptions com a opções padrão. Mas depois tem que pegar o options para colocar as colunas ou terá um CSV vazio.

return gen.generate(personList); //Retorna o CSV com as colunas selecionadas.

</syntaxhighlight>}}

O arquivo foi gerado, mas muitas vezes não é o que desejamos. Agora para formatar, configurar e manipular os dados é que precisará de configurações adicionais.

=== Formatando os Dados ===