Postnet.java

/*
 * Copyright 2014 Robin Stuart
 *
 * 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.backend.HumanReadableLocation.NONE;
import static uk.org.okapibarcode.backend.HumanReadableLocation.TOP;

import java.awt.geom.Rectangle2D;

/**
 * Implements <a href="http://en.wikipedia.org/wiki/POSTNET">POSTNET</a> and
 * <a href="http://en.wikipedia.org/wiki/Postal_Alpha_Numeric_Encoding_Technique">PLANET</a>
 * bar code symbologies.
 * <br>
 * POSTNET and PLANET both use numerical input data and include a modulo-10
 * check digit.
 *
 * @author <a href="mailto:rstuart114@gmail.com">Robin Stuart</a>
 */
public class Postnet extends Symbol {

    public static enum Mode {
        PLANET, POSTNET
    };

    private static final String[] PN_TABLE = {
        "LLSSS", "SSSLL", "SSLSL", "SSLLS", "SLSSL", "SLSLS", "SLLSS", "LSSSL", "LSSLS", "LSLSS"
    };

    private static final String[] PL_TABLE = {
        "SSLLL", "LLLSS", "LLSLS", "LLSSL", "LSLLS", "LSLSL", "LSSLL", "SLLLS", "SLLSL", "SLSLL"
    };

    private Mode mode;

    public Postnet() {
        this.mode = Mode.POSTNET;
        this.default_height = 12;
        this.humanReadableLocation = HumanReadableLocation.NONE;
    }

    /**
     * Sets the barcode mode (PLANET or POSTNET). The default mode is POSTNET.
     *
     * @param mode the barcode mode (PLANET or POSTNET)
     */
    public void setMode(Mode mode) {
        this.mode = mode;
    }

    /**
     * Returns the barcode mode (PLANET or POSTNET). The default mode is POSTNET.
     *
     * @return the barcode mode (PLANET or POSTNET)
     */
    public Mode getMode() {
        return mode;
    }

    @Override
    public boolean encode() {

        boolean retval;
        if (mode == Mode.POSTNET) {
            retval = makePostnet();
        } else {
            retval = makePlanet();
        }

        if (retval) {
            plotSymbol();
        }

        return retval;
    }

    private boolean makePostnet() {
        int i, sum, check_digit;
        String dest;

        if (content.length() > 38) {
            error_msg = "Input too long";
            return false;
        }

        if (!(content.matches("[0-9]+"))) {
            error_msg = "Invalid characters in data";
            return false;
        }

        sum = 0;
        dest = "L";

        for (i = 0; i < content.length(); i++) {
            dest += PN_TABLE[content.charAt(i) - '0'];
            sum += content.charAt(i) - '0';
        }

        check_digit = (10 - (sum % 10)) % 10;
        encodeInfo += "Check Digit: " + check_digit + "\n";

        dest += PN_TABLE[check_digit];
        dest += "L";

        encodeInfo += "Encoding: " + dest + "\n";
        readable = content;
        pattern = new String[] { dest };
        row_count = 1;
        row_height = new int[] { -1 };

        return true;
    }

    private boolean makePlanet() {
        int i, sum, check_digit;
        String dest;

        if (content.length() > 38) {
            error_msg = "Input too long";
            return false;
        }

        if (!(content.matches("[0-9]+"))) {
            error_msg = "Invalid characters in data";
            return false;
        }

        sum = 0;
        dest = "L";

        for (i = 0; i < content.length(); i++) {
            dest += PL_TABLE[content.charAt(i) - '0'];
            sum += content.charAt(i) - '0';
        }

        check_digit = (10 - (sum % 10)) % 10;
        encodeInfo += "Check Digit: " + check_digit + "\n";

        dest += PL_TABLE[check_digit];
        dest += "L";

        encodeInfo += "Encoding: " + dest + "\n";
        readable = content;
        pattern = new String[] { dest };
        row_count = 1;
        row_height = new int[] { -1 };

        return true;
    }

    @Override
    protected void plotSymbol() {
        int xBlock, shortHeight;
        double x, y, w, h;

        rectangles.clear();
        texts.clear();

        int baseY;
        if (humanReadableLocation == TOP) {
            baseY = getTheoreticalHumanReadableHeight();
        } else {
            baseY = 0;
        }

        x = 0;
        w = moduleWidth;
        shortHeight = (int) (0.4 * default_height);
        for (xBlock = 0; xBlock < pattern[0].length(); xBlock++) {
            if (pattern[0].charAt(xBlock) == 'L') {
                y = baseY;
                h = default_height;
            } else {
                y = baseY + default_height - shortHeight;
                h = shortHeight;
            }
            rectangles.add(new Rectangle2D.Double(x, y, w, h));
            x += (2.5 * w);
        }

        symbol_width = (int) Math.ceil(((pattern[0].length() - 1) * 2.5 * w) + w); // final bar doesn't need extra whitespace
        symbol_height = default_height;

        if (humanReadableLocation != NONE && !readable.isEmpty()) {
            double baseline;
            if (humanReadableLocation == TOP) {
                baseline = fontSize;
            } else {
                baseline = getHeight() + fontSize;
            }
            double centerX = getWidth() / 2.0;
            texts.add(new TextBox(centerX, baseline, readable));
        }
    }
}