org.palo.api
Interface Axis

public interface Axis

An Axis holds several cube Dimensions and manages their current state. A dimension state is described by its active Subset and its currently expanded Elements. Furthermore you can set a selected element for a fix dimension, i.e. this dimension defines a fix part of a cube cell coordinate.

Version:

$Id: Axis.html,v 1.16 2008/05/20 10:41:48 ArndHouben Exp $

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 ElementPath to the expand list of this axis.
void	addExpanded(ElementPath[] paths) Convenience method to add several ElementPaths 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 ElementPaths 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 ElementPath 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

getId

java.lang.String getId()

Returns the unique id of the axis

Returns:

the axis identifier

setName

void setName(java.lang.String name)

Sets an optional name for the axis

Parameters:

name - the axis name

getName

java.lang.String getName()

Returns the axis name or null if none has been set

Returns:

the axis name or null

getHierarchy

Hierarchy getHierarchy(Dimension dimension)

Returns the hierarchy that has been set for the specified dimension.

Parameters:

dimension - the dimension whose hierarchy is requested.

Returns:

the hierarchy that has been set for the specified dimension or null if the dimension is not present on this axis.

add

void add(Dimension dimension)

Deprecated. use add(Hierarchy) instead.

Adds the given dimension to the axis and selects its default hierarchy

Parameters:

dimension - the dimension to add

add

void add(Hierarchy hierarchy)

Adds the given hierarchy to the axis.

Parameters:

hierarchy - the hierarchy to add.

remove

void remove(Dimension dimension)

Deprecated. use remove(Hierarchy) instead.

Removes the given dimension from the axis

Parameters:

dimension - the dimension to remove

remove

void remove(Hierarchy hierarchy)

Removes the given hierarchy from the axis

Parameters:

hierarchy - the hierarchy to remove

getDimensions

Dimension[] getDimensions()

Deprecated. use getHierarchies() instead.

Returns all added dimensions

Returns:

all registered Dimensions

getHierarchies

Hierarchy[] getHierarchies()

Returns all added hierarchies

Returns:

all registered Hierarchy objects

getActiveSubset

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

Parameters:

dimension -

Returns:

the active Subset to use for the given dimension or null

setActiveSubset

void setActiveSubset(Dimension dimension,
                     Subset subset)

Sets the active subset for the given dimension.

Note: null is allowed and will deactivate the current active subset.

Parameters:

dimension -

subset -

setActiveSubset2

void setActiveSubset2(Dimension dimension,
                      Subset2 subset)

Sets the active modern subset2 for the given dimension.

Note: null is allowed and will deactivate the current active subset2.

Parameters:

dimension -

subset -

getActiveSubset2

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

Parameters:

dimension -

Returns:

the active Subset to use for the given dimension or null

getSelectedElement

Element getSelectedElement(Dimension dimension)

Deprecated. use getSelectedElement(Hierarchy) instead.

Returns the currently selected element of the given dimension or null if none has been set

Parameters:

dimension - the dimension for which the selected element is to be returned.

Returns:

the current selected Element for the given dimension or null.

getSelectedElement

Element getSelectedElement(Hierarchy hierarchy)

Returns the currently selected element of the given hierarchy or null if none has been set

Parameters:

hierarchy - the hierarchy for which the selected element is to be returned.

Returns:

the current selected Element for the given hierarchy or null.

setSelectedElement

void setSelectedElement(Dimension dimension,
                        Element element)

Deprecated. use setSelectedElement(Hierarchy, Element) instead.

Sets the currently selected element of the given dimension.

Note: providing null as element is allowed and will deselect currently selected element

Parameters:

dimension - the dimension for which the element is to be set.

element - the selected element for this dimension or null.

setSelectedElement

void setSelectedElement(Hierarchy hierarchy,
                        Element element)

Sets the currently selected element of the given hierarchy.

Note: providing null as element is allowed and will deselect currently selected element

Parameters:

hierarchy - the hierarchy for which the element is to be set.

element - the selected element for this hierarchy or null.

addExpanded

void addExpanded(Dimension dimension,
                 Element[] path,
                 int repetition)

Deprecated. please use addExpanded(ElementPath) instead

Adds the given path to the expand list of the provided dimension. An element path describes the path to the expanded element inside its dimension. Since a path can occur several times within a multi dimension axis, the repetition parameter determines which repetition of the path is actually expanded

Parameters:

dimension - the dimension for which the expand path is to be set

path - the path of the expanded elements

repetition - determines which path repetition is actually expanded

addExpanded

void addExpanded(Hierarchy hierarchy,
                 Element[] path,
                 int repetition)

Deprecated. please use addExpanded(ElementPath) instead

Adds the given path to the expand list of the provided hierarchy. An element path describes the path to the expanded element inside its hierarchy. Since a path can occur several times within a multi hierarchy axis, the repetition parameter determines which repetition of the path is actually expanded

Parameters:

hierarchy - the hierarchy for which the expand path is to be set

path - the path of the expanded elements

repetition - determines which path repetition is actually expanded

removeExpanded

void removeExpanded(Dimension dimension,
                    Element[] path,
                    int repetition)

Deprecated. please use removeExpanded(ElementPath) instead

Removes the given path from the expanded path list of the provided dimension.

Parameters:

dimension -

path -

repetition - the path repetition which should be removed

removeExpanded

void removeExpanded(Hierarchy hierarchy,
                    Element[] path,
                    int repetition)

Deprecated. please use removeExpanded(ElementPath) instead

Removes the given path from the expanded path list of the provided hierarchy.

