All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jrimum.bopepo.LinhaDigitavel Maven / Gradle / Ivy

Go to download

This is a fork and merge from JRimum ( http://www.jrimum.org ), - Bopepo: https://github.com/jrimum/bopepo - Texgit: https://github.com/jrimum/texgit - Valia: https://github.com/jrimum/vallia - Utilix: https://github.com/jrimum/utilix - Domkee: https://github.com/jrimum/domkee For Brazillian Boleto Payment Method. So much thanks for original authors: Gilmar P. S. L, Misael Barreto and Rômulo Augusto.

The newest version!
/*
 * Copyright 2008 JRimum Project
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by
 * applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
 * OF ANY KIND, either express or implied. See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * Created at: 30/03/2008 - 18:04:37
 * 
 * ================================================================================
 * 
 * Direitos autorais 2008 JRimum Project
 * 
 * Licenciado sob a Licença Apache, Versão 2.0 ("LICENÇA"); você não pode usar
 * esse arquivo exceto em conformidade com a esta LICENÇA. Você pode obter uma
 * cópia desta LICENÇA em http://www.apache.org/licenses/LICENSE-2.0 A menos que
 * haja exigência legal ou acordo por escrito, a distribuição de software sob
 * esta LICENÇA se dará “COMO ESTÁ”, SEM GARANTIAS OU CONDIÇÕES DE QUALQUER
 * TIPO, sejam expressas ou tácitas. Veja a LICENÇA para a redação específica a
 * reger permissões e limitações sob esta LICENÇA.
 * 
 * Criado em: 30/03/2008 - 18:04:37
 * 
 */


package org.jrimum.bopepo;

import org.apache.commons.lang3.StringUtils;
import org.apache.log4j.Logger;
import org.jrimum.texgit.BlockOfFields;
import org.jrimum.texgit.FixedField;
import org.jrimum.utilix.Objects;
import org.jrimum.utilix.Strings;
import org.jrimum.vallia.BoletoLinhaDigitavelDV;


/**
 * 
 * Representa a linha digitável do boleto, embora a linha digitável contenha a
 * mesma informação do código de barras, essa informação é disposta de uma forma
 * diferente e são acrescentados 3 dígitos verificadores. 
 * 
 * Modelo: 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 
Posição TamanhoConteúdo
01-03 3 Identificação do banco 
04-041 Código de moeda (9 – Real) 
05-09 5 Cinco primeiras posições do campo livre (posições 20 a 24 do código de
 * barras)
10-10 1 Dígito verificador do primeiro campo 
11-20 10 6ª a 15ª posições do campo livre (posições 25 a 34 do código de barras)
 * 
21-21 1 Dígito verificador do segundo campo 
22-31 10 16ª a 25ª posições do campo livre (posições 35 a 44 do código de barras)
 * 
32-32 1 Dígito verificador do terceiro campo 
33-33 1 Dígito verificador geral (posição 5 do código de barras) 
34-37 4 Posições 34 a 37 – fator de vencimento (posições 6 a 9 do código debarras)
37-47 10 Posições 38 a 47 – valor nominal do título(posições 10 a 19 do código de barras) 

 * 
 * 
 * 
 * 
 * Observações:
 * 
 * 
 * 
    
 * 
 * 
  • Em cada um dos três primeiros campos, após a 5a posição, deve ser
 * inserido um ponto “.”, a fim de facilitar a visualização, para a digitação,
 * quando necessário;
    • 
 * 
  • Quinto campo:
 * 
      
 * 
 * 
    • preenchimento com zeros entre o fator de vencimento e o valor até
 * completar 14 posições;
 * 
    • a existência de “0000” no campo “fator de vencimento” da linha digitável
 * do bloqueto de cobrança é indicativo de que o código de barras não contém
 * fator de vencimento. Nesse caso, o banco acolhedor/recebedor estará isento
 * das responsabilidades pelo recebimento após o vencimento, que impede de
 * identificar automaticamente se o bloqueto está ou não vencido;
      • 
 * 
    • quando se tratar de bloquetos sem discriminação do valor no código de
 * barras, a representação deverá ser com zeros;
      • 
 * 
    • não deverá conter separação por pontos, vírgulas ou espaços;
      • 
 * 
    
 * 
 * 
    • 
 * 
  • Os dígitos verificadores referentes aos 1º, 2º e 3º campos não são
 * representados no código de barras;
    • 
 * 
  • Os dados da linha digitável não se apresentam na mesma ordem do código
 * de barras.
    • 
 * 
 * 

 * 
 * 
 * @see org.jrimum.bopepo.CodigoDeBarras
 * 
 * @author Gilmar P.S.L
 * @author Misael Barreto 
 * @author Rômulo Augusto
 * @author Nordeste Fomento Mercantil
 * 
 * @since 0.2
 * 
 * @version 0.2
 */
public class LinhaDigitavel extends BlockOfFields {
	
	/**
	 * 
	 */
	private static final long serialVersionUID = -6089634012523938802L;
	
	private static Logger log = Logger.getLogger(LinhaDigitavel.class);
	
	/**
	 * 
	 */
	private static final Integer FIELDS_LENGTH = 5;
	
	/**
	 * 

	 * Tamanho dos campos mais os espaços entre eles.
	 * 

	 */
	private static final Integer STRING_LENGTH = 54;

	/**
	 * 
	 */
	private FixedField innerCampo1;
	
	/**
	 * 
	 */
	private FixedField innerCampo2;
	
	/**
	 * 
	 */
	private FixedField innerCampo3;
	
	/**
	 * 

	 * Digito verificador geral.
	 * 

	 */
	private FixedField campo4;
	
	/**
	 * 
	 */
	private FixedField innerCampo5;


	/**
	 * 

	 * Cria uma linha digitável a partir do código de barras passado.
	 * 

	 * 
	 * @param codigoDeBarras
	 * 
	 * @see CodigoDeBarras
	 * 
	 * @since 0.2
	 */
	LinhaDigitavel(CodigoDeBarras codigoDeBarras) {
		super();
		setLength(STRING_LENGTH);
		setSize(FIELDS_LENGTH);
		
		if(log.isTraceEnabled())
			log.trace("Instanciando Linha Digitável");
		
		if(log.isDebugEnabled())
			log.debug("codigoDeBarra instance : "+codigoDeBarras);
		
		innerCampo1 = new FixedField(new InnerCampo1(4,11),11);
		innerCampo2 = new FixedField(new InnerCampo2(2,12),12);
		innerCampo3 = new FixedField(new InnerCampo3(2,12),12);
		campo4 = new FixedField(new Integer(0),1);
		innerCampo5 = new FixedField(new InnerCampo5(2,14),14);
		
		add(innerCampo1);
		add(innerCampo2);
		add(innerCampo3);
		add(campo4);
		add(innerCampo5);
		
		this.innerCampo1.getValue().load(codigoDeBarras);
		this.innerCampo2.getValue().load(codigoDeBarras);
		this.innerCampo3.getValue().load(codigoDeBarras);
		
		this.campo4.setValue(codigoDeBarras.getDigitoVerificadorGeral().getValue());
		
		if(log.isDebugEnabled())
			log.debug("InnerCampo 4 da Linha Digitável : "+this.campo4.getValue());
		
		this.innerCampo5.getValue().load(codigoDeBarras);
		
		if(log.isDebugEnabled() || log.isTraceEnabled())
			log.debug("linhaDigitavel instanciada : "+this.write());
	}

	/**
	 * Escreve a linha digitável foramatada (com espaço entre os campos).
	 * 
	 * @see org.jrimum.texgit.type.component.BlockOfFields#write()
	 */
	@Override
	public String write(){
		
		return new StringBuilder(innerCampo1.write()).
		append(Strings.WHITE_SPACE).
		append(innerCampo2.write()).
		append(Strings.WHITE_SPACE).
		append(innerCampo3.write()).
		append(Strings.WHITE_SPACE).
		append(campo4.write()).
		append(Strings.WHITE_SPACE).
		append(innerCampo5.write()).toString();

	}

	private abstract class InnerCampo extends BlockOfFields {
		
		/**
		 * 
		 */
		private static final long serialVersionUID = 6746400538765124943L;
		/**
		 * 
		 */
		protected final BoletoLinhaDigitavelDV calculadorDV = new BoletoLinhaDigitavelDV();
		
		
		protected InnerCampo(Integer fieldsLength, Integer stringLength) {
			super();
			setLength(stringLength);
			setSize(fieldsLength);
		}
		
	}
	
	private abstract class InnerCampoFormatado extends InnerCampo {
		
		
		/**
		 * 
		 */
		private static final long serialVersionUID = 3650450185403697045L;

		protected InnerCampoFormatado(final Integer fieldsLength, final Integer stringLength) {
			super(fieldsLength, stringLength);
		}
		
		/**
		 * 

		 * 
		 * Aplicação do seguinte requisito da FEBRABAN: 
		 * Em cada um dos três primeiros campos, após a quinta (5) posição, deve ser
		 * inserido um ponto “.”, a fim de facilitar a visualização, para a
		 * digitação, quando necessário.
		 * 
		 * 

		 * 
		 * 
		 * @see org.jrimum.texgit.type.component.BlockOfFields#write()
		 */
		@Override
		public String write(){
			
			StringBuilder lineOfFields = new StringBuilder(StringUtils.EMPTY);
			
			for(FixedField field : this){
				lineOfFields.append(field.write());
			}
			
			lineOfFields.insert(5, ".");
			
			return lineOfFields.toString();
		}
		
	}
	
	/**
	 * Componhe o campo 1 da linha digitável com os seguintes dados: 
	 * 
    
	 * 
  • Identificação do banco
    • 
	 * 
  • Código de moeda (9 – Real)
    • 
	 * 
  • Cinco primeiras posições do campo livre (posições 20 a 24 do código
	 * de barras)
    • 
	 * 
  • Dígito verificador do primeiro campo
    • 
	 * 

	 * 
	 * @param titulo
	 * @param codigoDeBarra
	 * @param calculadorDV
	 */
	private class InnerCampo1 extends InnerCampoFormatado{
		
		/**
		 * 
		 */
		private static final long serialVersionUID = 2948116051922000890L;

		/**
		 * @param fieldsLength
		 * @param stringLength
		 */
		private InnerCampo1(Integer fieldsLength, Integer stringLength) {
			super(fieldsLength, stringLength);
		}
		
		/**
		 * @param codigoDeBarras
		 */
		private void load(CodigoDeBarras codigoDeBarras){
				
				if(log.isTraceEnabled())
					log.trace("Compondo campo 1 da Linha Digitável");

				add(new FixedField(codigoDeBarras.write().substring(0, 3),3));
				add(new FixedField(codigoDeBarras.write().substring(3, 4),1));
				add(new FixedField(codigoDeBarras.write().substring(19, 24),5));
				add(new FixedField(calculadorDV.calcule(get(0).write() + get(1).write() + get(2).write()),1));
				
				if(log.isDebugEnabled())
					log.debug("Digito verificador do Field 1 da Linha Digitável : "+get(3).getValue());

				
				if(log.isDebugEnabled() || log.isTraceEnabled())
					log.debug("Field 1 da Linha Digitável composto : "+write());
		}
		
	}
	
	/**
	 * Componhe o campo 2 da linha digitável com os seguintes dados: 
	 * 
    
	 * 
  • 6ª a 15ª posições do campo livre (posições 25 a 34 do código de
	 * barras)
    • 
	 * 
  • Dígito verificador do segundo campo
    • 
	 * 

	 * 
	 * @param codigoDeBarra
	 * @param calculadorDV
	 */
	private class InnerCampo2 extends InnerCampoFormatado{

		/**
		 * 
		 */
		private static final long serialVersionUID = -2201847536243988819L;

		/**
		 * @param fieldsLength
		 * @param stringLength
		 */
		private InnerCampo2(Integer fieldsLength, Integer stringLength) {
			super(fieldsLength, stringLength);
		}
		
		
		/**
		 * @param codigoDeBarras
		 */
		private void load(CodigoDeBarras codigoDeBarras){
			
			if(log.isTraceEnabled())
				log.trace("Compondo campo 2 da Linha Digitável");
			
			add(new FixedField(codigoDeBarras.write().substring(24, 34),10));				
			add(new FixedField(calculadorDV.calcule(get(0).write()),1));
			
			if(log.isDebugEnabled())
				log.debug("Digito verificador do campo 2 da Linha Digitável : "+get(1).getValue());
			
			if(log.isDebugEnabled() || log.isTraceEnabled())
				log.debug("InnerCampo 2 da Linha Digitável composto : "+write());
		}
		
	}
	
	/**
	 * Componhe o campo 3 da linha digitável com os seguintes dados: 
	 * 
    
	 * 
  • 16ª a 25ª posições do campo livre (posições 35 a 44 do código de
	 * barras)
    • 
	 * 
  • Dígito verificador do terceiro campo
    • 
	 * 

	 * 
	 * @param codigoDeBarra
	 * @param calculadorDV
	 */
	private class InnerCampo3 extends InnerCampoFormatado{
		
		/**
		 * 
		 */
		private static final long serialVersionUID = -4248472044788156665L;

		/**
		 * @param fieldsLength
		 * @param stringLength
		 */
		private InnerCampo3(Integer fieldsLength, Integer stringLength) {
			super(fieldsLength, stringLength);
		}
		
		/**
		 * @param codigoDeBarras
		 */
		private void load(CodigoDeBarras codigoDeBarras){
			
			if(log.isTraceEnabled())
				log.trace("Compondo campo 3 da Linha Digitável");
			
			add(new FixedField(codigoDeBarras.write().substring(34, 44),10));				
			add(new FixedField(calculadorDV.calcule(get(0).write()),1));
			
			if(log.isDebugEnabled())
				log.debug("Digito verificador do campo 3 da Linha Digitável : "+get(1).getValue());
			
			if(log.isDebugEnabled() || log.isTraceEnabled())
				log.debug("InnerCampo 3 da Linha Digitável composto : "+write());
			
		}
		
	}
	
	/**
	 * Componhe o campo 5 da linha digitável com os seguintes dados: 
	 * 
    
	 * 
  • Posições 34 a 37 – fator de vencimento (posições 6 a 9 do código de
	 * barras)
    • 
	 * 
  • Posições 38 a 47 – valor nominal do título(posições 10 a 19 do
	 * código de barras)
    • 
	 * 

	 * 
	 * @param codigoDeBarra
	 */
	private class InnerCampo5 extends InnerCampo{

		/**
		 * 
		 */
		private static final long serialVersionUID = -8040082112684009827L;

		/**
		 * @param fieldsLength
		 * @param stringLength
		 */
		private InnerCampo5(Integer fieldsLength, Integer stringLength) {
			super(fieldsLength, stringLength);
		}
		
		/**
		 * @param codigoDeBarras
		 */
		private void load(CodigoDeBarras codigoDeBarras){
			
			if(log.isTraceEnabled())
				log.trace("Compondo campo 5 da Linha Digitável");
			
			add(new FixedField(codigoDeBarras.write().substring(5, 9),4));
			add(new FixedField(codigoDeBarras.write().substring(9, 19),10));
			
			if(log.isDebugEnabled() || log.isTraceEnabled())
				log.debug("InnerCampo 5 da Linha Digitável composto : "+write());
			
		}
		
	}

	@Override
	public String toString() {
		return Objects.toString(this);
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy