1    /* ====================================================================
2     * The Apache Software License, Version 1.1
3     *
4     * Copyright (c) 2002 The Apache Software Foundation.  All rights
5     * reserved.
6     *
7     * Redistribution and use in source and binary forms, with or without
8     * modification, are permitted provided that the following conditions
9     * are met:
10    *
11    * 1. Redistributions of source code must retain the above copyright
12    *    notice, this list of conditions and the following disclaimer.
13    *
14    * 2. Redistributions in binary form must reproduce the above copyright
15    *    notice, this list of conditions and the following disclaimer in
16    *    the documentation and/or other materials provided with the
17    *    distribution.
18    *
19    * 3. The end-user documentation included with the redistribution,
20    *    if any, must include the following acknowledgment:
21    *       "This product includes software developed by the
22    *        Apache Software Foundation (http://www.apache.org/)."
23    *    Alternately, this acknowledgment may appear in the software itself,
24    *    if and wherever such third-party acknowledgments normally appear.
25    *
26    * 4. The names "Apache" and "Apache Software Foundation" and
27    *    "Apache POI" must not be used to endorse or promote products
28    *    derived from this software without prior written permission. For
29    *    written permission, please contact apache@apache.org.
30    *
31    * 5. Products derived from this software may not be called "Apache",
32    *    "Apache POI", nor may "Apache" appear in their name, without
33    *    prior written permission of the Apache Software Foundation.
34    *
35    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46    * SUCH DAMAGE.
47    * ====================================================================
48    *
49    * This software consists of voluntary contributions made by many
50    * individuals on behalf of the Apache Software Foundation.  For more
51    * information on the Apache Software Foundation, please see
52    * <http://www.apache.org/>.
53    */
54   
55   package org.apache.poi.hssf.record.formula;
56   
57   import org.apache.poi.util.LittleEndian;
58   
59   /**
60    * Number
61    * Stores a String value in a formula value stored in the format <length 2 bytes>char[]
62    * @author  Werner Froidevaux
63    */
64   
65   public class StringPtg
66       extends Ptg
67   {
68       public final static int  SIZE = 9;
69       public final static byte sid  = 0x17;
70       private String            field_1_value;
71   
72   
73       /** Create a StringPtg from a byte array read from disk */
74       public StringPtg(byte [] data, int offset)
75       {
76           setValue(new String(data, offset+3, data[offset+1] + 256*data[offset+2]));
77       }
78   
79       /** Create a StringPtg from a string representation of  the number
80        *  Number format is not checked, it is expected to be validated in the parser
81        *   that calls this method.
82        *  @param value : String representation of a floating point number
83        */
84       protected StringPtg(String value) {
85           setValue(value);
86       }
87   
88   
89       public void setValue(String value)
90       {
91           field_1_value = value;
92       }
93   
94   
95       public String getValue()
96       {
97           return field_1_value;
98       }
99   
100      public void writeBytes(byte [] array, int offset)
101      {
102          array[ offset + 0 ] = sid;
103          array[ offset + 1 ] = (byte)(getValue().length() % 256);
104          array[ offset + 2 ] = (byte)(getValue().length() / 256);
105          System.arraycopy(getValue().getBytes(), 0, array, offset + 3, getValue().length());
106      }
107  
108      public int getSize()
109      {
110          return field_1_value.length() + 3;
111      }
112  
113      public String toFormulaString()
114      {
115          return getValue();
116      }
117      public byte getDefaultOperandClass() {
118         return Ptg.CLASS_VALUE;
119     }
120  
121  }
122  
123