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 * CellValueRecordInterface.java 58 * 59 * Created on October 2, 2001, 8:27 PM 60 */ 61 package org.apache.poi.hssf.record; 62 63 /** 64 * The cell value record interface is implemented by all classes of type Record that 65 * contain cell values. It allows the containing sheet to move through them and compare 66 * them. 67 * 68 * @author Andrew C. Oliver (acoliver at apache dot org) 69 * 70 * @see org.apache.poi.hssf.model.Sheet 71 * @see org.apache.poi.hssf.record.Record 72 * @see org.apache.poi.hssf.record.RecordFactory 73 */ 74 75 public interface CellValueRecordInterface 76 { 77 78 /** 79 * get the row this cell occurs on 80 * 81 * @return the row 82 */ 83 84 public short getRow(); 85 86 /** 87 * get the column this cell defines within the row 88 * 89 * @return the column 90 */ 91 92 public short getColumn(); 93 94 /** 95 * set the row this cell occurs on 96 * @param row the row this cell occurs within 97 */ 98 99 public void setRow(short row); 100 101 /** 102 * set the column this cell defines within the row 103 * 104 * @param col the column this cell defines 105 */ 106 107 public void setColumn(short col); 108 109 public void setXFIndex(short xf); 110 111 public short getXFIndex(); 112 113 /** 114 * returns whether this cell is before the passed in cell 115 * 116 * @param i another cell interface record to compare 117 * @return true if the cells is before, or false if not 118 */ 119 120 public boolean isBefore(CellValueRecordInterface i); 121 122 /** 123 * returns whether this cell is after the passed in cell 124 * 125 * @param i record to compare 126 * @return true if the cell is after, false if not 127 */ 128 129 public boolean isAfter(CellValueRecordInterface i); 130 131 /** 132 * returns whether this cell represents the same cell (NOT VALUE) 133 * 134 * @param i record to compare 135 * @return true if the cells are the same cell (positionally), false if not. 136 */ 137 138 public boolean isEqual(CellValueRecordInterface i); 139 } 140