com.github.jferard.fastods.ref

Class PositionUtil

java.lang.Object

com.github.jferard.fastods.ref.PositionUtil

public class PositionUtil
extends Object

Author:

Julien Férard, Martin Schulz

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALPHABET_SIZE a..z: 26 letters
static int	ORD_A the base for computing

Constructor Summary

Constructors

Constructor and Description
PositionUtil(TableNameUtil tableNameUtil) Create a new position util

Method Summary

Modifier and Type	Method and Description
void	checkTableName(CharSequence name) Check if the table name is ok.
static PositionUtil	create()
CellRef	newCellRef(int row, int col)
CellRef	newCellRef(String address) Convert a cell position string like B3 to the column number.
CellRef	newCellRef(Table table, int row, int col)
String	toCellAddress(int row, int col) Return the Excel/OO/LO address of a cell
String	toCellAddress(Table table, int row, int col) the Excel/OO/LO address of a cell, preceded by the table name
String	toRangeAddress(int row1, int col1, int row2, int col2) Return the Excel/OO/LO address of a range
String	toRangeAddress(Table table, int row1, int col1, int row2, int col2) Return the Excel/OO/LO address of a range, preceded by the table name

Methods inherited from class java.lang.Object

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

Field Detail

ALPHABET_SIZE

public static final int ALPHABET_SIZE

a..z: 26 letters

See Also:

Constant Field Values

ORD_A

public static final int ORD_A

the base for computing

See Also:

Constant Field Values

Constructor Detail

PositionUtil

public PositionUtil(TableNameUtil tableNameUtil)

Create a new position util

Parameters:

tableNameUtil - an util to check table names

Method Detail

create

public static PositionUtil create()

Returns:

a new position util

newCellRef

public CellRef newCellRef(String address)
                   throws ParseException,
                          IOException

Convert a cell position string like B3 to the column number.

Parameters:

address - The cell position in the range 'A1' to 'IV65536'

Returns:

The row, e.g. A1 will return 0, B1 will return 1, E1 will return 4

Throws:

ParseException - If the address can't be parsed.

IOException - never

newCellRef

public CellRef newCellRef(int row,
                          int col)

Parameters:

row - the row

col - the col

Returns:

the position

newCellRef

public CellRef newCellRef(Table table,
                          int row,
                          int col)

Parameters:

table - the table

row - the row

col - the col

Returns:

the position

toCellAddress

public String toCellAddress(int row,
                            int col)

Return the Excel/OO/LO address of a cell

Parameters:

row - the row

col - the col

Returns:

the Excel/OO/LO address

toCellAddress

public String toCellAddress(Table table,
                            int row,
                            int col)

the Excel/OO/LO address of a cell, preceded by the table name

Parameters:

row - the row

col - the col

table - the table

Returns:

the Excel/OO/LO address

toRangeAddress

public String toRangeAddress(int row1,
                             int col1,
                             int row2,
                             int col2)

Return the Excel/OO/LO address of a range

Parameters:

row1 - the first row

col1 - the first col

row2 - the last row

col2 - the last col

Returns:

the Excel/OO/LO address

toRangeAddress

public String toRangeAddress(Table table,
                             int row1,
                             int col1,
                             int row2,
                             int col2)

Return the Excel/OO/LO address of a range, preceded by the table name

Parameters:

row1 - the first row

col1 - the first col

row2 - the last row

col2 - the last col

table - the table

Returns:

the Excel/OO/LO address

checkTableName

public void checkTableName(CharSequence name)

Check if the table name is ok. Currently, this does stick to LO limitations (excepted for the check of duplicate names), but may the conditions may be relaxed in a future version. A valid table name should not start with a single quote (`'`) or contain of of the following characters: left square bracket (`[`), right square bracket (`]`), star (`*`), question mark (`?`), colon (`:`), slash (`/`) or backslash (`\`).

Parameters:

name - the name to check

Throws:

IllegalArgumentException - if the table name is not accepted.