/*
 *  jDTAUS Banking API
 *  Copyright (C) 2005 Christian Schulte
 *  <cs@schulte.it>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
package org.jdtaus.banking;

import java.io.Serializable;
import java.text.DecimalFormat;
import java.text.NumberFormat;
import java.text.ParseException;
import java.util.Date;

/**
 * Record of the {@code BankleitzahlenVerzeichnis}.
 *
 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
 * @version $JDTAUS: BankleitzahlInfo.java 8861 2014-01-10 17:09:50Z schulte $
 *
 * @see BankleitzahlenVerzeichnis
 */
public class BankleitzahlInfo implements Cloneable, Serializable
{

    /** Serial version UID for backwards compatibility with 1.1.x classes. */
    private static final long serialVersionUID = -7251689236798391940L;

    /**
     * index = index of the field in the record line; value = offset the field's value starts in the record line.
     */
    private static final int[] FIELD_TO_OFFSET =
    {
        0, 8, 9, 67, 72, 107, 134, 139, 150, 152, 158, 159, 160
    };

    /**
     * index = index of the field in the record line; value = length of the field's value in the record line.
     */
    private static final int[] FIELD_TO_LENGTH =
    {
        8, 1, 58, 5, 35, 27, 5, 11, 2, 6, 1, 1, 8
    };

    /**
     * index = index of the field in the record line; value = end offset in the record line exclusive.
     */
    private static final int[] FIELD_TO_ENDOFFSET =
    {
        BankleitzahlInfo.FIELD_TO_OFFSET[0] + BankleitzahlInfo.FIELD_TO_LENGTH[0],
        BankleitzahlInfo.FIELD_TO_OFFSET[1] + BankleitzahlInfo.FIELD_TO_LENGTH[1],
        BankleitzahlInfo.FIELD_TO_OFFSET[2] + BankleitzahlInfo.FIELD_TO_LENGTH[2],
        BankleitzahlInfo.FIELD_TO_OFFSET[3] + BankleitzahlInfo.FIELD_TO_LENGTH[3],
        BankleitzahlInfo.FIELD_TO_OFFSET[4] + BankleitzahlInfo.FIELD_TO_LENGTH[4],
        BankleitzahlInfo.FIELD_TO_OFFSET[5] + BankleitzahlInfo.FIELD_TO_LENGTH[5],
        BankleitzahlInfo.FIELD_TO_OFFSET[6] + BankleitzahlInfo.FIELD_TO_LENGTH[6],
        BankleitzahlInfo.FIELD_TO_OFFSET[7] + BankleitzahlInfo.FIELD_TO_LENGTH[7],
        BankleitzahlInfo.FIELD_TO_OFFSET[8] + BankleitzahlInfo.FIELD_TO_LENGTH[8],
        BankleitzahlInfo.FIELD_TO_OFFSET[9] + BankleitzahlInfo.FIELD_TO_LENGTH[9],
        BankleitzahlInfo.FIELD_TO_OFFSET[10] + BankleitzahlInfo.FIELD_TO_LENGTH[10],
        BankleitzahlInfo.FIELD_TO_OFFSET[11] + BankleitzahlInfo.FIELD_TO_LENGTH[11],
        BankleitzahlInfo.FIELD_TO_OFFSET[12] + BankleitzahlInfo.FIELD_TO_LENGTH[12]
    };

    /**
     * Bankleitzahl (german bank code).
     * @serial
     */
    private Bankleitzahl bankCode;

    /**
     * Specifies if this record identifies a bank which is to be used for transactions.
     * @serial
     */
    private boolean headOffice;

    /**
     * The name of the bank.
     * @serial
     */
    private String name;

    /**
     * Postal code of the city the bank is resident.
     * @serial
     */
    private int postalCode = -1;

    /**
     * City the bank resides at.
     * @serial
     */
    private String city;

    /**
     * Description of the bank including information regarding the city the bank resides.
     * @serial
     */
    private String description;

    /**
     * Institute number for PAN.
     * @serial
     */
    private int panInstituteNumber = -1;

    /**
     * SWIFT Bank Identifier Code.
     * @serial
     */
    private String bic;

    /**
     * Label for the algorithm used for validating account numbers.
     * @serial
     */
    private String validationLabel;

