Estrutura de Classes - Histórico de revisão

Rodrigogml: /* calculateFields() */

2025-03-20T18:31:24Z

calculateFields()

← Edição anterior		Edição das 18h31min de 20 de março de 2025
Linha 123:		Linha 123:
	@Override		@Override
	public void calculate(String uuid) throws RFWException {		public void calculate(String uuid) throws RFWException {
	if (uuid == null \|\| !uuid.equals(this.getLastUUID())) { // Se UUID recebido for diferente da última ~~rodade~~ de cálculo, devemos realizar os cálculos.		if (uuid == null \|\| !uuid.equals(this.getLastUUID())) { // Se UUID recebido for diferente da última rodada de cálculo, devemos realizar os cálculos.

	// Realiza os cáculos que devem ser realizados antes dos cálculos dos registros filhos		// Realiza os cáculos que devem ser realizados antes dos cálculos dos registros filhos

	super.calculate(uuid); // Chama ~~o cálculo da~~ classe pai para salvar o UUID e calcular os registros filhos recursivamente		super.calculate(uuid); // Chama a classe pai para salvar o UUID e calcular os registros filhos recursivamente

	// Realiza os cálculos que dependen dos registros filhos já calculados		// Realiza os cálculos que dependen dos registros filhos já calculados

Rodrigogml: /* SPEDFiscalBuilder e SPEDContribBuilder */

2025-03-20T17:17:10Z

SPEDFiscalBuilder e SPEDContribBuilder

← Edição anterior		Edição das 17h17min de 20 de março de 2025
Linha 140:		Linha 140:

	* '''add[Registro]()''' - os métodos '''add''' tem a finalidade de adicionar um determinado registro dentro da estrutura do SPED. Os argumentos solicitados dependem da necessidade de cada registro e pode haver mais de uma opção para a criação de um mesmo registro. Os detalhes de cada método estarão escritos no seu javadoc.		* '''add[Registro]()''' - os métodos '''add''' tem a finalidade de adicionar um determinado registro dentro da estrutura do SPED. Os argumentos solicitados dependem da necessidade de cada registro e pode haver mais de uma opção para a criação de um mesmo registro. Os detalhes de cada método estarão escritos no seu javadoc.
			<blockquote>
			Os métodos de <code>add</code> basicamente criam o objeto e o adicionam ao arquivo SPED passado. Em alguns casos eles podem:
			* '''Cria automaticamente outros registros relacionados''' - (O método já recebe todos os parâmetros necessários e cria todos os registros pais ou relacionados automaticamente, quando faz sentido para a operação);
			* '''Garante que apenas um registro seja criado para a chave única''' - Alguns registros devem ser únicos, como por exemplo os registros de Pessoas (PF e PJ) ou de produtos, os métodos de Add verificam automaticamente se já existe um registro desses e, ao invés de criar um novo, retorna o registro que corresponde aos dados passados.
			</blockquote>


Linha 153:		Linha 156:

	Verifique o javadoc de cada método para mais detalhes sobre seu funcionamento.}}		Verifique o javadoc de cada método para mais detalhes sobre seu funcionamento.}}


	~~== Descrições a seguir para Revisão ==~~

	* '''updateCloseRegistersLineCount()''' este método cria/atualiza os registros finals (?990) que deve conter a quantidade de registros de cada bloco.

Rodrigogml: /* calculateFields() */

2025-03-20T00:58:36Z

calculateFields()

← Edição anterior		Edição das 00h58min de 20 de março de 2025
Linha 122:		Linha 122:
	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	@Override		@Override
	public ~~boolean calculateFields~~(String uuid) throws RFWException {		public void calculate(String uuid) throws RFWException {
	~~boolean calculated~~ = super.~~calculateFields~~(uuid);		if (uuid == null \|\| !uuid.equals(this.getLastUUID())) { // Se UUID recebido for diferente da última rodade de cálculo, devemos realizar os cálculos.
	~~if (calculated) {~~
	// ~~Realizar as operações de cálculo do registro~~		// Realiza os cáculos que devem ser realizados antes dos cálculos dos registros filhos

			super.calculate(uuid); // Chama o cálculo da classe pai para salvar o UUID e calcular os registros filhos recursivamente

			// Realiza os cálculos que dependen dos registros filhos já calculados
	}		}
	~~return calculated;~~
	}		}
	</syntaxhighlight>		</syntaxhighlight>

