|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Cell
A Cell
is an item in the grid of a Result
. It is
returned by Result.getCell(int[])
.
Method Summary | |
---|---|
boolean |
canDrillThrough()
Returns true if drill through is possible for this Cell. |
String |
getCachedFormatString()
Return the cached formatted string, that survives an aggregate cache clear. |
Member |
getContextMember(Dimension dimension)
Returns the context member for a particular dimension. |
List<Integer> |
getCoordinateList()
Returns the coordinates of this Cell in its Result . |
int |
getDrillThroughCount()
Returns the number of fact table rows which contributed to this Cell. |
String |
getDrillThroughSQL(boolean extendedContext)
Returns a SQL query that, when executed, returns drill through data for this Cell. |
String |
getFormattedValue()
Returns the cell's value formatted according to the current format string, and locale-specific settings such as currency symbol. |
Object |
getPropertyValue(String propertyName)
Returns the value of a property. |
Object |
getValue()
Returns the cell's raw value. |
boolean |
isError()
Returns whether the cell's calculation returned an error. |
boolean |
isNull()
Returns whether the cell's value is null. |
void |
setValue(Scenario scenario,
Object newValue,
AllocationPolicy allocationPolicy,
Object... allocationArgs)
Helper method to implement Cell.setValue(java.lang.Object, org.olap4j.AllocationPolicy, java.lang.Object...) . |
Method Detail |
---|
List<Integer> getCoordinateList()
Result
.
Object getValue()
The value is never null. It may have various types:
Util.nullValue
;Throwable
;BigDecimal
,
Double
, Integer
and String
.
String getCachedFormatString()
String getFormattedValue()
Format
.
boolean isNull()
boolean isError()
String getDrillThroughSQL(boolean extendedContext)
If the parameter extendedContext
is true, then the query will
include all the levels (i.e. columns) of non-constraining members
(i.e. members which are at the "All" level).
If the parameter extendedContext
is false, the query will
exclude the levels (coulmns) of non-constraining members.
The result is null if the cell is based upon a calculated member.
boolean canDrillThrough()
int getDrillThroughCount()
Object getPropertyValue(String propertyName)
propertyName
- Case-sensitive property name
Member getContextMember(Dimension dimension)
void setValue(Scenario scenario, Object newValue, AllocationPolicy allocationPolicy, Object... allocationArgs)
Cell.setValue(java.lang.Object, org.olap4j.AllocationPolicy, java.lang.Object...)
.
scenario
- ScenarionewValue
- New valueallocationPolicy
- Allocation policyallocationArgs
- Arguments for allocation policy
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |