001/*
002 * $Id: PdfCollectionSort.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 com.itextpdf.text.pdf.PdfArray;
047import com.itextpdf.text.pdf.PdfBoolean;
048import com.itextpdf.text.pdf.PdfDictionary;
049import com.itextpdf.text.pdf.PdfName;
050import com.itextpdf.text.pdf.PdfObject;
051import com.itextpdf.text.error_messages.MessageLocalization;
052
053public class PdfCollectionSort extends PdfDictionary {
054        
055        /**
056         * Constructs a PDF Collection Sort Dictionary.
057         * @param key   the key of the field that will be used to sort entries
058         */
059        public PdfCollectionSort(String key) {
060                super(PdfName.COLLECTIONSORT);
061                put(PdfName.S, new PdfName(key));
062        }
063        
064        /**
065         * Constructs a PDF Collection Sort Dictionary.
066         * @param keys  the keys of the fields that will be used to sort entries
067         */
068        public PdfCollectionSort(String[] keys) {
069                super(PdfName.COLLECTIONSORT);
070                PdfArray array = new PdfArray();
071                for (int i = 0; i < keys.length; i++) {
072                        array.add(new PdfName(keys[i]));
073                }
074                put(PdfName.S, array);
075        }
076        
077        /**
078         * Defines the sort order of the field (ascending or descending).
079         * @param ascending     true is the default, use false for descending order
080         */
081        public void setSortOrder(boolean ascending) {
082                PdfObject o = get(PdfName.S);
083                if (o instanceof PdfName) {
084                        put(PdfName.A, new PdfBoolean(ascending));
085                }
086                else {
087                        throw new IllegalArgumentException(MessageLocalization.getComposedMessage("you.have.to.define.a.boolean.array.for.this.collection.sort.dictionary"));
088                }
089        }
090        
091        /**
092         * Defines the sort order of the field (ascending or descending).
093         * @param ascending     an array with every element corresponding with a name of a field.
094         */
095        public void setSortOrder(boolean[] ascending) {
096                PdfObject o = get(PdfName.S);
097                if (o instanceof PdfArray) {
098                        if (((PdfArray)o).size() != ascending.length) {
099                                throw new IllegalArgumentException(MessageLocalization.getComposedMessage("the.number.of.booleans.in.this.array.doesn.t.correspond.with.the.number.of.fields"));
100                        }
101                        PdfArray array = new PdfArray();
102                        for (int i = 0; i < ascending.length; i++) {
103                                array.add(new PdfBoolean(ascending[i]));
104                        }
105                        put(PdfName.A, array);
106                }
107                else {
108                        throw new IllegalArgumentException(MessageLocalization.getComposedMessage("you.need.a.single.boolean.for.this.collection.sort.dictionary"));
109                }
110        }
111        
112        
113}