1    
2    /* ====================================================================
3     * The Apache Software License, Version 1.1
4     *
5     * Copyright (c) 2002 The Apache Software Foundation.  All rights
6     * reserved.
7     *
8     * Redistribution and use in source and binary forms, with or without
9     * modification, are permitted provided that the following conditions
10    * are met:
11    *
12    * 1. Redistributions of source code must retain the above copyright
13    *    notice, this list of conditions and the following disclaimer.
14    *
15    * 2. Redistributions in binary form must reproduce the above copyright
16    *    notice, this list of conditions and the following disclaimer in
17    *    the documentation and/or other materials provided with the
18    *    distribution.
19    *
20    * 3. The end-user documentation included with the redistribution,
21    *    if any, must include the following acknowledgment:
22    *       "This product includes software developed by the
23    *        Apache Software Foundation (http://www.apache.org/)."
24    *    Alternately, this acknowledgment may appear in the software itself,
25    *    if and wherever such third-party acknowledgments normally appear.
26    *
27    * 4. The names "Apache" and "Apache Software Foundation" and
28    *    "Apache POI" must not be used to endorse or promote products
29    *    derived from this software without prior written permission. For
30    *    written permission, please contact apache@apache.org.
31    *
32    * 5. Products derived from this software may not be called "Apache",
33    *    "Apache POI", nor may "Apache" appear in their name, without
34    *    prior written permission of the Apache Software Foundation.
35    *
36    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47    * SUCH DAMAGE.
48    * ====================================================================
49    *
50    * This software consists of voluntary contributions made by many
51    * individuals on behalf of the Apache Software Foundation.  For more
52    * information on the Apache Software Foundation, please see
53    * <http://www.apache.org/>.
54    */
55   
56   /*
57    * ValueReferencePtg.java
58    *
59    * Created on November 21, 2001, 5:27 PM
60    */
61   package org.apache.poi.hssf.record.formula;
62   
63   import org.apache.poi.util.LittleEndian;
64   import org.apache.poi.util.BitField;
65   
66   import org.apache.poi.hssf.util.CellReference;
67   import org.apache.poi.hssf.util.SheetReferences;
68   
69   /**
70    * ReferencePtg - handles references (such as A1, A2, IA4)
71    * @author  Andrew C. Oliver (acoliver@apache.org)
72    * @author Jason Height (jheight at chariot dot net dot au)
73    */
74   
75   public class ReferencePtg extends Ptg
76   {
77       private final static int SIZE = 5;
78       public final static byte sid  = 0x24;
79       //public final static byte sid = 0x44;
80       private short            field_1_row;
81       private short            field_2_col;
82       private BitField         rowRelative = new BitField(0x8000);
83       private BitField         colRelative = new BitField(0x4000);
84   
85       private ReferencePtg() {
86         //Required for clone methods
87       }
88       
89       /**
90        * Takes in a String represnetation of a cell reference and fills out the 
91        * numeric fields.
92        */
93       public ReferencePtg(String cellref) {
94           CellReference c= new CellReference(cellref);
95           setRow((short) c.getRow());
96           setColumn((short) c.getCol());
97           setColRelative(!c.isColAbsolute());
98           setRowRelative(!c.isRowAbsolute());
99       }
100  
101      /** Creates new ValueReferencePtg */
102  
103      public ReferencePtg(byte[] data, int offset)
104      {
105          offset++;   // adjust for ptg
106          field_1_row = LittleEndian.getShort(data, offset + 0);
107          field_2_col = LittleEndian.getShort(data, offset + 2);
108  
109      }
110  
111      public String toString()
112      {
113          StringBuffer buffer = new StringBuffer("[ValueReferencePtg]\n");
114  
115          buffer.append("row = ").append(getRow()).append("\n");
116          buffer.append("col = ").append(getColumnRaw()).append("\n");
117          buffer.append("rowrelative = ").append(isRowRelative()).append("\n");
118          buffer.append("colrelative = ").append(isColRelative()).append("\n");
119          return buffer.toString();
120      }
121  
122      public void writeBytes(byte [] array, int offset)
123      {
124          array[offset] = (byte) (sid + ptgClass);
125          LittleEndian.putShort(array,offset+1,field_1_row);
126          LittleEndian.putShort(array,offset+3,field_2_col);
127      }
128  
129      public void setRow(short row)
130      {
131          field_1_row = row;
132      }
133  
134      public short getRow()
135      {
136          return field_1_row;
137      }
138  
139      public boolean isRowRelative()
140      {
141          return rowRelative.isSet(field_2_col);
142      }
143      
144      public void setRowRelative(boolean rel) {
145          field_2_col=rowRelative.setShortBoolean(field_2_col,rel);
146      }
147      
148      public boolean isColRelative()
149      {
150          return colRelative.isSet(field_2_col);
151      }
152      
153      public void setColRelative(boolean rel) {
154          field_2_col=colRelative.setShortBoolean(field_2_col,rel);
155      }
156  
157      public void setColumnRaw(short col)
158      {
159          field_2_col = col;
160      }
161  
162      public short getColumnRaw()
163      {
164          return field_2_col;
165      }
166  
167      public void setColumn(short col)
168      {
169          field_2_col = col;   // fix this
170      }
171  
172      public short getColumn()
173      {
174          return rowRelative.setShortBoolean(colRelative.setShortBoolean(field_2_col,false),false);
175      }
176  
177      public int getSize()
178      {
179          return SIZE;
180      }
181  
182      public String toFormulaString(SheetReferences refs)
183      {
184          //TODO -- should we store a cellreference instance in this ptg?? but .. memory is an issue, i believe!
185          return (new CellReference(getRow(),getColumn(),!isRowRelative(),!isColRelative())).toString();
186      }
187      
188      public byte getDefaultOperandClass() {
189          return Ptg.CLASS_REF;
190      }
191      
192      public Object clone() {
193        ReferencePtg ptg = new ReferencePtg();
194        ptg.field_1_row = field_1_row;
195        ptg.field_2_col = field_2_col;
196        return ptg;
197      }
198  }
199