Apache POI - Common 5.3.0 · org.apache.poi.ss.util.AreaReference

Field Summary

Modifier and Type	Field and Description
private final CellReference	_firstCell
private final boolean	_isSingleCell
private final CellReference	_lastCell
private final SpreadsheetVersion	_version
private static final char	CELL_DELIMITER The character (:) that separates the two cell references in a multi-cell area reference
private static final SpreadsheetVersion	DEFAULT_SPREADSHEET_VERSION
private static final char	SHEET_NAME_DELIMITER The character (!) that separates sheet names from cell references
private static final char	SPECIAL_NAME_DELIMITER The character (') used to quote sheet names when they contain special characters

Constructor Summary

Access	Constructor and Description
public	AreaReference(String reference, SpreadsheetVersion version) Create an area ref from a string representation.
public	AreaReference(CellReference topLeft, CellReference botRight, SpreadsheetVersion version) Creates an area ref from a pair of Cell References.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the text representation of this area reference as it would appear in a formula. formatAsString() Returns a text representation of this area reference.
public static AreaReference[]	Returns: an array of contiguous area references. generateContiguous(SpreadsheetVersion version, String reference) Takes a non-contiguous area reference, and returns an array of contiguous area references
public CellReference[]	getAllReferencedCells() Returns a reference to every cell covered by this area
public CellReference	Returns: the first cell reference which defines this area. Usually this cell is in the upper left corner of the area (but this is not a requirement). getFirstCell()
public CellReference	Returns: the second cell reference which defines this area. For multi-cell areas, this is cell diagonally opposite the 'first cell'. Usually this cell is in the lower right corner of the area (but this is not a requirement). getLastCell() Note - if this area reference refers to a single cell, the return value of this method will be identical to that of `getFirstCell()`
public static AreaReference	Returns: An AreaReference that spans the given columns getWholeColumn(SpreadsheetVersion Is the spreadsheet in format Excel97 or newer Excel versions version, String The ABC-based start-index of the columns start, String The ABC-based end-index of the columns end) Construct an AreaReference which spans one more columns.
public static AreaReference	Returns: An AreaReference that spans the given rows getWholeRow(SpreadsheetVersion Is the spreadsheet in format Excel97 or newer Excel versions version, String The 1-based start-index of the rows start, String The 1-based end-index of the rows end) Construct an AreaReference which spans one more rows
public static boolean	isContiguous(String reference) Is the reference for a contiguous (i.e. unbroken) area, or is it made up of several different parts?
private static boolean	isPlainColumn(String refPart)
public boolean	Returns: `false` if this area reference involves more than one cell isSingleCell()
public static boolean	isWholeColumnReference(SpreadsheetVersion version, CellReference topLeft, CellReference botRight) Is the reference for a whole-column reference, such as C:C or D:G ?
public boolean	isWholeColumnReference()
private static String[]	Returns: array with one or two elements. never `null` separateAreaRefs(String reference) Separates Area refs in two parts and returns them as separate elements in a String array, each qualified with the sheet name (if present)
private static String[]	Returns: Area references in an array, size >= 1 splitAreaReferences(String Area references, i.e. A1:B2, 'Sheet1'!A1:B2 reference) Splits a comma-separated area references string into an array of individual references
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

_firstCell	back to summary
private final CellReference _firstCell

_isSingleCell	back to summary
private final boolean _isSingleCell

_lastCell	back to summary
private final CellReference _lastCell

_version	back to summary
private final SpreadsheetVersion _version

CELL_DELIMITER	back to summary
private static final char CELL_DELIMITER The character (:) that separates the two cell references in a multi-cell area reference

DEFAULT_SPREADSHEET_VERSION	back to summary
private static final SpreadsheetVersion DEFAULT_SPREADSHEET_VERSION

SHEET_NAME_DELIMITER	back to summary
private static final char SHEET_NAME_DELIMITER The character (!) that separates sheet names from cell references

SPECIAL_NAME_DELIMITER	back to summary
private static final char SPECIAL_NAME_DELIMITER The character (') used to quote sheet names when they contain special characters

Constructor Detail

AreaReference	back to summary
public AreaReference(String reference, SpreadsheetVersion version) Create an area ref from a string representation. Sheet names containing special characters should be delimited and escaped as per normal syntax rules for formulas. The area reference must be contiguous (i.e. represent a single rectangle, not a union of rectangles)

AreaReference	back to summary
public AreaReference(CellReference topLeft, CellReference botRight, SpreadsheetVersion version) Creates an area ref from a pair of Cell References.

Method Detail

formatAsString

back to summary

public String formatAsString()

Returns a text representation of this area reference.

Example return values:

Example return values
Result	Comment
A1:A1	Single cell area reference without sheet
A1:$C$1	Multi-cell area reference without sheet
Sheet1!A$1:B4	Standard sheet name
'O''Brien''s Sales'!B5:C6'	Sheet name with special characters

Returns:String: the text representation of this area reference as it would appear in a formula.

generateContiguous	back to summary
public static AreaReference[] generateContiguous(SpreadsheetVersion version, String reference) Takes a non-contiguous area reference, and returns an array of contiguous area references Returns:AreaReference[] an array of contiguous area references.

generateContiguous

back to summary

public static AreaReference[] generateContiguous(SpreadsheetVersion version, String reference)

Takes a non-contiguous area reference, and returns an array of contiguous area references

Returns:AreaReference[]: an array of contiguous area references.

getAllReferencedCells	back to summary
public CellReference[] getAllReferencedCells() Returns a reference to every cell covered by this area

getFirstCell	back to summary
public CellReference getFirstCell() Returns:CellReference the first cell reference which defines this area. Usually this cell is in the upper left corner of the area (but this is not a requirement).

getLastCell back to summary

getLastCell	back to summary
public CellReference getLastCell() Note - if this area reference refers to a single cell, the return value of this method will be identical to that of `getFirstCell()` Returns:CellReference the second cell reference which defines this area. For multi-cell areas, this is cell diagonally opposite the 'first cell'. Usually this cell is in the lower right corner of the area (but this is not a requirement).

public CellReference getLastCell()

Note - if this area reference refers to a single cell, the return value of this method will be identical to that of getFirstCell()

Returns:CellReference: the second cell reference which defines this area. For multi-cell areas, this is cell diagonally opposite the 'first cell'. Usually this cell is in the lower right corner of the area (but this is not a requirement).

getWholeColumn	back to summary
public static AreaReference getWholeColumn(SpreadsheetVersion version, String start, String end) Construct an AreaReference which spans one more columns. Columns are specified in the Excel format, i.e. "A" is the first column "B" the seconds, ... "AA", .. Parameters version:SpreadsheetVersion Is the spreadsheet in format Excel97 or newer Excel versions start:String The ABC-based start-index of the columns end:String The ABC-based end-index of the columns Returns:AreaReference An AreaReference that spans the given columns

getWholeColumn

back to summary

public static AreaReference getWholeColumn(SpreadsheetVersion version, String start, String end)

Construct an AreaReference which spans one more columns. Columns are specified in the Excel format, i.e. "A" is the first column "B" the seconds, ... "AA", ..

Parameters

version:SpreadsheetVersion: Is the spreadsheet in format Excel97 or newer Excel versions
start:String: The ABC-based start-index of the columns
end:String: The ABC-based end-index of the columns

Returns:AreaReference

An AreaReference that spans the given columns

getWholeRow	back to summary
public static AreaReference getWholeRow(SpreadsheetVersion version, String start, String end) Construct an AreaReference which spans one more rows Parameters version:SpreadsheetVersion Is the spreadsheet in format Excel97 or newer Excel versions start:String The 1-based start-index of the rows end:String The 1-based end-index of the rows Returns:AreaReference An AreaReference that spans the given rows

getWholeRow

back to summary

public static AreaReference getWholeRow(SpreadsheetVersion version, String start, String end)

Construct an AreaReference which spans one more rows

Parameters

version:SpreadsheetVersion: Is the spreadsheet in format Excel97 or newer Excel versions
start:String: The 1-based start-index of the rows
end:String: The 1-based end-index of the rows

Returns:AreaReference

An AreaReference that spans the given rows

isContiguous	back to summary
public static boolean isContiguous(String reference) Is the reference for a contiguous (i.e. unbroken) area, or is it made up of several different parts? (If it is, you will need to call `generateContiguous(SpreadsheetVersion, String)`)

isPlainColumn	back to summary
private static boolean isPlainColumn(String refPart)

isSingleCell	back to summary
public boolean isSingleCell() Returns:boolean `false` if this area reference involves more than one cell

isWholeColumnReference	back to summary
public static boolean isWholeColumnReference(SpreadsheetVersion version, CellReference topLeft, CellReference botRight) Is the reference for a whole-column reference, such as C:C or D:G ?

isWholeColumnReference	back to summary
public boolean isWholeColumnReference()

separateAreaRefs back to summary

separateAreaRefs	back to summary
private static String[] separateAreaRefs(String reference) Separates Area refs in two parts and returns them as separate elements in a String array, each qualified with the sheet name (if present) Returns:String[] array with one or two elements. never `null`

private static String[] separateAreaRefs(String reference)

Separates Area refs in two parts and returns them as separate elements in a String array, each qualified with the sheet name (if present)

Returns:String[]: array with one or two elements. never null

splitAreaReferences	back to summary
private static String[] splitAreaReferences(String reference) Splits a comma-separated area references string into an array of individual references Parameters reference:String Area references, i.e. A1:B2, 'Sheet1'!A1:B2 Returns:String[] Area references in an array, size >= 1

splitAreaReferences

back to summary

private static String[] splitAreaReferences(String reference)

Splits a comma-separated area references string into an array of individual references

Parameters

reference:String: Area references, i.e. A1:B2, 'Sheet1'!A1:B2

Returns:String[]

Area references in an array, size >= 1

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

public Class AreaReference

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail