|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Axis
An Axis
holds several cube Dimension
s and manages their
current state. A dimension state is described by its active Subset
and its currently expanded Element
s. Furthermore you can set a
selected element for a fix dimension, i.e. this dimension defines a fix part
of a cube cell coordinate.
Method Summary | |
---|---|
void |
add(Dimension dimension)
Deprecated. use add(Hierarchy) instead. |
void |
add(Hierarchy hierarchy)
Adds the given hierarchy to the axis. |
void |
addExpanded(Dimension dimension,
Element[] path,
int repetition)
Deprecated. please use addExpanded(ElementPath) instead |
void |
addExpanded(ElementPath path)
Adds the given to the expand list of
this axis. |
void |
addExpanded(ElementPath[] paths)
Convenience method to add several s
in one go |
void |
addExpanded(Hierarchy hierarchy,
Element[] path,
int repetition)
Deprecated. please use addExpanded(ElementPath) instead |
void |
addHidden(Dimension dimension,
Element[] path)
Deprecated. please use addVisible(ElementPath) |
void |
addHidden(Hierarchy hierarchy,
Element[] path)
Deprecated. please use addVisible(ElementPath) |
void |
addProperty(java.lang.String id,
java.lang.String value)
Deprecated. please do not use. this method is subject for modifications |
void |
addVisible(ElementPath path)
Adds the given path to the visible path list of this axis. |
Subset |
getActiveSubset(Dimension dimension)
Returns the active subset for the given dimension or null if
the dimension has no active subset, i.e. no subset is used |
Subset2 |
getActiveSubset2(Dimension dimension)
Returns the active subset2 for the given dimension or null if
the dimension has no active subset2, i.e. no subset is used |
java.lang.String |
getData(java.lang.String id)
Deprecated. please do not use. this method is subject for modifications |
Dimension[] |
getDimensions()
Deprecated. use getHierarchies() instead. |
Element[][] |
getExpanded(Dimension dimension)
Deprecated. please use getExpandedPaths() instead |
Element[][] |
getExpanded(Hierarchy hierarchy)
Deprecated. please use getExpandedPaths() instead |
ElementPath[] |
getExpandedPaths()
Returns all expanded s which are
registered with this axis. |
Element[][] |
getHidden(Dimension dimension)
Deprecated. please use getVisiblePaths(Dimension) |
Element[][] |
getHidden(Hierarchy hierarchy)
Deprecated. please use getVisiblePaths(Hierarchy) |
Hierarchy[] |
getHierarchies()
Returns all added hierarchies |
Hierarchy |
getHierarchy(Dimension dimension)
Returns the hierarchy that has been set for the specified dimension. |
java.lang.String |
getId()
Returns the unique id of the axis |
java.lang.String |
getName()
Returns the axis name or null if none has been set |
java.lang.String[] |
getProperties()
Deprecated. please do not use. this method is subject for modifications |
java.lang.String |
getPropertyValue(java.lang.String id)
Deprecated. please do not use. this method is subject for modifications |
int[] |
getRepetitionsForExpanded(Dimension dimension,
Element[] path)
Deprecated. please use getExpandedPaths() instead |
int[] |
getRepetitionsForExpanded(Hierarchy hierarchy,
Element[] path)
Deprecated. please use getExpandedPaths() instead |
Element |
getSelectedElement(Dimension dimension)
Deprecated. use getSelectedElement(Hierarchy) instead. |
Element |
getSelectedElement(Hierarchy hierarchy)
Returns the currently selected element of the given hierarchy or null if none has been set |
ElementPath[] |
getVisiblePaths(Dimension dimension)
Deprecated. please use getVisiblePaths(Hierarchy) instead. |
ElementPath[] |
getVisiblePaths(Hierarchy hierarchy)
Returns all visible paths for this axis. |
boolean |
isVisible(ElementPath path)
Checks if the element specified by the given path is visible or not |
void |
remove(Dimension dimension)
Deprecated. use remove(Hierarchy) instead. |
void |
remove(Hierarchy hierarchy)
Removes the given hierarchy from the axis |
void |
removeExpanded(Dimension dimension,
Element[] path,
int repetition)
Deprecated. please use removeExpanded(ElementPath) instead |
void |
removeExpanded(ElementPath path)
Removes the given from the expand list
of this axis |
void |
removeExpanded(Hierarchy hierarchy,
Element[] path,
int repetition)
Deprecated. please use removeExpanded(ElementPath) instead |
void |
removeHidden(Dimension dimension,
Element[] path)
Deprecated. please use removeVisible(ElementPath) |
void |
removeHidden(Hierarchy hierarchy,
Element[] path)
Deprecated. please use removeVisible(ElementPath) |
void |
removeProperty(java.lang.String id)
Deprecated. please do not use. this method is subject for modifications |
void |
removeVisible(ElementPath path)
Removes the given path from the visible path list of this axis. |
void |
setActiveSubset(Dimension dimension,
Subset subset)
Sets the active subset for the given dimension. |
void |
setActiveSubset2(Dimension dimension,
Subset2 subset)
Sets the active modern subset2 for the given dimension. |
void |
setName(java.lang.String name)
Sets an optional name for the axis |
void |
setSelectedElement(Dimension dimension,
Element element)
Deprecated. use setSelectedElement(Hierarchy, Element) instead. |
void |
setSelectedElement(Hierarchy hierarchy,
Element element)
Sets the currently selected element of the given hierarchy. |
Method Detail |
---|
java.lang.String getId()
void setName(java.lang.String name)
name
- the axis namejava.lang.String getName()
null
if none has been set
null
Hierarchy getHierarchy(Dimension dimension)
dimension
- the dimension whose hierarchy is requested.
null
if the dimension is not present on this axis.void add(Dimension dimension)
add(Hierarchy)
instead.
dimension
- the dimension to addvoid add(Hierarchy hierarchy)
hierarchy
- the hierarchy to add.void remove(Dimension dimension)
remove(Hierarchy)
instead.
dimension
- the dimension to removevoid remove(Hierarchy hierarchy)
hierarchy
- the hierarchy to removeDimension[] getDimensions()
getHierarchies()
instead.
Dimension
sHierarchy[] getHierarchies()
Hierarchy
objectsSubset getActiveSubset(Dimension dimension)
null
if
the dimension has no active subset, i.e. no subset is used
dimension
-
Subset
to use for the given dimension or nullvoid setActiveSubset(Dimension dimension, Subset subset)
Note: null
is allowed and will deactivate the
current active subset.
dimension
- subset
- void setActiveSubset2(Dimension dimension, Subset2 subset)
Note: null
is allowed and will deactivate the
current active subset2.
dimension
- subset
- Subset2 getActiveSubset2(Dimension dimension)
null
if
the dimension has no active subset2, i.e. no subset is used
dimension
-
Subset
to use for the given dimension or nullElement getSelectedElement(Dimension dimension)
getSelectedElement(Hierarchy)
instead.
null
if none has been set
dimension
- the dimension for which the selected element is to be
returned.
Element
for the given dimension
or null
.Element getSelectedElement(Hierarchy hierarchy)
null
if none has been set
hierarchy
- the hierarchy for which the selected element is to be
returned.
Element
for the given hierarchy
or null
.void setSelectedElement(Dimension dimension, Element element)
setSelectedElement(Hierarchy, Element)
instead.
Note: providing null
as element is allowed and
will deselect currently selected element
dimension
- the dimension for which the element is to be set.element
- the selected element for this dimension or null.void setSelectedElement(Hierarchy hierarchy, Element element)
Note: providing null
as element is allowed and
will deselect currently selected element
hierarchy
- the hierarchy for which the element is to be set.element
- the selected element for this hierarchy or null.void addExpanded(Dimension dimension, Element[] path, int repetition)
addExpanded(ElementPath)
instead
dimension
- the dimension for which the expand path is to be setpath
- the path of the expanded elementsrepetition
- determines which path repetition is actually expandedvoid addExpanded(Hierarchy hierarchy, Element[] path, int repetition)
addExpanded(ElementPath)
instead
hierarchy
- the hierarchy for which the expand path is to be setpath
- the path of the expanded elementsrepetition
- determines which path repetition is actually expandedvoid removeExpanded(Dimension dimension, Element[] path, int repetition)
removeExpanded(ElementPath)
instead
dimension
- path
- repetition
- the path repetition which should be removedvoid removeExpanded(Hierarchy hierarchy, Element[] path, int repetition)
removeExpanded(ElementPath)
instead
hierarchy
- path
- repetition
- the path repetition which should be removedElement[][] getExpanded(Dimension dimension)
getExpandedPaths()
instead
dimension
-
Element[][] getExpanded(Hierarchy hierarchy)
getExpandedPaths()
instead
hierarchy
-
ElementPath[] getExpandedPaths()
ElementPath
s which are
registered with this axis.
void addExpanded(ElementPath path)
ElementPath
to the expand list of
this axis.
path
- to the expanded elementvoid addExpanded(ElementPath[] paths)
ElementPath
s
in one go
paths
- to the expanded elementsvoid removeExpanded(ElementPath path)
ElementPath
from the expand list
of this axis
path
- int[] getRepetitionsForExpanded(Dimension dimension, Element[] path)
getExpandedPaths()
instead
dimension
- path
-
int[] getRepetitionsForExpanded(Hierarchy hierarchy, Element[] path)
getExpandedPaths()
instead
hierarchy
- path
-
void addHidden(Dimension dimension, Element[] path)
addVisible(ElementPath)
dimension
- path
- void addHidden(Hierarchy hierarchy, Element[] path)
addVisible(ElementPath)
hierarchy
- path
- void removeHidden(Dimension dimension, Element[] path)
removeVisible(ElementPath)
dimension
- path
- void removeHidden(Hierarchy hierarchy, Element[] path)
removeVisible(ElementPath)
hierarchy
- path
- Element[][] getHidden(Dimension dimension)
getVisiblePaths(Dimension)
dimension
-
Element[][] getHidden(Hierarchy hierarchy)
getVisiblePaths(Hierarchy)
hierarchy
-
void addVisible(ElementPath path)
path
- void removeVisible(ElementPath path)
path
- ElementPath[] getVisiblePaths(Dimension dimension)
getVisiblePaths(Hierarchy)
instead.
dimension
- the dimension for which the visible element paths are
to be returned.
ElementPath[] getVisiblePaths(Hierarchy hierarchy)
hierarchy
- the hierarchy for which the visible element paths are
to be returned.
boolean isVisible(ElementPath path)
path
- path to the element
true
if specified element is visible, otherwise
false
void addProperty(java.lang.String id, java.lang.String value)
id
- a unique identifiervalue
- the property valuevoid removeProperty(java.lang.String id)
id
- the property identifierjava.lang.String[] getProperties()
java.lang.String getPropertyValue(java.lang.String id)
id
- the property identifier
java.lang.String getData(java.lang.String id)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |