com.intechcore.scomponents.scell.api.spreadsheet.service

Interface IValueService

public interface IValueService

Represents a cell value service

Method Summary

Modifier and Type	Method and Description
void	clear(IRangeAddress range) Clears the value in the range
IValue	get(int colNum, int rowNum) Get value of a cell with given row and column numbers
IValue	get(IRangeAddress range) Get value of a cell (of given single cell address) or top left cell (of given cells range)
IValue	get(String range) Get value of a cell (of given single cell address like "D9") or top left cell (of given cells range like "A1:B4")
void	parseContent(int colNum, int rowNum, String content) Sets a value in the single cell.
void	parseContent(IRangeAddress range, String content) Sets a value in the range of cells.
void	parseContent(String range, String content) Sets a value in the range of cells.
void	set(int colNum, int rowNum, Function<IValueFactory,IValue> valueFunction) Sets a value in the single cell.
void	set(int colNum, int rowNum, IValue value) Set value to single cell with given column and row numbers
void	set(IRangeAddress range, Function<IValueFactory,IValue> valueFunction) Sets a value in the range of cells.
void	set(IRangeAddress range, IValue value) Sets the value in the range of cells
void	set(String range, Function<IValueFactory,IValue> valueFunction) Sets a value in the range of cells.
void	set(String range, IValue value) Set value to range of cells with the given String with values like "A4" or "D4:G10"
void	updateExisting(int colNum, int rowNum, UnaryOperator<IValue> editor) Edit value of single cell with given column and row numbers
void	updateExisting(IRangeAddress range, UnaryOperator<IValue> editor) Edits the value in the range of cells
void	updateExisting(String range, UnaryOperator<IValue> editor) Edit value of range of cells with the given String with values like "A4" or "D4:G10"

Method Detail

get

IValue get(int colNum,
           int rowNum)

Get value of a cell with given row and column numbers

Parameters:

colNum - the column number

rowNum - the row number

Returns:

IValue of needed cell

get

IValue get(String range)

Get value of a cell (of given single cell address like "D9") or top left cell (of given cells range like "A1:B4")

Parameters:

range - the given range

Returns:

IValue of needed cell

get

IValue get(IRangeAddress range)

Get value of a cell (of given single cell address) or top left cell (of given cells range)

Parameters:

range - the given range

Returns:

IValue of needed cell

set

void set(IRangeAddress range,
         IValue value)

Sets the value in the range of cells

Parameters:

range - the IRangeAddress in which the settings will be applied

value - the value to be set

See Also:

IRangeAddress, IValue

set

void set(String range,
         IValue value)

Set value to range of cells with the given String with values like "A4" or "D4:G10"

In case of incorrect string value throws an ParseRangeAddressException

Parameters:

range - the cells range

value - the value

See Also:

IValue

set

void set(int colNum,
         int rowNum,
         IValue value)

Set value to single cell with given column and row numbers

In case incorrect of any number throws an IndexOutOfBoundsException

Parameters:

colNum - the column number

rowNum - the row number

value - the value

See Also:

IValue

set

void set(IRangeAddress range,
         Function<IValueFactory,IValue> valueFunction)

Sets a value in the range of cells. For convenience, the user consumes a new instance of the IValueFactory and should return the built IValue. The builder is instantiated from the IScellApiResolver so that the user could register his own implementation using custom default data

Parameters:

range - the IRangeAddress in which the value will be applied

valueFunction - the Function with a new instance of IValueFactory

set

void set(String range,
         Function<IValueFactory,IValue> valueFunction)

Sets a value in the range of cells. For convenience, the user consumes a new instance of the IValueFactory and should return the built IValue. The builder is instantiated from the IScellApiResolver so that the user could register his own implementation using custom default data

In case of incorrect string value throws an ParseRangeAddressException

Parameters:

range - the range like "A2" or "B2:D4" in which the value will be applied

valueFunction - the Function with a new instance of IValueFactory

set

void set(int colNum,
         int rowNum,
         Function<IValueFactory,IValue> valueFunction)

Sets a value in the single cell. For convenience, the user consumes a new instance of the IValueFactory and should return the built IValue. The builder is instantiated from the IScellApiResolver so that the user could register his own implementation using custom default data

In case incorrect of any number throws an IndexOutOfBoundsException

Parameters:

colNum - the column number

rowNum - the row number

valueFunction - the Function with a new instance of IValueFactory

parseContent

void parseContent(IRangeAddress range,
                  String content)

Sets a value in the range of cells. The type of the value will be recognized.

Parameters:

range - the given range

content - the content to be recognized

parseContent

void parseContent(String range,
                  String content)

Sets a value in the range of cells. The type of the value will be recognized.

In case of incorrect string value throws an ParseRangeAddressException

Parameters:

range - the given range

content - the content to be recognized

parseContent

void parseContent(int colNum,
                  int rowNum,
                  String content)

Sets a value in the single cell. The type of the value will be recognized.

In case incorrect of any number throws an IndexOutOfBoundsException

Parameters:

colNum - the column number

rowNum - the row number

content - the content to be recognized

updateExisting

void updateExisting(IRangeAddress range,
                    UnaryOperator<IValue> editor)

Edits the value in the range of cells

Parameters:

range - the IRangeAddress in which the values will be eddited

editor - the function that takes current value of the cell and produces a new value of the cell

See Also:

IRangeAddress, IValue

updateExisting

void updateExisting(String range,
                    UnaryOperator<IValue> editor)

Edit value of range of cells with the given String with values like "A4" or "D4:G10"

In case of incorrect string value throws an ParseRangeAddressException

Parameters:

range - range of cells to edit its values

editor - function to take current cell value and produce the new cell value

See Also:

IValue

updateExisting

void updateExisting(int colNum,
                    int rowNum,
                    UnaryOperator<IValue> editor)

Edit value of single cell with given column and row numbers

In case incorrect of any number throws an IndexOutOfBoundsException

Parameters:

colNum - the column number

rowNum - the row number

editor - function to take current cell value and produce the new cell value

See Also:

IValue

clear

void clear(IRangeAddress range)

Clears the value in the range

Parameters:

range - the IRangeAddress in which the clearing will be applied

See Also:

IRangeAddress