    /**
     * The serial number of the record.
     * @serial
     */
    private Integer serialNumber;

    /**
     * Label indicating changes of the record to previous files.
     * @serial
     */
    private char changeLabel;

    /**
     * Indicates if this record will be deleted in upcoming files.
     * @serial
     */
    private boolean markedForDeletion;

    /**
     * Bankleitzahl of the bank the record is replaced with.
     * @serial
     */
    private Bankleitzahl replacingBankCode;

    /**
     * Label of the rule used for generating international bank account numbers.
     * @serial
     * @since 1.15
     */
    private Integer ibanRuleLabel;

    /**
     * Version of the rule used for generating international bank account numbers.
     * @serial
     * @since 1.15
     */
    private Integer ibanRuleVersion;

    /**
     * The date the record got created at.
     * @since 1.15
     */
    private Date creationDate;

    /**
     * The date the record got modified at.
     * @since 1.15
     */
    private Date modificationDate;

    /**
     * The date the record got deleted at.
     * @since 1.15
     */
    private Date deletionDate;

    /** Creates a new {@code BankleitzahlInfo} instance. */
    public BankleitzahlInfo()
    {
        super();
    }

    /**
     * Getter for property {@code bankCode}.
     *
     * @return The german bank code identifying the bank (field 1).
     */
    public Bankleitzahl getBankCode()
    {
        return this.bankCode;
    }

    /**
     * Setter for property {@code bankCode}.
     *
     * @param value The german bank code identifying the bank (field 1).
     */
    public void setBankCode( final Bankleitzahl value )
    {
        this.bankCode = value;
    }

    /**
     * Getter for property {@code headOffice}.
     *
     * @return {@code true} if this record specifies a bank which is to be used for transactions; {@code false} if this
     * record specifies a branch office of a bank not to be used for transactions but sharing a bank code (field 2).
     */
    public boolean isHeadOffice()
    {
        return this.headOffice;
    }

    /**
     * Setter for property {@code headOffice}.
     *
     * @param value {@code true} if this record specifies a bank which is to be used for transactions; {@code false} if
     * this record specifies a branch office of a bank not to be used for transactions but sharing a bank code
     * (field 2).
     */
    public void setHeadOffice( final boolean value )
    {
        this.headOffice = value;
    }

    /**
     * Getter for property {@code name}.
     *
     * @return The name of the bank (field 3).
     */
    public String getName()
    {
        return this.name;
    }

    /**
     * Setter for property {@code name}.
     *
     * @param value The name of the bank (field 3).
     */
    public void setName( final String value )
    {
        this.name = value;
    }

    /**
     * Getter for property {@code postalCode}.
     *
     * @return The postal code of the city the bank is resident (field 4).
     */
    public int getPostalCode()
    {
        return this.postalCode;
    }

    /**
     * Setter for property {@code postalCode}.
     *
     * @param value The postal code of the city the bank is resident (field 4).
     */
    public void setPostalCode( final int value )
    {
        this.postalCode = value;
    }

    /**
     * Getter for property {@code city}.
     *
     * @return The city the bank resides at (field 5).
     */
    public String getCity()
    {
        return this.city;
    }

    /**
     * Setter for property {@code city}.
     *
     * @param value The city the bank resides at (field 5).
     */
    public void setCity( final String value )
    {
        this.city = value;
    }

    /**
     * Getter for property {@code description}.
     *
     * @return A description of the bank including information regarding the city the bank resides to be used for
     * displaying on e.g. invoices (field 6).
     */
    public String getDescription()
    {
        return this.description;
    }

    /**
     * Setter for property {@code description}.
     *
     * @param value A description of the bank including information regarding the city the bank resides to be used for
     * displaying on e.g. invoices (field 6).
     */
    public void setDescription( final String value )
    {
        this.description = value;
    }

    /**
     * Getter for property {@code panInstituteNumber}.
     *
     * @return The institute number for PAN or {@code 0} if no number is available (field 7).
     */
    public int getPanInstituteNumber()
    {
        return this.panInstituteNumber;
    }