Rodrigogml: /* Descrições a seguir para Revisão */

2025-03-18T21:29:26Z

Descrições a seguir para Revisão

← Edição anterior		Edição das 21h29min de 18 de março de 2025
Linha 142:		Linha 142:


	~~== Descrições a seguir~~ para ~~Revisão ==~~		{{nota\|Relacionamento e Acumuladores\|Note que na especificação do SPED há registros que são únicos, outros tem um relacionamento 1:N (que podem ou não ser únicos de acordo com um identificador único / chave).

			O método '''add''' criará o registro na estrutura se ele ainda não existir, porém, se for único duas ações podem ocorrer:
			* os dados do registro atual serão substituídos pelos novos valores recebidos; ou,
			* para registros que tem atributos cujos valores são acumulativos (como totais de venda agrupados por CFOP) o método add poderá acumular os valores automaticamente (somando o valor recebido com o valor já existente atualmente no atributo do registro).


			Verifique o javadoc de cada método para mais detalhes sobre seu funcionamento.}}

	{{nota\|Relacionamento e Acumuladores\|Note que na especificação do SPED há registros que são únicos, outros tem um relacionamento 1:N (que podem ou não ser únicos de acordo com uma chave). O método '''add''' criará o registro na estrutura se ele ainda não existir, porém, se for único duas ações podem ocorrer:
	* os dados do registro atual serem substituídos, ou para registros que tem valores que se acumulam (como totais de venda agrupados por CFOP) o método add poderá acumular os valores automaticamente (somando o valor recebido com o valor já existente no campo). Verifique o javadoc de cada método para mais detalhes sobre seu funcionamento.}}

			== Descrições a seguir para Revisão ==

	* '''updateCloseRegistersLineCount()''' este método cria/atualiza os registros finals (?990) que deve conter a quantidade de registros de cada bloco.		* '''updateCloseRegistersLineCount()''' este método cria/atualiza os registros finals (?990) que deve conter a quantidade de registros de cada bloco.

Rodrigogml: /* calculateFields() */

2025-03-18T20:53:04Z

calculateFields()

← Edição anterior		Edição das 20h53min de 18 de março de 2025
Linha 121:		Linha 121:
	{{java\|Sugestão de Override do calculateFields()\|		{{java\|Sugestão de Override do calculateFields()\|
	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	boolean calculated = super.calculateFields(uuid);		@Override
	if (calculated) {		public boolean calculateFields(String uuid) throws RFWException {
	// Realizar as operações de cálculo do registro		boolean calculated = super.calculateFields(uuid);
	}		if (calculated) {
	return calculated;		// Realizar as operações de cálculo do registro
			}
			return calculated;
			}
	</syntaxhighlight>		</syntaxhighlight>
	}}		}}

Rodrigogml: /* Padrão de Nomes dos Atributos */

2025-03-18T20:29:45Z

Padrão de Nomes dos Atributos

@@ Linha 44: / Linha 44: @@
 * <code>r06_NOME</code>
 * <code>r07_CNPJ</code>
 ==== Annotation SPEDField ====

Rodrigogml: /* calculateFields() */

2025-03-18T20:25:08Z

calculateFields()

← Edição anterior		Edição das 20h25min de 18 de março de 2025
Linha 108:		Linha 108:


			{{java\|Sugestão de Override do calculateFields()\|
			<syntaxhighlight lang="java">
			boolean calculated = super.calculateFields(uuid);
			if (calculated) {
			// Realizar as operações de cálculo do registro
			}
			return calculated;
			</syntaxhighlight>
			}}

	= SPEDFiscalBuilder e SPEDContribBuilder =		= SPEDFiscalBuilder e SPEDContribBuilder =

Rodrigogml: /* SPEDFiscalBuilder e SPEDContribBuilder */

2025-03-18T20:16:56Z

SPEDFiscalBuilder e SPEDContribBuilder

