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   import org.apache.poi.hssf.util.SheetReferences;
60   
61   /**
62    * Number
63    * Stores a String value in a formula value stored in the format <length 2 bytes>char[]
64    * @author  Werner Froidevaux
65    * @author Jason Height (jheight at chariot dot net dot au)
66    */
67   
68   public class StringPtg
69       extends Ptg
70   {
71       public final static int  SIZE = 9;
72       public final static byte sid  = 0x17;
73       private String            field_1_value;
74   
75       private StringPtg() {
76         //Required for clone methods
77       }
78   
79       /** Create a StringPtg from a byte array read from disk */
80       public StringPtg(byte [] data, int offset)
81       {
82           setValue(new String(data, offset+3, data[offset+1] + 256*data[offset+2]));
83       }
84   
85       /** Create a StringPtg from a string representation of  the number
86        *  Number format is not checked, it is expected to be validated in the parser
87        *   that calls this method.
88        *  @param value : String representation of a floating point number
89        */
90       public StringPtg(String value) {
91           setValue(value);
92       }
93   
94   
95       public void setValue(String value)
96       {
97           field_1_value = value;
98       }
99   
100  
101      public String getValue()
102      {
103          return field_1_value;
104      }
105  
106      public void writeBytes(byte [] array, int offset)
107      {
108          array[ offset + 0 ] = sid;
109          array[ offset + 1 ] = (byte)(getValue().length() % 256);
110          array[ offset + 2 ] = (byte)(getValue().length() / 256);
111          System.arraycopy(getValue().getBytes(), 0, array, offset + 3, getValue().length());
112      }
113  
114      public int getSize()
115      {
116          return field_1_value.length() + 3;
117      }
118  
119      public String toFormulaString(SheetReferences refs)
120      {
121          return "\""+getValue()+"\"";
122      }
123      public byte getDefaultOperandClass() {
124         return Ptg.CLASS_VALUE;
125     }
126  
127     public Object clone() {
128       StringPtg ptg = new StringPtg();
129       ptg.field_1_value = field_1_value;
130       return ptg;
131     }
132  
133  }
134  
135