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.util; 56 57 /** 58 * 59 * @author Avik Sengupta 60 */ 61 public class CellReference { 62 63 /** Creates new CellReference */ 64 private int row; 65 private int col; 66 private boolean rowAbs; 67 private boolean colAbs; 68 69 public CellReference(String cellRef) { 70 String[] parts = seperateRowColumns(cellRef); 71 String ref = parts[0]; 72 if (ref.charAt(0) == '$') { 73 colAbs=true; 74 ref=ref.substring(1); 75 } 76 col = convertColStringToNum(ref); 77 ref=parts[1]; 78 if (ref.charAt(0) == '$') { 79 rowAbs=true; 80 ref=ref.substring(1); 81 } 82 row = Integer.parseInt(ref)-1; 83 } 84 85 public CellReference(int pRow, int pCol) { 86 this(pRow,pCol,false,false); 87 } 88 89 public CellReference(int pRow, int pCol, boolean pAbsRow, boolean pAbsCol) { 90 row=pRow;col=pCol; 91 rowAbs = pAbsRow; 92 colAbs=pAbsCol; 93 94 } 95 96 public int getRow(){return row;} 97 public int getCol(){return col;} 98 public boolean isRowAbsolute(){return rowAbs;} 99 public boolean isColAbsolute(){return colAbs;} 100 101 /** 102 * takes in a column reference portion of a CellRef and converts it from 103 * ALPHA-26 number format to 0-based base 10. 104 */ 105 private int convertColStringToNum(String ref) { 106 int len = ref.length(); 107 int retval=0; 108 int pos = 0; 109 110 for (int k = ref.length()-1; k > -1; k--) { 111 char thechar = ref.charAt(k); 112 if ( pos == 0) { 113 retval += (Character.getNumericValue(thechar)-9); 114 } else { 115 retval += (Character.getNumericValue(thechar)-9) * (pos * 26); 116 } 117 pos++; 118 } 119 return retval-1; 120 } 121 122 123 /** 124 * Seperates the row from the columns and returns an array. Element in 125 * position one is the substring containing the columns still in ALPHA-26 126 * number format. 127 */ 128 private String[] seperateRowColumns(String reference) { 129 int loc = 0; // location of first number 130 String retval[] = new String[2]; 131 int length = reference.length(); 132 133 char[] chars = reference.toCharArray(); 134 if (chars[loc]=='$') loc++; 135 for (; loc < chars.length; loc++) { 136 if (Character.isDigit(chars[loc]) || chars[loc] == '$') { 137 break; 138 } 139 } 140 141 142 retval[0] = reference.substring(0,loc); 143 retval[1] = reference.substring(loc); 144 return retval; 145 } 146 147 /** 148 * takes in a 0-based base-10 column and returns a ALPHA-26 representation 149 */ 150 private static String convertNumToColString(int col) { 151 String retval = null; 152 int mod = col % 26; 153 int div = col / 26; 154 char small=(char)(mod + 65); 155 char big = (char)(div + 64); 156 157 if (div == 0) { 158 retval = ""+small; 159 } else { 160 retval = ""+big+""+small; 161 } 162 163 return retval; 164 } 165 166 167 public String toString() { 168 StringBuffer retval = new StringBuffer(); 169 retval.append( (colAbs)?"$":""); 170 retval.append( convertNumToColString(col)); 171 retval.append((rowAbs)?"$":""); 172 retval.append(row+1); 173 174 return retval.toString(); 175 } 176 } 177