KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: UPCEAN.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 is an abstract base class for UPC and EAN barcodes.
72  *
73  * @author Jeremias Maerki
74  */
75 public abstract class UPCEAN extends GenericBarcodeImpl
76             implements Configurable {
77
78     private ChecksumMode checksumMode = ChecksumMode.CP_AUTO;
79
80     /**
81      * @see org.apache.avalon.framework.configuration.Configurable#configure(Configuration)
82      */
83     public void configure(Configuration cfg) throws ConfigurationException {
84         //Module width (MUST ALWAYS BE FIRST BECAUSE QUIET ZONE MAY DEPEND ON IT)
85 Length mw = new Length(cfg.getChild("module-width").getValue("0.33mm"), "mm");
86         this.moduleWidth = mw.getValueAsMillimeter();
87
88         super.configure(cfg);
89         
90         //Checksum mode
91 this.checksumMode = ChecksumMode.byName(
92             cfg.getChild("checksum").getValue(ChecksumMode.CP_AUTO.getName()));
93     }
94
95     /**
96      * Sets the checksum mode
97      * @param mode the checksum mode
98      */
99     public void setChecksumMode(ChecksumMode mode) {
100         this.checksumMode = mode;
101     }
102
103     /**
104      * Returns the current checksum mode.
105      * @return ChecksumMode the checksum mode
106      */
107     public ChecksumMode getChecksumMode() {
108         return this.checksumMode;
109     }
110
111     /**
112      * @see org.krysalis.barcode.impl.GenericBarcodeImpl#getBarWidth(int)
113      */
114     public double getBarWidth(int width) {
115         if ((width >= 1) && (width <= 4)) {
116             return width * moduleWidth;
117         } else {
118             throw new IllegalArgumentException JavaDoc("Only widths 1 to 4 allowed");
119         }
120     }
121     
122     
123     /**
124      * Factory method for the logic implementation.
125      * @return the newly created logic implementation instance
126      */
127     public abstract UPCEANLogicImpl createLogicImpl();
128        
129
130     /**
131      * @see org.krysalis.barcode.BarcodeGenerator#generateBarcode(CanvasProvider, String)
132      */
133     public void generateBarcode(CanvasProvider canvas, String JavaDoc msg) {
134         if ((msg == null) || (msg.length() == 0)) {
135             throw new NullPointerException JavaDoc("Parameter msg must not be empty");
136         }
137
138         ClassicBarcodeLogicHandler handler = new UPCEANCanvasLogicHandler(this, new Canvas(canvas));
139         //handler = new LoggingLogicHandlerProxy(handler);
140
141         UPCEANLogicImpl impl = createLogicImpl();
142         impl.generateBarcodeLogic(handler, msg);
143     }
144
145     /**
146      * Calculates the width for the optional supplemental part.
147      * @param msg the full message
148      * @return the width of the supplemental part
149      */
150     protected double supplementalWidth(String JavaDoc msg) {
151         double width = 0;
152         int suppLen = UPCEANLogicImpl.getSupplementalLength(msg);
153         if (suppLen > 0) {
154             //Supplemental
155 width += quietZone;
156             width += 4 * moduleWidth; //left guard
157 width += suppLen * 7 * moduleWidth;
158             width += (suppLen - 1) * 2 * moduleWidth;
159         }
160         return width;
161     }
162
163     /**
164      * @see org.krysalis.barcode.BarcodeGenerator#calcDimensions(String)
165      */
166     public BarcodeDimension calcDimensions(String JavaDoc msg) {
167         double width = 3 * moduleWidth; //left guard
168 width += 6 * 7 * moduleWidth;
169         width += 5 * moduleWidth; //center guard
170 width += 6 * 7 * moduleWidth;
171         width += 3 * moduleWidth; //right guard
172 width += supplementalWidth(msg);
173         final double qz = (hasQuietZone() ? quietZone : 0);
174         return new BarcodeDimension(width, getHeight(),
175                 width + (2 * qz), getHeight(),
176                 quietZone, 0.0);
177     }
178
179
180 }
Popular Tags