001/*
002 * $Id: RomanAlphabetFactory.java 4847 2011-05-05 19:46:13Z redlab_b $
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.factories;
045
046import com.itextpdf.text.error_messages.MessageLocalization;
047
048/**
049 * This class can produce String combinations representing a number.
050 * "a" to "z" represent 1 to 26, "AA" represents 27, "AB" represents 28,
051 * and so on; "ZZ" is followed by "AAA".
052 */
053public class RomanAlphabetFactory {
054
055        /**
056         * Translates a positive integer (not equal to zero)
057         * into a String using the letters 'a' to 'z';
058         * 1 = a, 2 = b, ..., 26 = z, 27 = aa, 28 = ab,...
059         * @param index the index
060         * @return a translated string
061         */
062        public static final String getString(int index) {
063        if (index < 1) throw new NumberFormatException(MessageLocalization.getComposedMessage("you.can.t.translate.a.negative.number.into.an.alphabetical.value"));
064
065        index--;
066        int bytes = 1;
067        int start = 0;
068        int symbols = 26;
069        while(index >= symbols + start) {
070                bytes++;
071            start += symbols;
072                symbols *= 26;
073        }
074
075        int c = index - start;
076        char[] value = new char[bytes];
077        while(bytes > 0) {
078                value[--bytes] = (char)( 'a' + (c % 26));
079                c /= 26;
080        }
081
082        return new String(value);
083        }
084
085        /**
086         * Translates a positive integer (not equal to zero)
087         * into a String using the letters 'a' to 'z';
088         * 1 = a, 2 = b, ..., 26 = z, 27 = aa, 28 = ab,...
089         * @param index the int to translate
090         * @return the string in lowercase
091         */
092        public static final String getLowerCaseString(final int index) {
093                return getString(index);
094        }
095
096        /**
097         * Translates a positive integer (not equal to zero)
098         * into a String using the letters 'A' to 'Z';
099         * 1 = A, 2 = B, ..., 26 = Z, 27 = AA, 28 = AB,...
100         * @param index the int to translate
101         * @return the string in uppercase
102         */
103        public static final String getUpperCaseString(final int index) {
104                return getString(index).toUpperCase();
105        }
106
107
108        /**
109         * Translates a positive integer (not equal to zero)
110         * into a String using the letters 'a' to 'z'
111         * (a = 1, b = 2, ..., z = 26, aa = 27, ab = 28,...).
112         * @param index the int to translate
113         * @param lowercase true if the string sshould be lowercase false otherwise
114         * @return the translated string
115         */
116        public static final String getString(final int index, final boolean lowercase) {
117                if (lowercase) {
118                        return getLowerCaseString(index);
119                }
120                else {
121                        return getUpperCaseString(index);
122                }
123        }
124}