    /**
     * Setter for property {@code panInstituteNumber}.
     *
     * @param value The institute number for PAN or {@code 0} if no number is available (field 7).
     */
    public void setPanInstituteNumber( final int value )
    {
        this.panInstituteNumber = value;
    }

    /**
     * Getter for property {@code bic}.
     *
     * @return The SWIFT Bank Identifier Code (field 8).
     */
    public String getBic()
    {
        return this.bic;
    }

    /**
     * Setter for property {@code bic}.
     *
     * @param value The SWIFT Bank Identifier Code (field 8).
     */
    public void setBic( final String value )
    {
        this.bic = value;
    }

    /**
     * Getter for property {@code validationLabel}.
     *
     * @return The label for the algorithm to be used for validating account numbers (field 9).
     */
    public String getValidationLabel()
    {
        return this.validationLabel;
    }

    /**
     * Setter for property {@code validationLabel}.
     *
     * @param value The label for the algorithm to be used for validating account numbers (field 9).
     */
    public void setValidationLabel( final String value )
    {
        this.validationLabel = value;
    }

    /**
     * Getter for property {@code serialNumber}.
     *
     * @return The serial number of the record (field 10).
     */
    public Integer getSerialNumber()
    {
        return this.serialNumber;
    }

    /**
     * Setter for property {@code serialNumber}.
     *
     * @param value The serial number of the record (field 10).
     */
    public void setSerialNumber( final Integer value )
    {
        this.serialNumber = value;
    }

    /**
     * Getter for property {@code changeLabel}.
     *
     * @return The label used to indicate changes of the record since previous files (field 11).
     */
    public char getChangeLabel()
    {
        return this.changeLabel;
    }

    /**
     * Setter for property {@code changeLabel}.
     *
     * @param value The label used to indicate changes of the record since previous files (field 11).
     */
    public void setChangeLabel( final char value )
    {
        this.changeLabel = value;
    }

    /**
     * Getter for property {@code markedForDeletion}.
     *
     * @return {@code true} if this record will be deleted from upcoming files; {@code false} if not (field 12).
     */
    public boolean isMarkedForDeletion()
    {
        return this.markedForDeletion;
    }

    /**
     * Setter for property {@code markedForDeletion}.
     *
     * @param value {@code true} if this record will be deleted from upcoming files; {@code false} if not (field 12).
     */
    public void setMarkedForDeletion( final boolean value )
    {
        this.markedForDeletion = value;
    }

    /**
     * Getter for property {@code replacingBankCode}.
     *
     * @return The bank code of the bank replacing this bank if this record is marked for deletion or {@code null} if no
     * replacing bank code is specified or the record is not to be deleted (field 13).
     */
    public Bankleitzahl getReplacingBankCode()
    {
        return this.replacingBankCode;
    }

    /**
     * Setter for property {@code replacingBankCode}.
     *
     * @param value The bank code of the bank replacing this bank if this record is marked for deletion or {@code null}
     * if no replacing bank code is specified or the record is not to be deleted (field 13).
     */
    public void setReplacingBankCode( final Bankleitzahl value )
    {
        this.replacingBankCode = value;
    }

    /**
     * Getter for property {@code ibanRuleLabel}.
     *
     * @return The label of the rule to use for generating international bank account numbers or {@code null}, if
     * generating an IBAN for an account at the bank identified by the bank code of this record is not supported
     * (field 14).
     *
     * @since 1.15
     */
    public Integer getIbanRuleLabel()
    {
        return this.ibanRuleLabel;
    }

    /**
     * Setter for property {@code ibanRuleLabel}.
     *
     * @param value The label of the algorithm to use for generating international bank account numbers or {@code null},
     * if generating an IBAN for an account at the bank identified by the bank code of this record should not be
     * supported (field 14).
     *
     * @since 1.15
     */
    public void setIbanRuleLabel( final Integer value )
    {
        this.ibanRuleLabel = value;
    }

    /**
     * Getter for property {@code ibanRuleVersion}.
     *
     * @return The version of the rule to use for generating international bank account numbers or {@code null}, if
     * generating an IBAN for an account at the bank identified by the bank code of this record is not supported
     * (field 14).
     *
     * @since 1.15
     */
    public Integer getIbanRuleVersion()
    {
        return this.ibanRuleVersion;
    }

