KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: Interleaved2Of5.java,v 1.5 2003/10/29 07:50:25 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
64 import org.krysalis.barcode.BarcodeDimension;
65 import org.krysalis.barcode.ChecksumMode;
66 import org.krysalis.barcode.ClassicBarcodeLogicHandler;
67 import org.krysalis.barcode.output.Canvas;
68 import org.krysalis.barcode.output.CanvasProvider;
69 import org.krysalis.barcode.tools.Length;
70
71 /**
72  * This class is an implementation of the Interleaved 2 of 5 barcode.
73  *
74  * @author Jeremias Maerki
75  */

76 public class Interleaved2Of5 extends GenericBarcodeImpl
77             implements Configurable {
78
79     private static final double DEFAULT_WIDE_FACTOR = 3.0;
80
81     private ChecksumMode checksumMode = ChecksumMode.CP_AUTO;
82     private double wideFactor = DEFAULT_WIDE_FACTOR; //Determines the width of wide bar
83

84     /**
85      * @see org.apache.avalon.framework.configuration.Configurable#configure(Configuration)
86      */

87     public void configure(Configuration cfg) throws ConfigurationException {
88         //Module width (MUST ALWAYS BE FIRST BECAUSE QUIET ZONE MAY DEPEND ON IT)
89
Length mw = new Length(cfg.getChild("module-width").getValue("0.21mm"), "mm");
90         this.moduleWidth = mw.getValueAsMillimeter();
91
92         super.configure(cfg);
93         
94         //Checksum mode
95
this.checksumMode = ChecksumMode.byName(
96             cfg.getChild("checksum").getValue(ChecksumMode.CP_AUTO.getName()));
97
98         //Wide factor
99
this.wideFactor = cfg.getChild("wide-factor").getValueAsFloat((float)DEFAULT_WIDE_FACTOR);
100     }
101
102     /**
103      * @see org.krysalis.barcode.BarcodeGenerator#generateBarcode(CanvasProvider, String)
104      */

105     public void generateBarcode(CanvasProvider canvas, String JavaDoc msg) {
106         if ((msg == null)
107                 || (msg.length() == 0)) {
108             throw new NullPointerException JavaDoc("Parameter msg must not be empty");
109         }
110
111         ClassicBarcodeLogicHandler handler =
112                 new DefaultCanvasLogicHandler(this, new Canvas(canvas));
113         //handler = new LoggingLogicHandlerProxy(handler);
114

115         Interleaved2Of5LogicImpl impl = new Interleaved2Of5LogicImpl(getChecksumMode());
116         impl.generateBarcodeLogic(handler, msg);
117     }
118     
119     /**
120      * @see org.krysalis.barcode.BarcodeGenerator#calcDimensions(String)
121      */

122     public BarcodeDimension calcDimensions(String JavaDoc msg) {
123         int msgLen = msg.length();
124         if (getChecksumMode() == ChecksumMode.CP_ADD) {
125             msgLen++;
126         }
127         if ((msgLen % 2) != 0) {
128             msgLen++; //Compensate for odd number of characters
129
}
130         final double charwidth = 2 * wideFactor + 3;
131         final double width = ((msgLen * charwidth) + 6 + wideFactor) * moduleWidth;
132         final double qz = (hasQuietZone() ? quietZone : 0);
133         return new BarcodeDimension(width, getHeight(),
134                 width + (2 * qz), getHeight(),
135                 quietZone, 0.0);
136     }
137
138     /**
139      * @see org.krysalis.barcode.impl.GenericBarcodeImpl#getBarWidth(int)
140      */

141     public double getBarWidth(int width) {
142         if (width == 1) {
143             return moduleWidth;
144         } else if (width == 2) {
145             return moduleWidth * wideFactor;
146         } else throw new IllegalArgumentException JavaDoc("Only widths 1 and 2 allowed");
147     }
148     
149     /**
150      * Sets the checksum mode
151      * @param mode the checksum mode
152      */

153     public void setChecksumMode(ChecksumMode mode) {
154         this.checksumMode = mode;
155     }
156
157     /**
158      * Returns the current checksum mode.
159      * @return ChecksumMode the checksum mode
160      */

161     public ChecksumMode getChecksumMode() {
162         return this.checksumMode;
163     }
164
165 }
Popular Tags