org.palo.api
Interface Cell


public interface Cell

This interface describes a Cell within a palo cube. Each cell consists of a coordinate and a cell value of certain type. Currently palo supports the types NUMERIC and STRING. Constants are provide for both types.
Note: Cells are not cached by the API.

Version:
$Id: Cell.html,v 1.18 2009/07/09 11:01:46 ArndHouben Exp $

Field Summary
static int NUMERIC
          Constant for NUMERIC type.
static int STRING
          Constant for value type STRING
 
Method Summary
 Element[] getCoordinate()
          Returns the cell coordinate
 Cube getCube()
          Returns the cube of this cell
 Element[] getPath()
          Returns the cell path
 java.lang.String getRuleId()
          Returns the identifier of the Rule which is applied to this cell or null if this cell has no rule.
 int getType()
          Returns the value type which is either NUMERIC or STRING
 java.lang.Object getValue()
          Returns the cell value which is either of type NUMERIC or STRING
 boolean hasRule()
          Checks if the cell value is based on a rule
 boolean isConsolidated()
          Checks if the cell is consolidated, i.e. at least one Element must be of type CONSOLIDATED and all other must be of type NUMERIC.
 boolean isEmpty()
          Checks if this cell is empty, i.e. no value is set.
 

Field Detail

NUMERIC

static final int NUMERIC
Constant for NUMERIC type. Values of type NUMERIC should be handled as doubles.

See Also:
Constant Field Values

STRING

static final int STRING
Constant for value type STRING

See Also:
Constant Field Values
Method Detail

getCube

Cube getCube()
Returns the cube of this cell

Returns:

getPath

Element[] getPath()
Returns the cell path

Returns:
cell path // * @deprecated please use getCoordinate() instead.

getCoordinate

Element[] getCoordinate()
Returns the cell coordinate

Returns:
cell coordinate

getValue

java.lang.Object getValue()
Returns the cell value which is either of type NUMERIC or STRING

Returns:
cell value

getType

int getType()
Returns the value type which is either NUMERIC or STRING

Returns:
value type

hasRule

boolean hasRule()
Checks if the cell value is based on a rule

Returns:
true if cell has a rule applied, false otherwise.

getRuleId

java.lang.String getRuleId()
Returns the identifier of the Rule which is applied to this cell or null if this cell has no rule.

Returns:
the id of the cell rule or null.

isConsolidated

boolean isConsolidated()
Checks if the cell is consolidated, i.e. at least one Element must be of type CONSOLIDATED and all other must be of type NUMERIC.

Returns:
true if this cell is consolidated, false otherwise

isEmpty

boolean isEmpty()
Checks if this cell is empty, i.e. no value is set. In case of type STRING this means an empty string.

Returns:
true if this cell has no value, otherwise false