    /**
     * Setter for property {@code ibanRuleVersion}.
     *
     * @param value The label of the rule to use for generating international bank account numbers or {@code null},
     * if generating an IBAN for an account at the bank identified by the bank code of this record should not be
     * supported (field 14).
     *
     * @since 1.15
     */
    public void setIbanRuleVersion( final Integer value )
    {
        this.ibanRuleVersion = value;
    }

    /**
     * Getter for property {@code creationDate}.
     *
     * @return The date the record got created at.
     *
     * @since 1.15
     */
    public Date getCreationDate()
    {
        return (Date) ( this.creationDate != null ? this.creationDate.clone() : null );
    }

    /**
     * Setter for property {@code creationDate}.
     *
     * @param value The new date the record got created at.
     *
     * @since 1.15
     */
    public void setCreationDate( final Date value )
    {
        this.creationDate = (Date) ( value != null ? value.clone() : null );
    }

    /**
     * Getter for property {@code modificationDate}.
     *
     * @return The date the record got modified at.
     *
     * @since 1.15
     */
    public Date getModificationDate()
    {
        return (Date) ( this.modificationDate != null ? this.modificationDate.clone() : null );
    }

    /**
     * Setter for property {@code modificationDate}.
     *
     * @param value The new date the record got modified at.
     *
     * @since 1.15
     */
    public void setModificationDate( final Date value )
    {
        this.modificationDate = (Date) ( value != null ? value.clone() : null );
    }

    /**
     * Getter for property {@code deletionDate}.
     *
     * @return The date the record got deleted at.
     *
     * @since 1.15
     */
    public Date getDeletionDate()
    {
        return (Date) ( this.deletionDate != null ? this.deletionDate.clone() : null );
    }

    /**
     * Setter for property {@code deletionDate}.
     *
     * @param value The new date the record got deleted at.
     *
     * @since 1.15
     */
    public void setDeletionDate( final Date value )
    {
        this.deletionDate = (Date) ( value != null ? value.clone() : null );
    }

    /**
     * Parses text from a Bankleitzahlendatei to initialize the instance.
     * <p>This method may be used for reading records from the german Bankleitzahlendatei as published by
     * <a href="http://www.bundesbank.de/index.en.php">Deutsche Bundesbank</a>.
     * It supports reading the format as of june 2006.</p>
     *
     * @param line A line from a Bankleitzahlendatei to parse.
     *
     * @throws NullPointerException if {@code text} is {@code null}.
     * @throws IllegalArgumentException if the parse fails.
     *
     * @deprecated As of 1.15, please use class {@link org.jdtaus.banking.util.BankleitzahlenDatei}.
     */
    public void parse( final String line )
    {
        if ( line == null )
        {
            throw new NullPointerException( "line" );
        }

        Number blz;
        String field;
        final NumberFormat plzFmt = new DecimalFormat( "00000" );
        final NumberFormat serFmt = new DecimalFormat( "000000" );
        final NumberFormat blzFmt = new DecimalFormat( "00000000" );

        try
        {
            // Field 1
            this.bankCode = Bankleitzahl.parse( line.substring( FIELD_TO_OFFSET[0], FIELD_TO_ENDOFFSET[0] ).trim() );
            // Field 2
            this.headOffice = "1".equals( line.substring( FIELD_TO_OFFSET[1], FIELD_TO_ENDOFFSET[1] ) );
            // Field 3
            this.name = line.substring( FIELD_TO_OFFSET[2], FIELD_TO_ENDOFFSET[2] ).trim();
            // Field 4
            this.postalCode =
                plzFmt.parse( line.substring( FIELD_TO_OFFSET[3], FIELD_TO_ENDOFFSET[3] ).trim() ).intValue();

            // Field 5
            this.city = line.substring( FIELD_TO_OFFSET[4], FIELD_TO_ENDOFFSET[4] ).trim();
            // Field 6
            this.description = line.substring( FIELD_TO_OFFSET[5], FIELD_TO_ENDOFFSET[5] ).trim();
            // Field 7
            field = line.substring( FIELD_TO_OFFSET[6], FIELD_TO_ENDOFFSET[6] ).trim();
            this.panInstituteNumber = field.length() > 0 ? plzFmt.parse( field ).intValue() : 0;
            // Field 8
            this.bic = line.substring( FIELD_TO_OFFSET[7], FIELD_TO_ENDOFFSET[7] ).trim();
            // Field 9
            this.validationLabel = line.substring( FIELD_TO_OFFSET[8], FIELD_TO_ENDOFFSET[8] ).trim();
            // Field 10
            this.serialNumber = new Integer(
                serFmt.parse( line.substring( FIELD_TO_OFFSET[9], FIELD_TO_ENDOFFSET[9] ).trim() ).intValue() );

            // Field 11
            this.changeLabel = line.substring( FIELD_TO_OFFSET[10], FIELD_TO_ENDOFFSET[10] ).toCharArray()[0];
            // Field 12
            this.markedForDeletion = "1".equals( line.substring( FIELD_TO_OFFSET[11], FIELD_TO_ENDOFFSET[11] ) );
            // Field 13
            blz = blzFmt.parse( line.substring( FIELD_TO_OFFSET[12], FIELD_TO_ENDOFFSET[12] ).trim() );
            if ( blz.intValue() != 0 )
            {
                this.replacingBankCode = Bankleitzahl.valueOf( blz );
            }
            else
            {
                this.replacingBankCode = null;
            }
        }
        catch ( final ParseException e )
        {
            throw (IllegalArgumentException) new IllegalArgumentException( line ).initCause( e );
        }
        catch ( final IndexOutOfBoundsException e )
        {
            throw (IllegalArgumentException) new IllegalArgumentException( line ).initCause( e );
        }
    }

    /**
     * Creates and returns a copy of this object.
     *
     * @return A clone of this instance.
     */
    public Object clone()
    {
        try
        {
            return super.clone();
        }
        catch ( final CloneNotSupportedException e )
        {
            throw new AssertionError( e );
        }
    }

    /**
     * Indicates whether some other object is equal to this one.
     *
     * @param o The reference object with which to compare.
     *
     * @return {@code true} if this object is the same as {@code o}; {@code false} otherwise.
     */
    public boolean equals( final Object o )
    {
        boolean ret = o == this;

        if ( !ret && o instanceof BankleitzahlInfo )
        {
            final BankleitzahlInfo that = (BankleitzahlInfo) o;
            ret = this.serialNumber == null ? that.serialNumber == null : this.serialNumber.equals( that.serialNumber );
        }

        return ret;
    }

    /**
     * Returns a hash code value for this object.
     *
     * @return A hash code value for this object.
     */
    public int hashCode()
    {
        return this.serialNumber == null ? 0 : this.serialNumber.intValue();
    }

    /**
     * Returns a string representation of the object.
     *
     * @return A string representation of the object.
     */
    public String toString()
    {
        return super.toString() + this.internalString();
    }

    /**
     * Creates a string representing the properties of the instance.
     *
     * @return a string representing the properties of the instance.
     */
    private String internalString()
    {
        return new StringBuffer( 500 ).append( '{' ).
            append( "headOffice=" ).append( this.headOffice ).
            append( ", bankCode=" ).append( this.bankCode ).
            append( ", name=" ).append( this.name ).
            append( ", bic=" ).append( this.bic ).
            append( ", changeLabel=" ).append( this.changeLabel ).
            append( ", city=" ).append( this.city ).
            append( ", markedForDeletion=" ).append( this.markedForDeletion ).
            append( ", panInstituteNumber=" ).append( this.panInstituteNumber ).
            append( ", postalCode=" ).append( this.postalCode ).
            append( ", replacingBankCode=" ).append( this.replacingBankCode ).
            append( ", serialNumber=" ).append( this.serialNumber ).
            append( ", description=" ).append( this.description ).
            append( ", validationLabel=" ).append( this.validationLabel ).
            append( ", ibanRuleLabel=" ).append( this.ibanRuleLabel ).
            append( ", ibanRuleVersion=" ).append( this.ibanRuleVersion ).
            append( ", creationDate=" ).append( this.creationDate ).
            append( ", modificationDate=" ).append( this.modificationDate ).
            append( ", deletionDate=" ).append( this.deletionDate ).
            append( '}' ).toString();

    }

}