Module io.github.tonywasher.joceanus.prometheus.sheet.api

Package io.github.tonywasher.joceanus.prometheus.service.sheet

Class PrometheusSheetCell

java.lang.Object

io.github.tonywasher.joceanus.prometheus.service.sheet.PrometheusSheetCell

public abstract class PrometheusSheetCell
extends Object

Class representing a cell within a sheet or a view.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrometheusSheetCell(PrometheusSheetRow pRow, int pColIndex, boolean pReadOnly)	Constructor.

Method Summary

Modifier and Type	Method	Description
abstract Boolean	getBoolean()	Obtain boolean value of the cell.
byte[]	getBytes()	Obtain byte array value of the cell.
int	getCellIndex()	Obtain the cell index.
protected static PrometheusSheetCellStyleType	getCellStyle(Object pValue)	Obtain the required CellStyle.
char[]	getCharArray()	Obtain char array value of the cell.
abstract OceanusDate	getDate()	Obtain date value of the cell.
abstract Integer	getInteger()	Obtain integer value of the cell.
abstract Long	getLong()	Obtain long value of the cell.
Long	getLongFromString()	Obtain long value of the cell.
abstract OceanusMoney	getMoney()	Obtain money value of the cell.
PrometheusSheetCellPosition	getPosition()	Obtain the cell position.
abstract OceanusPrice	getPrice()	Obtain price value of the cell.
abstract OceanusRate	getRate()	Obtain rate value of the cell.
abstract OceanusRatio	getRatio()	Obtain ratio value of the cell.
PrometheusSheetRow	getRow()	Obtain the underlying row.
PrometheusSheetSheet	getSheet()	Obtain the underlying sheet.
abstract String	getString()	Obtain string value of the cell.
abstract OceanusUnits	getUnits()	Obtain units value of the cell.
PrometheusSheetView	getView()	Obtain the underlying view.
boolean	isReadOnly()	Is the cell readOnly?
void	setBoolean(Boolean pValue)	Set boolean value of the cell.
protected abstract void	setBooleanValue(Boolean pValue)	Set non-null boolean value of the cell.
void	setBytes(byte[] pValue)	Set byte array value of the cell.
void	setCharArray(char[] pValue)	Set char array value of the cell.
void	setDate(OceanusDate pValue)	Set date value of the cell.
protected abstract void	setDateValue(OceanusDate pValue)	Set non-null date value of the cell.
void	setDecimal(OceanusDecimal pValue)	Set decimal value of the cell.
protected abstract void	setDecimalValue(OceanusDecimal pValue)	Set non-null decimal value of the cell.
void	setHeader(String pValue)	Set header value of the cell.
protected abstract void	setHeaderValue(String pValue)	Set non-null header value of the cell.
void	setInteger(Integer pValue)	Set integer value of the cell.
protected abstract void	setIntegerValue(Integer pValue)	Set non-null integer value of the cell.
void	setLong(Long pValue)	Set long value of the cell.
void	setLongAsString(Long pValue)	Set long value of the cell.
protected abstract void	setLongValue(Long pValue)	Set non-null long value of the cell.
void	setMonetary(OceanusMoney pValue)	Set monetary value of the cell.
protected abstract void	setMonetaryValue(OceanusMoney pValue)	Set non-null monetary value of the cell.
void	setNull()	Set null value for the cell.
protected abstract void	setNullValue()	Set null value for the cell.
void	setString(String pValue)	Set string value of the cell.
protected abstract void	setStringValue(String pValue)	Set non-null string value of the cell.

Methods inherited from class java.lang.Object

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

Constructor Details

PrometheusSheetCell

protected PrometheusSheetCell(PrometheusSheetRow pRow,
 int pColIndex,
 boolean pReadOnly)

Constructor.

Parameters:

pRow - the row for the cell

pColIndex - the column index

pReadOnly - is the cell readOnly?

Method Details

getSheet

public PrometheusSheetSheet getSheet()

Obtain the underlying sheet.

Returns:

the underlying sheet

getRow

public PrometheusSheetRow getRow()

Obtain the underlying row.

Returns:

the underlying row

getView

public PrometheusSheetView getView()

Obtain the underlying view.

Returns:

the underlying view

getPosition

public PrometheusSheetCellPosition getPosition()

Obtain the cell position.

Returns:

position

isReadOnly

public boolean isReadOnly()

Is the cell readOnly?

Returns:

true/false

getCellIndex

public int getCellIndex()

Obtain the cell index.

Returns:

the index

getBoolean

public abstract Boolean getBoolean()

Obtain boolean value of the cell.

Returns:

the boolean value

getDate

public abstract OceanusDate getDate()
                             throws OceanusException

Obtain date value of the cell.

Returns:

the date value

Throws:

OceanusException - on error

getInteger

public abstract Integer getInteger()
                            throws OceanusException

Obtain integer value of the cell.

Returns:

the integer value

Throws:

OceanusException - on error

getLong

public abstract Long getLong()
                      throws OceanusException

Obtain long value of the cell.

Returns:

the long value

Throws:

OceanusException - on error

getLongFromString

public Long getLongFromString()
                       throws OceanusException

Obtain long value of the cell.

Returns:

the long value

Throws:

OceanusException - on error

