KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > krysalis > barcode > impl > Code39


1 /*
2  * $Id: Code39.java,v 1.7 2003/10/29 07:50:26 jmaerki Exp $
3  * ============================================================================
4  * The Krysalis Patchy Software License, Version 1.1_01
5  * Copyright (c) 2002-2003 Nicola Ken Barozzi. All rights reserved.
6  *
7  * This Licence is compatible with the BSD licence as described and
8  * approved by http://www.opensource.org/, and is based on the
9  * Apache Software Licence Version 1.1.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * 1. Redistributions of source code must retain the above copyright
16  * notice, this list of conditions and the following disclaimer.
17  *
18  * 2. Redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in
20  * the documentation and/or other materials provided with the
21  * distribution.
22  *
23  * 3. The end-user documentation included with the redistribution,
24  * if any, must include the following acknowledgment:
25  * "This product includes software developed for project
26  * Krysalis (http://www.krysalis.org/)."
27  * Alternately, this acknowledgment may appear in the software itself,
28  * if and wherever such third-party acknowledgments normally appear.
29  *
30  * 4. The names "Krysalis" and "Nicola Ken Barozzi" and
31  * "Krysalis Barcode" must not be used to endorse or promote products
32  * derived from this software without prior written permission. For
33  * written permission, please contact nicolaken@krysalis.org.
34  *
35  * 5. Products derived from this software may not be called "Krysalis",
36  * "Krysalis Barcode", nor may "Krysalis" appear in their name,
37  * without prior written permission of Nicola Ken Barozzi.
38  *
39  * 6. This software may contain voluntary contributions made by many
40  * individuals, who decided to donate the code to this project in
41  * respect of this licence, and was originally created by
42  * Jeremias Maerki <jeremias@maerki.org>.
43  *
44  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
45  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
46  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
47  * DISCLAIMED. IN NO EVENT SHALL THE KRYSALIS PROJECT OR
48  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
49  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
50  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
51  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
52  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
53  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
54  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55  * SUCH DAMAGE.
56  * ====================================================================
57  */
58 package org.krysalis.barcode.impl;
59
60 import org.apache.avalon.framework.configuration.Configurable;
61 import org.apache.avalon.framework.configuration.Configuration;
62 import org.apache.avalon.framework.configuration.ConfigurationException;
63 import org.krysalis.barcode.BarcodeDimension;
64 import org.krysalis.barcode.ChecksumMode;
65 import org.krysalis.barcode.ClassicBarcodeLogicHandler;
66 import org.krysalis.barcode.output.Canvas;
67 import org.krysalis.barcode.output.CanvasProvider;
68 import org.krysalis.barcode.tools.Length;
69
70 /**
71  * This class is an implementation of the Code39 barcode.
72  *
73  * @author Jeremias Maerki
74  */
75 public class Code39 extends GenericBarcodeImpl
76             implements Configurable {
77
78     /** The default wide factor for Code 39 */
79     protected static final double DEFAULT_WIDE_FACTOR = 2.5;
80
81     private ChecksumMode checksumMode = ChecksumMode.CP_AUTO;
82     private double intercharGapWidth = moduleWidth;
83     private double wideFactor = DEFAULT_WIDE_FACTOR; //Width of binary one
84
85     /**
86      * @see org.apache.avalon.framework.configuration.Configurable#configure(Configuration)
87      */
88     public void configure(Configuration cfg) throws ConfigurationException {
89         //Module width (MUST ALWAYS BE FIRST BECAUSE QUIET ZONE MAY DEPEND ON IT)
90 Length mw = new Length(cfg.getChild("module-width").getValue("0.19mm"), "mm");
91         this.moduleWidth = mw.getValueAsMillimeter();
92
93         super.configure(cfg);
94     
95         //Checksum mode
96 this.checksumMode = ChecksumMode.byName(
97             cfg.getChild("checksum").getValue(ChecksumMode.CP_AUTO.getName()));
98     
99         //Wide factor
100 this.wideFactor = cfg.getChild("wide-factor").getValueAsFloat((float)DEFAULT_WIDE_FACTOR);
101     
102         //Inter-character gap width
103 Length igw = new Length(cfg.getChild("interchar-gap-width").getValue("1mw"), "mw");
104         if (igw.getUnit().equalsIgnoreCase("mw")) {
105             this.intercharGapWidth = igw.getValue() * getModuleWidth();
106         } else {
107             this.intercharGapWidth = igw.getValueAsMillimeter();
108         }
109     }
110     
111     /**
112      * Sets the checksum mode
113      * @param mode the checksum mode
114      */
115     public void setChecksumMode(ChecksumMode mode) {
116         this.checksumMode = mode;
117     }
118
119     /**
120      * Returns the current checksum mode.
121      * @return ChecksumMode the checksum mode
122      */
123     public ChecksumMode getChecksumMode() {
124         return this.checksumMode;
125     }
126
127     /**
128      * @see org.krysalis.barcode.impl.GenericBarcodeImpl#getBarWidth(int)
129      */
130     public double getBarWidth(int width) {
131         if (width == 1) {
132             return moduleWidth;
133         } else if (width == 2) {
134             return moduleWidth * wideFactor;
135         } else if (width == -1) {
136             return this.intercharGapWidth;
137         } else throw new IllegalArgumentException JavaDoc("Only widths 1 and 2 allowed");
138     }
139     
140     
141     /**
142      * @see org.krysalis.barcode.BarcodeGenerator#generateBarcode(CanvasProvider, String)
143      */
144     public void generateBarcode(CanvasProvider canvas, String JavaDoc msg) {
145         if ((msg == null)
146                 || (msg.length() == 0)) {
147             throw new NullPointerException JavaDoc("Parameter msg must not be empty");
148         }
149
150         ClassicBarcodeLogicHandler handler =
151                 new DefaultCanvasLogicHandler(this, new Canvas(canvas));
152
153         Code39LogicImpl impl = new Code39LogicImpl(getChecksumMode());
154         impl.generateBarcodeLogic(handler, msg);
155     }
156
157
158     /**
159      * @see org.krysalis.barcode.BarcodeGenerator#calcDimensions(String)
160      */
161     public BarcodeDimension calcDimensions(String JavaDoc msg) {
162         final double width = ((msg.length() + 2) * (3 * wideFactor + 6) * moduleWidth)
163                 + ((msg.length() + 1) * intercharGapWidth);
164         final double qz = (hasQuietZone() ? quietZone : 0);
165         return new BarcodeDimension(width, getHeight(),
166                 width + (2 * qz), getHeight(),
167                 quietZone, 0.0);
168     }
169
170 }
Popular Tags