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   
68   /**
69    * ReferencePtg - handles references (such as A1, A2, IA4)
70    * @author  Andrew C. Oliver (acoliver@apache.org)
71    */
72   
73   public class ReferencePtg extends Ptg
74   {
75       private final static int SIZE = 5;
76       public final static byte sid  = 0x24;
77       //public final static byte sid = 0x44;
78       private short            field_1_row;
79       private short            field_2_col;
80       private BitField         rowRelative = new BitField(0x8000);
81       private BitField         colRelative = new BitField(0x4000);
82   
83       
84       
85       /**
86        * Takes in a String represnetation of a cell reference and fills out the 
87        * numeric fields.
88        */
89       protected ReferencePtg(String cellref) {
90           CellReference c= new CellReference(cellref);
91           setRow((short) c.getRow());
92           setColumn((short) c.getCol());
93           setColRelative(!c.isColAbsolute());
94           setRowRelative(!c.isRowAbsolute());
95       }
96   
97       /** Creates new ValueReferencePtg */
98   
99       public ReferencePtg(byte[] data, int offset)
100      {
101          offset++;   // adjust for ptg
102          field_1_row = LittleEndian.getShort(data, offset + 0);
103          field_2_col = LittleEndian.getShort(data, offset + 2);
104  
105      }
106  
107      public String toString()
108      {
109          StringBuffer buffer = new StringBuffer("[ValueReferencePtg]\n");
110  
111          buffer.append("row = ").append(getRow()).append("\n");
112          buffer.append("col = ").append(getColumnRaw()).append("\n");
113          buffer.append("rowrelative = ").append(isRowRelative()).append("\n");
114          buffer.append("colrelative = ").append(isColRelative()).append("\n");
115          return buffer.toString();
116      }
117  
118      public void writeBytes(byte [] array, int offset)
119      {
120          array[offset] = (byte) (sid + ptgClass);
121          LittleEndian.putShort(array,offset+1,field_1_row);
122          LittleEndian.putShort(array,offset+3,field_2_col);
123      }
124  
125      public void setRow(short row)
126      {
127          field_1_row = row;
128      }
129  
130      public short getRow()
131      {
132          return field_1_row;
133      }
134  
135      public boolean isRowRelative()
136      {
137          return rowRelative.isSet(field_2_col);
138      }
139      
140      public void setRowRelative(boolean rel) {
141          field_2_col=rowRelative.setShortBoolean(field_2_col,rel);
142      }
143      
144      public boolean isColRelative()
145      {
146          return colRelative.isSet(field_2_col);
147      }
148      
149      public void setColRelative(boolean rel) {
150          field_2_col=colRelative.setShortBoolean(field_2_col,rel);
151      }
152  
153      public void setColumnRaw(short col)
154      {
155          field_2_col = col;
156      }
157  
158      public short getColumnRaw()
159      {
160          return field_2_col;
161      }
162  
163      public void setColumn(short col)
164      {
165          field_2_col = col;   // fix this
166      }
167  
168      public short getColumn()
169      {
170          return rowRelative.setShortBoolean(colRelative.setShortBoolean(field_2_col,false),false);
171      }
172  
173      public int getSize()
174      {
175          return SIZE;
176      }
177  
178      public String toFormulaString()
179      {
180          //TODO -- should we store a cellreference instance in this ptg?? but .. memory is an issue, i believe!
181          return (new CellReference(getRow(),getColumn(),!isRowRelative(),!isColRelative())).toString();
182      }
183      
184      public byte getDefaultOperandClass() {
185          return Ptg.CLASS_REF;
186      }
187      
188  }
189