getMoney

public abstract OceanusMoney getMoney()
                               throws OceanusException

Obtain money value of the cell.

Returns:

the money value

Throws:

OceanusException - on error

getPrice

public abstract OceanusPrice getPrice()
                               throws OceanusException

Obtain price value of the cell.

Returns:

the price value

Throws:

OceanusException - on error

getRate

public abstract OceanusRate getRate()
                             throws OceanusException

Obtain rate value of the cell.

Returns:

the rate value

Throws:

OceanusException - on error

getUnits

public abstract OceanusUnits getUnits()
                               throws OceanusException

Obtain units value of the cell.

Returns:

the units value

Throws:

OceanusException - on error

getRatio

public abstract OceanusRatio getRatio()
                               throws OceanusException

Obtain ratio value of the cell.

Returns:

the ratio value

Throws:

OceanusException - on error

getString

public abstract String getString()

Obtain string value of the cell.

Returns:

the string value

getBytes

public byte[] getBytes()

Obtain byte array value of the cell.

Returns:

the byte array value

getCharArray

public char[] getCharArray()
                    throws OceanusException

Obtain char array value of the cell.

Returns:

the char array value

Throws:

OceanusException - on error

setNull

public void setNull()
             throws OceanusException

Set null value for the cell.

Throws:

OceanusException - on error

setNullValue

protected abstract void setNullValue()
                              throws OceanusException

Set null value for the cell.

Throws:

OceanusException - on error

setBoolean

public void setBoolean(Boolean pValue)
                throws OceanusException

Set boolean value of the cell.

Parameters:

pValue - the integer value

Throws:

OceanusException - on error

setBooleanValue

protected abstract void setBooleanValue(Boolean pValue)
                                 throws OceanusException

Set non-null boolean value of the cell.

Parameters:

pValue - the integer value

Throws:

OceanusException - on error

setDate

public void setDate(OceanusDate pValue)
             throws OceanusException

Set date value of the cell.

Parameters:

pValue - the date value

Throws:

OceanusException - on error

setDateValue

protected abstract void setDateValue(OceanusDate pValue)
                              throws OceanusException

Set non-null date value of the cell.

Parameters:

pValue - the integer value

Throws:

OceanusException - on error

setInteger

public void setInteger(Integer pValue)
                throws OceanusException

Set integer value of the cell.

Parameters:

pValue - the integer value

Throws:

OceanusException - on error

setIntegerValue

protected abstract void setIntegerValue(Integer pValue)
                                 throws OceanusException

Set non-null integer value of the cell.

Parameters:

pValue - the integer value

Throws:

OceanusException - on error

setLong

public void setLong(Long pValue)
             throws OceanusException

Set long value of the cell.

Parameters:

pValue - the integer value

Throws:

OceanusException - on error

setLongAsString

public void setLongAsString(Long pValue)
                     throws OceanusException

Set long value of the cell.

Parameters:

pValue - the integer value

Throws:

OceanusException - on error

setLongValue

protected abstract void setLongValue(Long pValue)
                              throws OceanusException

Set non-null long value of the cell.

Parameters:

pValue - the long value

Throws:

OceanusException - on error

setString

public void setString(String pValue)
               throws OceanusException

Set string value of the cell.

Parameters:

pValue - the string value

Throws:

OceanusException - on error

setStringValue

protected abstract void setStringValue(String pValue)
                                throws OceanusException

Set non-null string value of the cell.

Parameters:

pValue - the string value

Throws:

OceanusException - on error

setDecimal

public void setDecimal(OceanusDecimal pValue)
                throws OceanusException

Set decimal value of the cell.

Parameters:

pValue - the decimal value

Throws:

OceanusException - on error

setDecimalValue

protected abstract void setDecimalValue(OceanusDecimal pValue)
                                 throws OceanusException

Set non-null decimal value of the cell.

Parameters:

pValue - the decimal value

Throws:

OceanusException - on error

setMonetary

public void setMonetary(OceanusMoney pValue)
                 throws OceanusException

Set monetary value of the cell.

Parameters:

pValue - the monetary value

Throws:

OceanusException - on error

setMonetaryValue

protected abstract void setMonetaryValue(OceanusMoney pValue)
                                  throws OceanusException

Set non-null monetary value of the cell.

Parameters:

pValue - the monetary value

Throws:

OceanusException - on error

setHeader

public void setHeader(String pValue)
               throws OceanusException

Set header value of the cell.

Parameters:

pValue - the string value

Throws:

OceanusException - on error

setHeaderValue

protected abstract void setHeaderValue(String pValue)
                                throws OceanusException

Set non-null header value of the cell.

Parameters:

pValue - the header value

Throws:

OceanusException - on error

setBytes

public void setBytes(byte[] pValue)
              throws OceanusException

Set byte array value of the cell.

Parameters:

pValue - the byte array value

Throws:

OceanusException - on error

setCharArray

public void setCharArray(char[] pValue)
                  throws OceanusException

Set char array value of the cell.

Parameters:

pValue - the byte array value

Throws:

OceanusException - on error

getCellStyle

protected static PrometheusSheetCellStyleType getCellStyle(Object pValue)

Obtain the required CellStyle.

Parameters:

pValue - the value

Returns:

the required CellStyle