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