src/java/org/apache/poi/hssf/usermodel/HSSFDataFormat.java

   1 /* ====================================================================
   2    Licensed to the Apache Software Foundation (ASF) under one or more
   3    contributor license agreements.  See the NOTICE file distributed with
   4    this work for additional information regarding copyright ownership.
   5    The ASF licenses this file to You under the Apache License, Version 2.0
   6    (the "License"); you may not use this file except in compliance with
   7    the License.  You may obtain a copy of the License at
   8
   9        http://www.apache.org/licenses/LICENSE-2.0
  10
  11    Unless required by applicable law or agreed to in writing, software
  12    distributed under the License is distributed on an "AS IS" BASIS,
  13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14    See the License for the specific language governing permissions and
  15    limitations under the License.
  16 ==================================================================== */
  17
  18
  19 /*
  20  * HSSFDataFormat.java
  21  *
  22  * Created on December 18, 2001, 12:42 PM
  23  */
  24 package org.apache.poi.hssf.usermodel;
  25
  26 import org.apache.poi.hssf.model.Workbook;
  27 import org.apache.poi.hssf.record.FormatRecord;
  28
  29 import java.util.Iterator;
  30 import java.util.List;
  31 import java.util.ListIterator;
  32 import java.util.Vector;
  33
  34 /**
  35  * Utility to identify builtin formats.  Now can handle user defined data formats also.  The following is a list of the formats as
  36  * returned by this class.<P>
  37  *<P>
  38  *       0, "General"<br>
  39  *       1, "0"<br>
  40  *       2, "0.00"<br>
  41  *       3, "#,##0"<br>
  42  *       4, "#,##0.00"<br>
  43  *       5, "($#,##0_);($#,##0)"<br>
  44  *       6, "($#,##0_);[Red]($#,##0)"<br>
  45  *       7, "($#,##0.00);($#,##0.00)"<br>
  46  *       8, "($#,##0.00_);[Red]($#,##0.00)"<br>
  47  *       9, "0%"<br>
  48  *       0xa, "0.00%"<br>
  49  *       0xb, "0.00E+00"<br>
  50  *       0xc, "# ?/?"<br>
  51  *       0xd, "# ??/??"<br>
  52  *       0xe, "m/d/yy"<br>
  53  *       0xf, "d-mmm-yy"<br>
  54  *       0x10, "d-mmm"<br>
  55  *       0x11, "mmm-yy"<br>
  56  *       0x12, "h:mm AM/PM"<br>
  57  *       0x13, "h:mm:ss AM/PM"<br>
  58  *       0x14, "h:mm"<br>
  59  *       0x15, "h:mm:ss"<br>
  60  *       0x16, "m/d/yy h:mm"<br>
  61  *<P>
  62  *       // 0x17 - 0x24 reserved for international and undocumented
  63  *       0x25, "(#,##0_);(#,##0)"<P>
  64  *       0x26, "(#,##0_);[Red](#,##0)"<P>
  65  *       0x27, "(#,##0.00_);(#,##0.00)"<P>
  66  *       0x28, "(#,##0.00_);[Red](#,##0.00)"<P>
  67  *       0x29, "_(*#,##0_);_(*(#,##0);_(* \"-\"_);_(@_)"<P>
  68  *       0x2a, "_($*#,##0_);_($*(#,##0);_($* \"-\"_);_(@_)"<P>
  69  *       0x2b, "_(*#,##0.00_);_(*(#,##0.00);_(*\"-\"??_);_(@_)"<P>
  70  *       0x2c, "_($*#,##0.00_);_($*(#,##0.00);_($*\"-\"??_);_(@_)"<P>
  71  *       0x2d, "mm:ss"<P>
  72  *       0x2e, "[h]:mm:ss"<P>
  73  *       0x2f, "mm:ss.0"<P>
  74  *       0x30, "##0.0E+0"<P>
  75  *       0x31, "@" - This is text format.<P>
  76  *       0x31  "text" - Alias for "@"<P>
  77  *
  78  * @author  Andrew C. Oliver (acoliver at apache dot org)
  79  * @author  Shawn M. Laubach (slaubach at apache dot org)
  80  */
  81
  82 public class HSSFDataFormat
  83 {
  84     private static List builtinFormats = createBuiltinFormats();
  85
  86     private Vector formats = new Vector();
  87     private Workbook workbook;
  88     private boolean movedBuiltins = false;  // Flag to see if need to
  89     // check the built in list
  90     // or if the regular list
  91     // has all entries.
  92
  93     /**
  94      * Construncts a new data formatter.  It takes a workbook to have
  95      * access to the workbooks format records.
  96      * @param workbook the workbook the formats are tied to.
  97      */
  98     public HSSFDataFormat( Workbook workbook )
  99     {
 100         this.workbook = workbook;
 101         Iterator i = workbook.getFormats().iterator();
 102         while ( i.hasNext() )
 103         {
 104             FormatRecord r = (FormatRecord) i.next();
 105             if ( formats.size() < r.getIndexCode() + 1 )
 106             {
 107                 formats.setSize( r.getIndexCode() + 1 );
 108             }
 109             formats.set( r.getIndexCode(), r.getFormatString() );
 110         }
 111
 112     }
 113
 114     private static synchronized List createBuiltinFormats()
 115     {
 116         List builtinFormats = new Vector();
 117         builtinFormats.add( 0, "General" );
 118         builtinFormats.add( 1, "0" );
 119         builtinFormats.add( 2, "0.00" );
 120         builtinFormats.add( 3, "#,##0" );
 121         builtinFormats.add( 4, "#,##0.00" );
 122         builtinFormats.add( 5, "($#,##0_);($#,##0)" );
 123         builtinFormats.add( 6, "($#,##0_);[Red]($#,##0)" );
 124         builtinFormats.add( 7, "($#,##0.00);($#,##0.00)" );
 125         builtinFormats.add( 8, "($#,##0.00_);[Red]($#,##0.00)" );
 126         builtinFormats.add( 9, "0%" );
 127         builtinFormats.add( 0xa, "0.00%" );
 128         builtinFormats.add( 0xb, "0.00E+00" );
 129         builtinFormats.add( 0xc, "# ?/?" );
 130         builtinFormats.add( 0xd, "# ??/??" );
 131         builtinFormats.add( 0xe, "m/d/yy" );
 132         builtinFormats.add( 0xf, "d-mmm-yy" );
 133         builtinFormats.add( 0x10, "d-mmm" );
 134         builtinFormats.add( 0x11, "mmm-yy" );
 135         builtinFormats.add( 0x12, "h:mm AM/PM" );
 136         builtinFormats.add( 0x13, "h:mm:ss AM/PM" );
 137         builtinFormats.add( 0x14, "h:mm" );
 138         builtinFormats.add( 0x15, "h:mm:ss" );
 139         builtinFormats.add( 0x16, "m/d/yy h:mm" );
 140
 141         // 0x17 - 0x24 reserved for international and undocumented
 142         builtinFormats.add( 0x17, "0x17" );
 143         builtinFormats.add( 0x18, "0x18" );
 144         builtinFormats.add( 0x19, "0x19" );
 145         builtinFormats.add( 0x1a, "0x1a" );
 146         builtinFormats.add( 0x1b, "0x1b" );
 147         builtinFormats.add( 0x1c, "0x1c" );
 148         builtinFormats.add( 0x1d, "0x1d" );
 149         builtinFormats.add( 0x1e, "0x1e" );
 150         builtinFormats.add( 0x1f, "0x1f" );
 151         builtinFormats.add( 0x20, "0x20" );
 152         builtinFormats.add( 0x21, "0x21" );
 153         builtinFormats.add( 0x22, "0x22" );
 154         builtinFormats.add( 0x23, "0x23" );
 155         builtinFormats.add( 0x24, "0x24" );
 156
 157         // 0x17 - 0x24 reserved for international and undocumented
 158         builtinFormats.add( 0x25, "(#,##0_);(#,##0)" );
 159         builtinFormats.add( 0x26, "(#,##0_);[Red](#,##0)" );
 160         builtinFormats.add( 0x27, "(#,##0.00_);(#,##0.00)" );
 161         builtinFormats.add( 0x28, "(#,##0.00_);[Red](#,##0.00)" );
 162         builtinFormats.add( 0x29, "_(*#,##0_);_(*(#,##0);_(* \"-\"_);_(@_)" );
 163         builtinFormats.add( 0x2a, "_($*#,##0_);_($*(#,##0);_($* \"-\"_);_(@_)" );
 164         builtinFormats.add( 0x2b, "_(*#,##0.00_);_(*(#,##0.00);_(*\"-\"??_);_(@_)" );
 165         builtinFormats.add( 0x2c,
 166                 "_($*#,##0.00_);_($*(#,##0.00);_($*\"-\"??_);_(@_)" );
 167         builtinFormats.add( 0x2d, "mm:ss" );
 168         builtinFormats.add( 0x2e, "[h]:mm:ss" );
 169         builtinFormats.add( 0x2f, "mm:ss.0" );
 170         builtinFormats.add( 0x30, "##0.0E+0" );
 171         builtinFormats.add( 0x31, "@" );
 172         return builtinFormats;
 173     }
 174
 175     public static List getBuiltinFormats()
 176     {
 177         return builtinFormats;
 178     }
 179
 180     /**
 181      * get the format index that matches the given format string<p>
 182      * Automatically converts "text" to excel's format string to represent text.
 183      * @param format string matching a built in format
 184      * @return index of format or -1 if undefined.
 185      */
 186
 187     public static short getBuiltinFormat( String format )
 188     {
 189         if (format.toUpperCase().equals("TEXT"))
 190                 format = "@";
 191
 192         short retval = -1;
 193
 194         for (short k = 0; k <= 0x31; k++)
 195         {
 196             String nformat = (String) builtinFormats.get( k );
 197
 198             if ( ( nformat != null ) && nformat.equals( format ) )
 199             {
 200                 retval = k;
 201                 break;
 202             }
 203         }
 204         return retval;
 205     }
 206
 207     /**
 208      * Get the format index that matches the given format
 209      *  string, creating a new format entry if required.
 210      * Aliases text to the proper format as required.
 211      * @param format string matching a built in format
 212      * @return index of format.
 213      */
 214     public short getFormat( String format )
 215     {
 216         ListIterator i;
 217         int ind;
 218
 219         if (format.toUpperCase().equals("TEXT"))
 220                 format = "@";
 221
 222         if ( !movedBuiltins )
 223         {
 224             i = builtinFormats.listIterator();
 225             while ( i.hasNext() )
 226             {
 227                 ind = i.nextIndex();
 228                 if ( formats.size() < ind + 1 )
 229                 {
 230                     formats.setSize( ind + 1 );
 231                 }
 232
 233                 formats.set( ind, i.next() );
 234             }
 235             movedBuiltins = true;
 236         }
 237         i = formats.listIterator();
 238         while ( i.hasNext() )
 239         {
 240             ind = i.nextIndex();
 241             if ( format.equals( i.next() ) )
 242                 return (short) ind;
 243         }
 244
 245         ind = workbook.getFormat( format, true );
 246         if ( formats.size() <= ind )
 247             formats.setSize( ind + 1 );
 248         formats.set( ind, format );
 249
 250         return (short) ind;
 251     }
 252
 253     /**
 254      * get the format string that matches the given format index
 255      * @param index of a format
 256      * @return string represented at index of format or null if there is not a  format at that index
 257      */
 258
 259     public String getFormat( short index )
 260     {
 261         if ( movedBuiltins )
 262             return (String) formats.get( index );
 263         else
 264             return (String) ( builtinFormats.size() > index
 265                     && builtinFormats.get( index ) != null
 266                     ? builtinFormats.get( index ) : formats.get( index ) );
 267     }
 268
 269     /**
 270      * get the format string that matches the given format index
 271      * @param index of a built in format
 272      * @return string represented at index of format or null if there is not a builtin format at that index
 273      * @throws ArrayOutOfBoundsException when the index exceeds the number of builtin formats.
 274      */
 275
 276     public static String getBuiltinFormat( short index )
 277     {
 278         return (String) builtinFormats.get( index );
 279     }
 280
 281     /**
 282      * get the number of builtin and reserved builtinFormats
 283      * @return number of builtin and reserved builtinFormats
 284      */
 285
 286     public static int getNumberOfBuiltinBuiltinFormats()
 287     {
 288         return builtinFormats.size();
 289     }
 290 }