net.sf.jett.formula
Class CellRefRange

java.lang.Object
  org.apache.poi.ss.util.CellReference
      net.sf.jett.formula.CellRef
          net.sf.jett.formula.CellRefRange

All Implemented Interfaces:

java.lang.Comparable<CellRef>

public class CellRefRange
extends CellRef

A CellRefRange is a CellRef, representing a range. The inherited attributes represent the upper-left corner of a block of cells. An additional internal CellRef represents the bottom- right corner of the block of cells.

Author:

Randy Gettman

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.ss.util.CellReference

org.apache.poi.ss.util.CellReference.NameType

Field Summary

Fields inherited from class net.sf.jett.formula.CellRef

DEF_DEFAULT_VALUE, DEFAULT_VALUE_IND

Constructor Summary

CellRefRange(org.apache.poi.ss.usermodel.Cell cell)

CellRefRange(int pRow, int pCol)

CellRefRange(int pRow, int pCol, boolean pAbsRow, boolean pAbsCol)

CellRefRange(int pRow, short pCol)

CellRefRange(java.lang.String cellRef)

CellRefRange(java.lang.String pSheetName, int pRow, int pCol, boolean pAbsRow, boolean pAbsCol)

Method Summary

boolean	equals(java.lang.Object o) Checks whether this cell reference range is equal to another object.
java.lang.String	formatAsString() If there is a range end CellRef, then append a colon ":" character followed by the range end formatted string.
CellRef	getRangeEndCellRef() Returns the end of the cell range.
void	setRangeEndCellRef(CellRef rangeEnd) Sets the end of the cell range with another CellRef.

Methods inherited from class net.sf.jett.formula.CellRef

compareTo, formatAsStringWithDef, getDefaultValue, setDefaultValue

Methods inherited from class org.apache.poi.ss.util.CellReference

cellReferenceIsWithinRange, classifyCellReference, convertColStringToIndex, convertNumToColString, getCellRefParts, getCol, getRow, getSheetName, isColAbsolute, isColumnWithnRange, isPartAbsolute, isRowAbsolute, isRowWithnRange, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CellRefRange

public CellRefRange(java.lang.String cellRef)

CellRefRange

public CellRefRange(int pRow,
                    int pCol)

CellRefRange

public CellRefRange(int pRow,
                    short pCol)

CellRefRange

public CellRefRange(org.apache.poi.ss.usermodel.Cell cell)

CellRefRange

public CellRefRange(int pRow,
                    int pCol,
                    boolean pAbsRow,
                    boolean pAbsCol)

CellRefRange

public CellRefRange(java.lang.String pSheetName,
                    int pRow,
                    int pCol,
                    boolean pAbsRow,
                    boolean pAbsCol)

Method Detail

setRangeEndCellRef

public void setRangeEndCellRef(CellRef rangeEnd)

Sets the end of the cell range with another CellRef. Copies the given CellRef so it can set its own internal copy's sheet name to null.

Parameters:

rangeEnd - The CellRef indicating the end of the range of cells.

getRangeEndCellRef

public CellRef getRangeEndCellRef()

Returns the end of the cell range. It has no sheet name.

Returns:

The end of the cell range CellRef.

equals

public boolean equals(java.lang.Object o)

Checks whether this cell reference range is equal to another object. They are equal if:

• The other object is also a CellRefRange, the superclass method equals returns true, and either both have no range end CellRefs, or both range end CellRefs compare equal.
• The other object is a CellRef but not a CellRefRange, the superclass method equals returns true, and this object does not have a range end CellRef.

Overrides:

equals in class CellRef

Parameters:

o - The other object.

Returns:

true if equal, false otherwise.

formatAsString

public java.lang.String formatAsString()

If there is a range end CellRef, then append a colon ":" character followed by the range end formatted string.

Overrides:

formatAsString in class org.apache.poi.ss.util.CellReference

Returns:

The string representation of the range of cells.