|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CubeView
A CubeView
reflects a certain state of its corresponding palo
cube. Therefore each cube view consists of one or more so called Axis
which allows the sorting of the cube dimensions. E.g. the palo client defines
axes for a cube table, like column and row, and a third axis for remaining
dimensions.
Field Summary | |
---|---|
static java.lang.String |
PROPERTY_ID_HIDE_EMPTY
Property to indicate if empty cells are to be hidden or not. |
static java.lang.String |
PROPERTY_ID_REVERSE_HORIZONTAL_LAYOUT
Property to indicate if the horizontal order of elements is to be reversed or not (i.e. if set to true, consolidated elements are displayed to the _right_ of their children; consolidated elements are displayed on the _left_ hand side of their children if this property is not set or set to false). |
static java.lang.String |
PROPERTY_ID_REVERSE_VERTICAL_LAYOUT
Property to indicate if the vertical order of elements is to be reversed or not (i.e. if set to true, consolidated elements are displayed _below_ their children; consolidated elements are displayed _above_ their children if this property is not set or set to false). |
static java.lang.String |
PROPERTY_ID_SHOW_RULES
Property to indicate if cells, which contain a rule should be highlighted in the ui. |
Method Summary | |
---|---|
Axis |
addAxis(java.lang.String id,
java.lang.String name)
Adds a new Axis to this cube view. |
void |
addProperty(Property property)
Adds the given Property object to this
CubeView . |
void |
addProperty(java.lang.String id,
java.lang.String value)
Adds a property with the given id and given value to this CubeView . |
Axis[] |
getAxes()
Returns all axes registered to this cube view |
Axis |
getAxis(java.lang.String id)
Returns the axis which is registered to this cube view under the given axis id or null if no such axis exists. |
Cube |
getCube()
Returns the corresponding source Cube of this view |
java.lang.String |
getDescription()
Returns an optional description or null if none has been set |
java.lang.String |
getId()
Returns the unique id of this cube view |
java.lang.String[] |
getProperties()
Returns all property ids. |
java.lang.String |
getPropertyValue(java.lang.String id)
Returns the value of the property specified by the given id or null if the id has not been specified. |
java.lang.String |
getRawDefinition()
Returns the internal used raw definition of this cube view. |
boolean |
isHideEmpty()
Deprecated. Not used anymore. Please use the property mechanism to specify properties like this. For isHideEmpty , you should use
getProperty(PROPERTY_ID_HIDE_EMPTY); and check if the return
value is a String representing the boolean value true. |
void |
removeAxis(Axis axis)
Removes the given axis from this cube view |
void |
removeProperty(Property property)
Removes the property specified by the given Property object
from this CubeView . |
void |
removeProperty(java.lang.String id)
Removes the property specified by the given id from this CubeView . |
void |
save()
Saves this cube view to its Database |
void |
setDescription(java.lang.String description)
Sets an optional description |
void |
setHideEmpty(boolean hideEmpty)
Deprecated. Not used anymore. Please use the property mechanism to specify properties like this. For setHideEmpty , you should
use setProperty(PROPERTY_ID_HIDE_EMPTY, "true"); (or
.., "false" , respectively). |
void |
setName(java.lang.String name)
Sets the name of this cube view. |
Methods inherited from interface org.palo.api.NamedEntity |
---|
getName |
Field Detail |
---|
static final java.lang.String PROPERTY_ID_HIDE_EMPTY
static final java.lang.String PROPERTY_ID_REVERSE_HORIZONTAL_LAYOUT
static final java.lang.String PROPERTY_ID_REVERSE_VERTICAL_LAYOUT
static final java.lang.String PROPERTY_ID_SHOW_RULES
Method Detail |
---|
java.lang.String getId()
Cube getCube()
Cube
of this view
Cube
of this viewvoid setName(java.lang.String name)
name
- (new) name of the cube viewjava.lang.String getDescription()
null
if none has been set
void setDescription(java.lang.String description)
description
- boolean isHideEmpty()
isHideEmpty
, you should use
getProperty(PROPERTY_ID_HIDE_EMPTY);
and check if the return
value is a String representing the boolean value true.
void setHideEmpty(boolean hideEmpty)
setHideEmpty
, you should
use setProperty(PROPERTY_ID_HIDE_EMPTY, "true");
(or
.., "false"
, respectively).
hideEmpty
- java.lang.String getRawDefinition()
Axis addAxis(java.lang.String id, java.lang.String name)
Axis
to this cube view.
id
- the unique id of the new axisname
- the name of the new axis
void removeAxis(Axis axis)
axis
- the axis to removeAxis[] getAxes()
Axis getAxis(java.lang.String id)
null
if no such axis exists.
id
-
null
void save()
Database
void addProperty(java.lang.String id, java.lang.String value)
CubeView
. If a property with the same id already exists, the
old value is overwritten with the new value.
id
- a unique identifiervalue
- the property valuevoid addProperty(Property property)
Property
object to this
CubeView
. If a property with the same id already exists, the
old value is overwritten with the new value.
property
- a Property object.void removeProperty(java.lang.String id)
CubeView
.
id
- the property identifiervoid removeProperty(Property property)
Property
object
from this CubeView
.
property
- a Property object.java.lang.String[] getProperties()
java.lang.String getPropertyValue(java.lang.String id)
id
- the property identifier
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |