core/src/com/google/zxing/oned/UPCEReader.java

   1 /*
   2  * Copyright 2008 ZXing authors
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package com.google.zxing.oned;
  18
  19 import com.google.zxing.ReaderException;
  20 import com.google.zxing.BarcodeFormat;
  21 import com.google.zxing.common.BitArray;
  22
  23 /**
  24  * <p>Implements decoding of the UPC-E format.</p>
  25  * <p/>
  26  * <p><a href="http://www.barcodeisland.com/upce.phtml">This</a> is a great reference for
  27  * UPC-E information.</p>
  28  *
  29  * @author Sean Owen
  30  */
  31 public final class UPCEReader extends AbstractUPCEANReader {
  32
  33   /**
  34    * The pattern that marks the middle, and end, of a UPC-E pattern.
  35    * There is no "second half" to a UPC-E barcode.
  36    */
  37   private static final int[] MIDDLE_END_PATTERN = {1, 1, 1, 1, 1, 1};
  38
  39   /**
  40    * See {@link #L_AND_G_PATTERNS}; these values similarly represent patterns of
  41    * even-odd parity encodings of digits that imply both the number system (0 or 1)
  42    * used, and the check digit.
  43    */
  44   private static final int[][] NUMSYS_AND_CHECK_DIGIT_PATTERNS = {
  45       {0x38, 0x34, 0x32, 0x31, 0x2C, 0x26, 0x23, 0x2A, 0x29, 0x25},
  46       {0x07, 0x0B, 0x0D, 0x0E, 0x13, 0x19, 0x1C, 0x15, 0x16, 0x1A}
  47   };
  48
  49   private final int[] decodeMiddleCounters;
  50
  51   public UPCEReader() {
  52     decodeMiddleCounters = new int[4];
  53   }
  54
  55   protected int decodeMiddle(BitArray row, int[] startRange, StringBuffer result)
  56       throws ReaderException {
  57     int[] counters = decodeMiddleCounters;
  58     counters[0] = 0;
  59     counters[1] = 0;
  60     counters[2] = 0;
  61     counters[3] = 0;
  62     int end = row.getSize();
  63     int rowOffset = startRange[1];
  64
  65     int lgPatternFound = 0;
  66
  67     for (int x = 0; x < 6 && rowOffset < end; x++) {
  68       int bestMatch = decodeDigit(row, counters, rowOffset, L_AND_G_PATTERNS);
  69       result.append((char) ('0' + bestMatch % 10));
  70       for (int i = 0; i < counters.length; i++) {
  71         rowOffset += counters[i];
  72       }
  73       if (bestMatch >= 10) {
  74         lgPatternFound |= 1 << (5 - x);
  75       }
  76     }
  77
  78     determineNumSysAndCheckDigit(result, lgPatternFound);
  79
  80     return rowOffset;
  81   }
  82
  83   protected int[] decodeEnd(BitArray row, int endStart) throws ReaderException {
  84     return findGuardPattern(row, endStart, true, MIDDLE_END_PATTERN);
  85   }
  86
  87   protected boolean checkChecksum(String s) throws ReaderException {
  88     return super.checkChecksum(convertUPCEtoUPCA(s));
  89   }
  90
  91   private static void determineNumSysAndCheckDigit(StringBuffer resultString, int lgPatternFound)
  92       throws ReaderException {
  93
  94     for (int numSys = 0; numSys <= 1; numSys++) {
  95       for (int d = 0; d < 10; d++) {
  96         if (lgPatternFound == NUMSYS_AND_CHECK_DIGIT_PATTERNS[numSys][d]) {
  97           resultString.insert(0, (char) ('0' + numSys));
  98           resultString.append((char) ('0' + d));
  99           return;
 100         }
 101       }
 102     }
 103     throw ReaderException.getInstance();
 104   }
 105
 106   BarcodeFormat getBarcodeFormat() {
 107     return BarcodeFormat.UPC_E;
 108   }
 109
 110   /**
 111    * Expands a UPC-E value back into its full, equivalent UPC-A code value.
 112    *
 113    * @param upce UPC-E code as string of digits
 114    * @return equivalent UPC-A code as string of digits
 115    */
 116   public static String convertUPCEtoUPCA(String upce) {
 117     char[] upceChars = new char[6];
 118     upce.getChars(1, 7, upceChars, 0);
 119     StringBuffer result = new StringBuffer(12);
 120     result.append(upce.charAt(0));
 121     char lastChar = upceChars[5];
 122     switch (lastChar) {
 123       case '0':
 124       case '1':
 125       case '2':
 126         result.append(upceChars, 0, 2);
 127         result.append(lastChar);
 128         result.append("0000");
 129         result.append(upceChars, 2, 3);
 130         break;
 131       case '3':
 132         result.append(upceChars, 0, 3);
 133         result.append("00000");
 134         result.append(upceChars, 3, 2);
 135         break;
 136       case '4':
 137         result.append(upceChars, 0, 4);
 138         result.append("00000");
 139         result.append(upceChars[4]);
 140         break;
 141       default:
 142         result.append(upceChars, 0, 5);
 143         result.append("0000");
 144         result.append(lastChar);
 145         break;
 146     }
 147     result.append(upce.charAt(7));
 148     return result.toString();
 149   }
 150
 151 }