KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > poi > hssf > record > CellValueRecordInterface


1
2 /* ====================================================================
3    Copyright 2002-2004 Apache Software Foundation
4
5    Licensed under the Apache License, Version 2.0 (the "License");
6    you may not use this file except in compliance with the License.
7    You may obtain a copy of the License at
8
9        http://www.apache.org/licenses/LICENSE-2.0
10
11    Unless required by applicable law or agreed to in writing, software
12    distributed under the License is distributed on an "AS IS" BASIS,
13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14    See the License for the specific language governing permissions and
15    limitations under the License.
16 ==================================================================== */
17         
18
19 /*
20  * CellValueRecordInterface.java
21  *
22  * Created on October 2, 2001, 8:27 PM
23  */
24 package org.apache.poi.hssf.record;
25
26 /**
27  * The cell value record interface is implemented by all classes of type Record that
28  * contain cell values. It allows the containing sheet to move through them and compare
29  * them.
30  *
31  * @author Andrew C. Oliver (acoliver at apache dot org)
32  * @author Jason Height (jheight at chariot dot net dot au)
33  *
34  * @see org.apache.poi.hssf.model.Sheet
35  * @see org.apache.poi.hssf.record.Record
36  * @see org.apache.poi.hssf.record.RecordFactory
37  */
38
39 public interface CellValueRecordInterface
40 {
41
42     /**
43      * get the row this cell occurs on
44      *
45      * @return the row
46      */
47
48     //public short getRow();
49 public int getRow();
50
51     /**
52      * get the column this cell defines within the row
53      *
54      * @return the column
55      */
56
57     public short getColumn();
58
59     /**
60      * set the row this cell occurs on
61      * @param row the row this cell occurs within
62      */
63
64     //public void setRow(short row);
65 public void setRow(int row);
66
67     /**
68      * set the column this cell defines within the row
69      *
70      * @param col the column this cell defines
71      */
72
73     public void setColumn(short col);
74
75     public void setXFIndex(short xf);
76
77     public short getXFIndex();
78
79     /**
80      * returns whether this cell is before the passed in cell
81      *
82      * @param i another cell interface record to compare
83      * @return true if the cells is before, or false if not
84      */
85
86     public boolean isBefore(CellValueRecordInterface i);
87
88     /**
89      * returns whether this cell is after the passed in cell
90      *
91      * @param i record to compare
92      * @return true if the cell is after, false if not
93      */
94
95     public boolean isAfter(CellValueRecordInterface i);
96
97     /**
98      * returns whether this cell represents the same cell (NOT VALUE)
99      *
100      * @param i record to compare
101      * @return true if the cells are the same cell (positionally), false if not.
102      */
103
104     public boolean isEqual(CellValueRecordInterface i);
105
106     public Object JavaDoc clone();
107 }
108
Popular Tags