CellFinder (excel-builder 0.4.1 API)

com.jameskleeh.excel.CellFinder

A class to get references to cells for use in other functions
Authors:
James Kleeh
Since:
0.1.0

Constructor Summary

Constructors
Constructor and description
`CellFinder (org.apache.poi.xssf.usermodel.XSSFCell cell, java.util.Map<java.lang.Object, java.lang.Integer> columnIndexes)`

Methods Summary

Methods
Type	Name and description
`java.lang.String`	`exactCell(int columnIndex, int rowIndex)` Retrieves an exact cell reference
`java.lang.String`	`exactCell(java.lang.String columnName, int rowIndex)` Retrieves an exact cell reference based on a previously defined column definition (created by CreatesCells.column and row index
`java.lang.String`	`exactCell(java.lang.String columnName)` Retrieves an exact cell reference based on a previously defined column definition (created by CreatesCells.column
`java.lang.String`	`getColumn()` @return The current column (A..Z)
`int`	`getRow()` @return The current row number (1 based)
`java.lang.String`	`getSheetName()` @return The current sheet name
`java.lang.String`	`relativeCell(int columnIndex, int rowIndex)` Retrieves a cell relative to the current cell.
`java.lang.String`	`relativeCell(int columnIndex)` Retrieves a cell relative to the current cell.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - CellFinder(org.apache.poi.xssf.usermodel.XSSFCell cell, java.util.Map<java.lang.Object, java.lang.Integer> columnIndexes)
- Method Detail
  - java.lang.String exactCell(int columnIndex, int rowIndex)
    
    Retrieves an exact cell reference
    Parameters:
    columnIndex - The column index
    rowIndex - The row index
    Returns:
    The desired cell
  - java.lang.String exactCell(java.lang.String columnName, int rowIndex)
    
    Retrieves an exact cell reference based on a previously defined column definition (created by CreatesCells.column and row index
    Parameters:
    columnName - The column identifier
    rowIndex - The row index
    Returns:
    The desired cell
  - java.lang.String exactCell(java.lang.String columnName)
    
    Retrieves an exact cell reference based on a previously defined column definition (created by CreatesCells.column
    Parameters:
    columnName - The column identifier
    Returns:
    The actual header column
  - java.lang.String getColumn()
    
    Returns:
    The current column (A..Z)
  - int getRow()
    
    Returns:
    The current row number (1 based)
  - java.lang.String getSheetName()
    
    Returns:
    The current sheet name
  - java.lang.String relativeCell(int columnIndex, int rowIndex)
    
    Retrieves a cell relative to the current cell. Use negative values to reference rows and columns before the current cell and positive values to reference rows and columns after the current cell.
    Parameters:
    columnIndex - The column index
    rowIndex - The row index
    Returns:
    A cell relative to the current cell
  - java.lang.String relativeCell(int columnIndex)
    
    Retrieves a cell relative to the current cell. Use negative values to reference previous columns and positive values to reference columns after the current cell.
    Parameters:
    columnIndex - The column index
    Returns:
    A cell relative to the current cell

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class CellFinder

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

CellFinder(org.apache.poi.xssf.usermodel.XSSFCell cell, java.util.Map<java.lang.Object, java.lang.Integer> columnIndexes)

Method Detail

java.lang.String exactCell(int columnIndex, int rowIndex)

java.lang.String exactCell(java.lang.String columnName, int rowIndex)

java.lang.String exactCell(java.lang.String columnName)

java.lang.String getColumn()

int getRow()

java.lang.String getSheetName()

java.lang.String relativeCell(int columnIndex, int rowIndex)

java.lang.String relativeCell(int columnIndex)