Dépôt officiel du code source de l'ERP OpenConcerto

/*

 * Copyright 2014 Robin Stuart, Daniel Gredler

 *

 * 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.

 */

package uk.org.okapibarcode.backend;

import static uk.org.okapibarcode.util.Arrays.positionOf;

/**

 * <p>

 * Implements Code 11 bar code symbology.

 *

 * <p>

 * Code 11 can encode any length string consisting of the digits 0-9 and the dash character (-). One

 * or two modulo-11 check digits are calculated.

 *

 * @author <a href="mailto:rstuart114@gmail.com">Robin Stuart</a>

 * @author Daniel Gredler

 */

public class Code11 extends Symbol {

    private static final String[] CODE_11_TABLE = { "111121", "211121", "121121", "221111", "112121", "212111", "122111", "111221", "211211", "211111", "112111" };

    private static final char[] CHARACTER_SET = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '-' };

    /** Ratio of wide bar width to narrow bar width. */

    private double moduleWidthRatio = 2;

    /** The number of check digits to calculate ({@code 1} or {@code 2}). */

    private int checkDigitCount = 2;

    /** Optional start delimiter to be shown in the human-readable text. */

    private Character startDelimiter;

    /** Optional stop delimiter to be shown in the human-readable text. */

    private Character stopDelimiter;

    /**

     * Sets the ratio of wide bar width to narrow bar width. Valid values are usually between

     * {@code 2} and {@code 3}. The default value is {@code 2}.

     *

     * @param moduleWidthRatio the ratio of wide bar width to narrow bar width

     */

    public void setModuleWidthRatio(final double moduleWidthRatio) {

        this.moduleWidthRatio = moduleWidthRatio;

    }

    /**

     * Returns the ratio of wide bar width to narrow bar width.

     *

     * @return the ratio of wide bar width to narrow bar width

     */

    public double getModuleWidthRatio() {

        return this.moduleWidthRatio;

    }

    /**

     * Sets the number of check digits to calculate ({@code 1} or {@code 2}). The default value is

     * {@code 2}.

     *

     * @param checkDigitCount the number of check digits to calculate

     */

    public void setCheckDigitCount(final int checkDigitCount) {

        if (checkDigitCount < 1 || checkDigitCount > 2) {

            throw new IllegalArgumentException("Check digit count must be 1 or 2.");

        }

        this.checkDigitCount = checkDigitCount;

    }

    /**

     * Returns the number of check digits to calculate (1 or 2).

     *

     * @return the number of check digits to calculate

     */

    public int getCheckDigitCount() {

        return this.checkDigitCount;

    }

    /**

     * Sets an optional start delimiter to be shown in the human-readable text (defaults to

     * <code>null</code>).

     *

     * @param startDelimiter an optional start delimiter to be shown in the human-readable text

     */

    public void setStartDelimiter(final Character startDelimiter) {

        this.startDelimiter = startDelimiter;

    }

    /**

     * Returns the optional start delimiter to be shown in the human-readable text.

     *

     * @return the optional start delimiter to be shown in the human-readable text

     */

    public Character getStartDelimiter() {

        return this.startDelimiter;

    }

    /**

     * Sets an optional stop delimiter to be shown in the human-readable text (defaults to

     * <code>null</code>).

     *

     * @param stopDelimiter an optional stop delimiter to be shown in the human-readable text

     */

    public void setStopDelimiter(final Character stopDelimiter) {

        this.stopDelimiter = stopDelimiter;

    }

    /**

     * Returns the optional stop delimiter to be shown in the human-readable text.

     *

     * @return the optional stop delimiter to be shown in the human-readable text

     */

    public Character getStopDelimiter() {

        return this.stopDelimiter;

    }

    /** {@inheritDoc} */

    @Override

    protected void encode() {

        if (!this.content.matches("[0-9-]+")) {

            throw new OkapiException("Invalid characters in input");

        }

        String horizontalSpacing = "112211";

        String humanReadable = this.content;

        final int length = this.content.length();

        final int[] weight = new int[length + 1];

        for (int i = 0; i < length; i++) {

            final char c = this.content.charAt(i);

            weight[i] = positionOf(c, CHARACTER_SET);

            horizontalSpacing += CODE_11_TABLE[weight[i]];

        }

        final int checkDigitC = getCheckDigitC(weight, length);

        horizontalSpacing += CODE_11_TABLE[checkDigitC];

        humanReadable += CHARACTER_SET[checkDigitC];

        infoLine("Check Digit C: " + checkDigitC);

        if (this.checkDigitCount == 2) {

            weight[length] = checkDigitC;

            final int checkDigitK = getCheckDigitK(weight, length + 1);

            horizontalSpacing += CODE_11_TABLE[checkDigitK];

            humanReadable += CHARACTER_SET[checkDigitK];

            infoLine("Check Digit K: " + checkDigitK);

        }

        horizontalSpacing += "112211";

        this.readable = humanReadable;

        if (this.startDelimiter != null) {

            this.readable = this.startDelimiter + this.readable;

        }

        if (this.stopDelimiter != null) {

            this.readable = this.readable + this.stopDelimiter;

        }

        this.pattern = new String[] { horizontalSpacing };

        this.row_count = 1;

        this.row_height = new int[] { -1 };

    }

    private static int getCheckDigitC(final int[] weight, final int length) {

        int countC = 0;

        int weightC = 1;

        for (int i = length - 1; i >= 0; i--) {

            countC += weightC * weight[i];

            weightC++;

            if (weightC > 10) {

                weightC = 1;

            }

        }

        return countC % 11;

    }

    private static int getCheckDigitK(final int[] weight, final int length) {

        int countK = 0;

        int weightK = 1;

        for (int i = length - 1; i >= 0; i--) {

            countK += weightK * weight[i];

            weightK++;

            if (weightK > 9) {

                weightK = 1;

            }

        }

        return countK % 11;

    }

    /** {@inheritDoc} */

    @Override

    protected double getModuleWidth(final int originalWidth) {

        if (originalWidth == 1) {

            return 1;

        } else {

            return this.moduleWidthRatio;

        }

    }

    /** {@inheritDoc} */

    @Override

    protected int[] getCodewords() {

        return getPatternAsCodewords(6);

    }

}