Parameters:

hierarchy -

path -

repetition - the path repetition which should be removed

getExpanded

Element[][] getExpanded(Dimension dimension)

Deprecated. please use getExpandedPaths() instead

Returns all expanded paths for the given dimension

Parameters:

dimension -

Returns:

all expanded paths

getExpanded

Element[][] getExpanded(Hierarchy hierarchy)

Deprecated. please use getExpandedPaths() instead

Returns all expanded paths for the given hierarchy

Parameters:

hierarchy -

Returns:

all expanded paths

getExpandedPaths

ElementPath[] getExpandedPaths()

Returns all expanded ElementPaths which are registered with this axis.

Returns:

all expanded paths

addExpanded

void addExpanded(ElementPath path)

Adds the given ElementPath to the expand list of this axis.

Parameters:

path - to the expanded element

addExpanded

void addExpanded(ElementPath[] paths)

Convenience method to add several ElementPaths in one go

Parameters:

paths - to the expanded elements

removeExpanded

void removeExpanded(ElementPath path)

Removes the given ElementPath from the expand list of this axis

Parameters:

path -

getRepetitionsForExpanded

int[] getRepetitionsForExpanded(Dimension dimension,
                                Element[] path)

Deprecated. please use getExpandedPaths() instead

Returns all repetition positions for the specified expanded path within the given dimension

Parameters:

dimension -

path -

Returns:

all repetitions for the specified path within given dimension

getRepetitionsForExpanded

int[] getRepetitionsForExpanded(Hierarchy hierarchy,
                                Element[] path)

Deprecated. please use getExpandedPaths() instead

Returns all repetition positions for the specified expanded path within the given hierarchy

Parameters:

hierarchy -

path -

Returns:

all repetitions for the specified path within given hierarchy

addHidden

void addHidden(Dimension dimension,
               Element[] path)

Deprecated. please use addVisible(ElementPath)

Adds the given path to the hidden path list of the provided dimension. The element path describes the path to the hidden element inside its dimension.

Parameters:

dimension -

path -

addHidden

void addHidden(Hierarchy hierarchy,
               Element[] path)

Deprecated. please use addVisible(ElementPath)

Adds the given path to the hidden path list of the provided hierarchy. The element path describes the path to the hidden element inside its dimension.

Parameters:

hierarchy -

path -

removeHidden

void removeHidden(Dimension dimension,
                  Element[] path)

Deprecated. please use removeVisible(ElementPath)

Removes the given path from the hidden path list of the provided dimension

Parameters:

dimension -

path -

removeHidden

void removeHidden(Hierarchy hierarchy,
                  Element[] path)

Deprecated. please use removeVisible(ElementPath)

Removes the given path from the hidden path list of the provided hierarchy

Parameters:

hierarchy -

path -

getHidden

Element[][] getHidden(Dimension dimension)

Deprecated. please use getVisiblePaths(Dimension)

Returns all hidden paths for the given dimension

Parameters:

dimension -

Returns:

all hidden paths

getHidden

Element[][] getHidden(Hierarchy hierarchy)

Deprecated. please use getVisiblePaths(Hierarchy)

Returns all hidden paths for the given hierarchy

Parameters:

hierarchy -

Returns:

all hidden paths

addVisible

void addVisible(ElementPath path)

Adds the given path to the visible path list of this axis. The element path describes a path to the visible element inside its dimension.

Parameters:

path -

removeVisible

void removeVisible(ElementPath path)

Removes the given path from the visible path list of this axis.

Parameters:

path -

getVisiblePaths

ElementPath[] getVisiblePaths(Dimension dimension)

Deprecated. please use getVisiblePaths(Hierarchy) instead.

Returns all visible paths for this axis.

Parameters:

dimension - the dimension for which the visible element paths are to be returned.

Returns:

all visible paths for the specified dimension.

getVisiblePaths

ElementPath[] getVisiblePaths(Hierarchy hierarchy)

Returns all visible paths for this axis.

Parameters:

hierarchy - the hierarchy for which the visible element paths are to be returned.

Returns:

all visible paths for the specified hierarchy.

isVisible

boolean isVisible(ElementPath path)

Checks if the element specified by the given path is visible or not

Parameters:

path - path to the element

Returns:

true if specified element is visible, otherwise false

addProperty

void addProperty(java.lang.String id,
                 java.lang.String value)

Deprecated. please do not use. this method is subject for modifications

Adds a property with the given id and given value to this axis NOTE: RIGHT NOW FOR INTERNAL USAGE ONLY

Parameters:

id - a unique identifier

value - the property value

removeProperty

void removeProperty(java.lang.String id)

Deprecated. please do not use. this method is subject for modifications

Removes the property specified by the given id from this axis NOTE: RIGHT NOW FOR INTERNAL USAGE ONLY

Parameters:

id - the property identifier

getProperties

java.lang.String[] getProperties()

Deprecated. please do not use. this method is subject for modifications

Returns all property ids NOTE: RIGHT NOW FOR INTERNAL USAGE ONLY

Returns:

all property identifiers

getPropertyValue

java.lang.String getPropertyValue(java.lang.String id)

Deprecated. please do not use. this method is subject for modifications

Returns the value of the property specified by the given id NOTE: RIGHT NOW FOR INTERNAL USAGE ONLY

Parameters:

id - the property identifier

Returns:

the property value

getData

java.lang.String getData(java.lang.String id)

Deprecated. please do not use. this method is subject for modifications

NOTE: RIGHT NOW FOR INTERNAL USAGE ONLY