001/*
002 * $Id: PdfCollectionItem.java 4784 2011-03-15 08:33:00Z blowagie $
003 *
004 * This file is part of the iText (R) project.
005 * Copyright (c) 1998-2011 1T3XT BVBA
006 * Authors: Bruno Lowagie, Paulo Soares, et al.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU Affero General Public License version 3
010 * as published by the Free Software Foundation with the addition of the
011 * following permission added to Section 15 as permitted in Section 7(a):
012 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT,
013 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
014 *
015 * This program is distributed in the hope that it will be useful, but
016 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
017 * or FITNESS FOR A PARTICULAR PURPOSE.
018 * See the GNU Affero General Public License for more details.
019 * You should have received a copy of the GNU Affero General Public License
020 * along with this program; if not, see http://www.gnu.org/licenses or write to
021 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
022 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
023 * http://itextpdf.com/terms-of-use/
024 *
025 * The interactive user interfaces in modified source and object code versions
026 * of this program must display Appropriate Legal Notices, as required under
027 * Section 5 of the GNU Affero General Public License.
028 *
029 * In accordance with Section 7(b) of the GNU Affero General Public License,
030 * a covered work must retain the producer line in every PDF that is created
031 * or manipulated using iText.
032 *
033 * You can be released from the requirements of the license by purchasing
034 * a commercial license. Buying such a license is mandatory as soon as you
035 * develop commercial activities involving the iText software without
036 * disclosing the source code of your own applications.
037 * These activities include: offering paid services to customers as an ASP,
038 * serving PDFs on the fly in a web application, shipping iText with a closed
039 * source product.
040 *
041 * For more information, please contact iText Software Corp. at this
042 * address: sales@itextpdf.com
043 */
044package com.itextpdf.text.pdf.collection;
045
046import java.util.Calendar;
047import com.itextpdf.text.error_messages.MessageLocalization;
048
049import com.itextpdf.text.pdf.PdfDate;
050import com.itextpdf.text.pdf.PdfDictionary;
051import com.itextpdf.text.pdf.PdfName;
052import com.itextpdf.text.pdf.PdfNumber;
053import com.itextpdf.text.pdf.PdfObject;
054import com.itextpdf.text.pdf.PdfString;
055
056public class PdfCollectionItem extends PdfDictionary {
057        
058        /** The PdfCollectionSchema with the names and types of the items. */
059        PdfCollectionSchema schema;
060        
061        /**
062         * Constructs a Collection Item that can be added to a PdfFileSpecification.
063         */
064        public PdfCollectionItem(PdfCollectionSchema schema) {
065                super(PdfName.COLLECTIONITEM);
066                this.schema = schema;
067        }
068        
069        /**
070         * Sets the value of the collection item.
071         * @param value
072         */
073        public void addItem(String key, String value) {
074                PdfName fieldname = new PdfName(key);
075                PdfCollectionField field = (PdfCollectionField)schema.get(fieldname);
076                put(fieldname, field.getValue(value));
077        }
078        
079        /**
080         * Sets the value of the collection item.
081         * @param value
082         */
083        public void addItem(String key, PdfString value) {
084                PdfName fieldname = new PdfName(key);
085                PdfCollectionField field = (PdfCollectionField)schema.get(fieldname);
086                if (field.fieldType == PdfCollectionField.TEXT) {
087                        put(fieldname, value);
088                }
089        }
090        
091        /**
092         * Sets the value of the collection item.
093         * @param d
094         */
095        public void addItem(String key, PdfDate d) {
096                PdfName fieldname = new PdfName(key);
097                PdfCollectionField field = (PdfCollectionField)schema.get(fieldname);
098                if (field.fieldType == PdfCollectionField.DATE) {
099                        put(fieldname, d);
100                }
101        }
102        
103        /**
104         * Sets the value of the collection item.
105         * @param n
106         */
107        public void addItem(String key, PdfNumber n) {
108                PdfName fieldname = new PdfName(key);
109                PdfCollectionField field = (PdfCollectionField)schema.get(fieldname);
110                if (field.fieldType == PdfCollectionField.NUMBER) {
111                        put(fieldname, n);
112                }
113        }
114        
115        /**
116         * Sets the value of the collection item.
117         * @param c
118         */
119        public void addItem(String key, Calendar c) {
120                addItem(key, new PdfDate(c));
121        }
122        
123        /**
124         * Sets the value of the collection item.
125         * @param i
126         */
127        public void addItem(String key, int i) {
128                addItem(key, new PdfNumber(i));
129        }
130        
131        /**
132         * Sets the value of the collection item.
133         * @param f
134         */
135        public void addItem(String key, float f) {
136                addItem(key, new PdfNumber(f));
137        }
138        
139        /**
140         * Sets the value of the collection item.
141         * @param d
142         */
143        public void addItem(String key, double d) {
144                addItem(key, new PdfNumber(d));
145        }
146        
147        /**
148         * Adds a prefix for the Collection item.
149         * You can only use this method after you have set the value of the item.
150         * @param prefix        a prefix
151         */
152        public void setPrefix(String key, String prefix) {
153                PdfName fieldname = new PdfName(key);
154                PdfObject o = get(fieldname);
155                if (o == null)
156                        throw new IllegalArgumentException(MessageLocalization.getComposedMessage("you.must.set.a.value.before.adding.a.prefix"));
157                PdfDictionary dict = new PdfDictionary(PdfName.COLLECTIONSUBITEM);
158                dict.put(PdfName.D, o);
159                dict.put(PdfName.P, new PdfString(prefix, PdfObject.TEXT_UNICODE));
160                put(fieldname, dict);
161        }
162}