← Edição anterior		Edição das 20h16min de 18 de março de 2025
Linha 114:		Linha 114:
	Essas classes são classes utilitárias de métodos estáticos para facilitar a tarefa de montar e manipular os arquivos de SPED e seus registros. Nesta classe são disponiblizados vários métodos utilitádios, alguns, são caracterizados pelos seus prefixos, veja:		Essas classes são classes utilitárias de métodos estáticos para facilitar a tarefa de montar e manipular os arquivos de SPED e seus registros. Nesta classe são disponiblizados vários métodos utilitádios, alguns, são caracterizados pelos seus prefixos, veja:

	* '''add[Registro]()''' - os métodos '''add''' tem a finalidade de adicionar um determinado registro dentro da estrutura do SPED. Os argumentos solicitados dependem da necessidade de cada registro e ~~podem~~ haver mais de uma opção para a criação de um mesmo registro. Os detalhes de cada método estarão escritos no seu javadoc.		* '''add[Registro]()''' - os métodos '''add''' tem a finalidade de adicionar um determinado registro dentro da estrutura do SPED. Os argumentos solicitados dependem da necessidade de cada registro e pode haver mais de uma opção para a criação de um mesmo registro. Os detalhes de cada método estarão escritos no seu javadoc.

	{{nota\|Relacionamento e Acumuladores\|Note que na especificação do SPED há registros que são únicos, outros tem um relacionamento 1:N (que podem ou não ser únicos de acordo com uma chave). O método '''add''' criará o registro na estrutura se ele ainda não existir, porém, se for único duas ações podem ocorrer: os dados do registro atual serem substituídos, ou para registros que tem valores que se acumulam (como totais de venda agrupados por CFOP) o método add poderá acumular os valores automaticamente (somando o valor recebido com o valor já existente no campo). Verifique o javadoc de cada método para mais detalhes sobre seu funcionamento.}}



			== Descrições a seguir para Revisão ==

			{{nota\|Relacionamento e Acumuladores\|Note que na especificação do SPED há registros que são únicos, outros tem um relacionamento 1:N (que podem ou não ser únicos de acordo com uma chave). O método '''add''' criará o registro na estrutura se ele ainda não existir, porém, se for único duas ações podem ocorrer:
			* os dados do registro atual serem substituídos, ou para registros que tem valores que se acumulam (como totais de venda agrupados por CFOP) o método add poderá acumular os valores automaticamente (somando o valor recebido com o valor já existente no campo). Verifique o javadoc de cada método para mais detalhes sobre seu funcionamento.}}


	* '''updateCloseRegistersLineCount()''' este método cria/atualiza os registros finals (?990) que deve conter a quantidade de registros de cada bloco.		* '''updateCloseRegistersLineCount()''' este método cria/atualiza os registros finals (?990) que deve conter a quantidade de registros de cada bloco.

Rodrigogml: /* Annotation SPEDField */

2025-03-18T20:08:48Z

Annotation SPEDField

← Edição anterior		Edição das 20h08min de 18 de março de 2025
Linha 45:		Linha 45:
	* <code>r07_CNPJ</code>		* <code>r07_CNPJ</code>

	==== Annotation ~~<code>~~SPEDField~~</code>~~ ====		==== Annotation SPEDField ====

	~~TODO Explicar~~ a ~~utilização da Annotation~~ SPEDField ~~sobre como identificar atirbutos e realizar validações~~.		Cada atributo criado nas classes filhas de <code>SPEDRegister</code> devem ser anotadas com a annotation <code>SPEDField</code>.

			Essa annotation permite especificar o tipo de dado que é esperado no arquivo SPED, e garantir que o framework realize algumas validações no momento da escrita e ainda formate o valor no formato esperado. Por exemplo:
			* valida campos com o formato esperado, tipo CPF, CNPJ, Email, etc.;
			* valida o tamanho máximo do campo no arquivo para truncar Strings;
			* garante o número certo de decimais arredondando ou acrescentando zeros automaticamente ao valor, de acordo com a definição do manual do SPED.


			<blockquote>Há mais definições no SPEDField, verificar JavaDoc do SPEDField</blockquote>

	=== Métodos Internos da SPEDRegister ===		=== Métodos Internos da SPEDRegister ===

Rodrigogml em 20h02min de 18 de março de 2025

2025-03-18T20:02:53Z

Mostrar alterações