KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: POSTNET.java,v 1.2 2003/10/29 07:50:26 jmaerki Exp $
3  * ============================================================================
4  * The Krysalis Patchy Software License, Version 1.1_01
5  * Copyright (c) 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.BaselineAlignment;
65 import org.krysalis.barcode.ChecksumMode;
66 import org.krysalis.barcode.HumanReadablePlacement;
67 import org.krysalis.barcode.output.Canvas;
68 import org.krysalis.barcode.output.CanvasProvider;
69 import org.krysalis.barcode.tools.Length;
70
71 /**
72  * Implements the United States Postal Service POSTNET barcode.
73  *
74  * @author Chris Dolphy
75  */
76 public class POSTNET extends HeightVariableBarcodeImpl
77             implements Configurable {
78
79     private ChecksumMode checksumMode = ChecksumMode.CP_AUTO;
80
81     private double intercharGapWidth = moduleWidth;
82     private BaselineAlignment baselinePosition = BaselineAlignment.ALIGN_BOTTOM;
83     private double shortBarHeight = 1.25f;
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.020in"), "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         //Inter-character gap width
100 Length igw = new Length(cfg.getChild("interchar-gap-width").getValue("0.026in"), "mm");
101         this.intercharGapWidth = igw.getValueAsMillimeter();
102
103         Length h = new Length(cfg.getChild("tall-bar-height").getValue("0.125in"), "mm");
104         this.setBarHeight(h.getValueAsMillimeter());
105         
106         Length hbh = new Length(cfg.getChild("short-bar-height").getValue("0.050in"), "mm");
107         this.shortBarHeight = hbh.getValueAsMillimeter();
108
109         //Human-readable placement
110 this.msgPos = HumanReadablePlacement.byName(
111             cfg.getChild("human-readable").getValue(HumanReadablePlacement.HRP_NONE.getName()));
112
113         this.baselinePosition = BaselineAlignment.byName(
114             cfg.getChild("baseline-alignment").getValue(BaselineAlignment.ALIGN_BOTTOM.getName()));
115     }
116     
117     /**
118      * Sets the checksum mode
119      * @param mode the checksum mode
120      */
121     public void setChecksumMode(ChecksumMode mode) {
122         this.checksumMode = mode;
123     }
124
125     /**
126      * Returns the current checksum mode.
127      * @return ChecksumMode the checksum mode
128      */
129     public ChecksumMode getChecksumMode() {
130         return this.checksumMode;
131     }
132
133     /**
134      * @see org.krysalis.barcode.impl.GenericBarcodeImpl#getBarWidth(int)
135      */
136     public double getBarWidth(int width) {
137         if (width == 1) {
138             return moduleWidth;
139         } else if (width == -1) {
140             return this.intercharGapWidth;
141         } else throw new IllegalArgumentException JavaDoc("Only width 1 allowed");
142     }
143     
144     /**
145      * @see org.krysalis.barcode.impl.HeightVariableBarcodeImpl#getBarHeight(int)
146      */
147     public double getBarHeight(int height) {
148         if (height == 2) {
149             return getBarHeight();
150         } else if (height == 1) {
151             return shortBarHeight;
152         } else if (height == -1) {
153             return getBarHeight(); // doesn't matter since it's blank
154 } else throw new IllegalArgumentException JavaDoc("Only height 0 or 1 allowed");
155     }
156     
157     /**
158      * @see org.krysalis.barcode.BarcodeGenerator#generateBarcode(CanvasProvider, String)
159      */
160     public void generateBarcode(CanvasProvider canvas, String JavaDoc msg) {
161         if ((msg == null)
162                 || (msg.length() == 0)) {
163             throw new NullPointerException JavaDoc("Parameter msg must not be empty");
164         }
165
166         DefaultHeightVariableLogicHandler handler =
167                 new DefaultHeightVariableLogicHandler(this, new Canvas(canvas));
168
169         POSTNETLogicImpl impl = new POSTNETLogicImpl(getChecksumMode());
170         impl.generateBarcodeLogic(handler, msg);
171     }
172
173     /**
174      * @see org.krysalis.barcode.BarcodeGenerator#calcDimensions(String)
175      */
176     public BarcodeDimension calcDimensions(String JavaDoc msg) {
177         String JavaDoc modMsg = POSTNETLogicImpl.removeIgnoredCharacters(msg);
178         final double width = (((modMsg.length() * 5) + 2) * moduleWidth)
179                 + (((modMsg.length() * 5) + 1) * intercharGapWidth);
180         final double qz = (hasQuietZone() ? quietZone : 0);
181         double height = getHeight();
182         if (getMsgPosition() == HumanReadablePlacement.HRP_NONE) {
183             height -= getHumanReadableHeight();
184         }
185         return new BarcodeDimension(width, height,
186                 width + (2 * qz), height,
187                 quietZone, 0.0);
188     }
189
190     /**
191      * @see org.krysalis.barcode.impl.HeightVariableBarcodeImpl#getBaselinePosition()
192      */
193     public BaselineAlignment getBaselinePosition() {
194         return baselinePosition;
195     }
196
197     /**
198      * @see org.krysalis.barcode.impl.HeightVariableBarcodeImpl#setBaselinePosition(int)
199      */
200     public void setBaselinePosition(BaselineAlignment baselinePosition) {
201         this.baselinePosition = baselinePosition;
202     }
203
204 }
Popular Tags