com.technia.tvc.core.gui.table

Interface CellValue

All Superinterfaces:

java.lang.Comparable<CellValue>

All Known Implementing Classes:

AbstractCell.AbstractCellValue, BooleanCell.BooleanCellValue, DateCell.DateCellValue, IntCell.IntCellValue, PersonCell.PersonCellValue, RealCell.RealCellValue, RelatedEditCell.RelatedCellValue, StringCell.StringCellValue

public interface CellValue
extends java.lang.Comparable<CellValue>

This interface represents the value of a Cell. Each CellValue should be able to compare itself to other according to its natural order.

Since:

3.6

See Also:

Cell

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getBooleanValue() Returns the value as a boolean.
Cell	getCell() Returns the cell the value belongs to.
java.util.Date	getDateValue() Returns the value as a date.
java.lang.String	getDisplayValue() Returns the display value.
int	getIndex()
java.lang.Number	getNumberValue() Returns the value as a number.
java.lang.String	getObjectId() Returns the object ID associated with the value (optional).
java.lang.String	getObjectType() Returns the object type associated with the value (optional).
java.lang.String	getRelationshipId() Returns the relationship ID associated with the value (optional).
java.lang.String	getSearchString() Returns the search string that can be used to query against.
java.lang.String	getValue() Returns the actual value retreived from Matrix.
boolean	update(TableClient.Entry entry, java.lang.String newValue, Environment env) Update the cell with the new value in the database (optional).

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getCell

Cell getCell()

Returns the cell the value belongs to.

getValue

java.lang.String getValue()

Returns the actual value retreived from Matrix.

getDisplayValue

java.lang.String getDisplayValue()

Returns the display value.

getSearchString

java.lang.String getSearchString()

Returns the search string that can be used to query against. Exactly who will perform the query, and how, is unspecified. This method exists, as a way to be able to distinguish between the display-value vs. searching.

getNumberValue

java.lang.Number getNumberValue()
                         throws java.text.ParseException

Returns the value as a number. If the value can't be returned as a number this method will throw a NumberFormatException.

Throws:

java.text.ParseException - If the value can't be returned as a number.

getDateValue

java.util.Date getDateValue()
                     throws java.text.ParseException

Returns the value as a date. If the value can't be returned as a date this method will throw a ParseException.

Throws:

java.text.ParseException - If the value can't be returned as a date.

getBooleanValue

java.lang.Boolean getBooleanValue()
                           throws java.text.ParseException

Returns the value as a boolean. If the value can't be returned as a boolean this method will throw a ParseException.

Throws:

java.text.ParseException - If the value can't be returned as a boolean.

getRelationshipId

java.lang.String getRelationshipId()

Returns the relationship ID associated with the value (optional).

getObjectId

java.lang.String getObjectId()

Returns the object ID associated with the value (optional).

getObjectType

java.lang.String getObjectType()

Returns the object type associated with the value (optional).

update

boolean update(TableClient.Entry entry,
               java.lang.String newValue,
               Environment env)
        throws TVCException

Update the cell with the new value in the database (optional).

Parameters:

entry - The entry that represents the row to which the cell values belongs.

newValue - The new value.

env - The environment.

Returns:

True if the cell value was updated in the database, otherwise false. If an error occurs this method will throw an exception instead or returning false.

Throws:

TVCException - If unable to update the cell due to as error.

getIndex

int getIndex()

Returns:

Returns the index of this value within the cell that it belongs to

Since:

5.1.3