Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.table
Class TableDimension

java.lang.Object
  extended by com.citra.pivot.table.AbstractTableObject
      extended by com.citra.pivot.table.TableDimension
All Implemented Interfaces:
OlapDimension, OlapObject

public class TableDimension
extends AbstractTableObject
implements OlapDimension

TableDimension is the the concrete OlapDimension implementation for the table datasource.


Field Summary
protected  HierarchyList hierarchies
          the dimension's hierarchies
 
Fields inherited from class com.citra.pivot.table.AbstractTableObject
caption, description, id, name
 
Method Summary
 void addHierarchy(TableHierarchy hierarchy)
          Adds a hierarchy to the dimension.
 TableHierarchy createHierarchy(String name)
          Creates, adds and returns a hierarchy with a given name.
 OlapHierarchy getDefaultHierarchy()
          Retrieves the default hierarchy of the dimension.
 HierarchyList getHierarchies()
          Retrieves the hierarchies of the dimension.
 boolean isMeasureDimension()
          Determines whether the dimension is the measure dimension.
 void removeHierarchy(TableHierarchy hierarchy)
          Removes a hierarchy from the dimension.
 void setDefaultHierarchy(TableHierarchy hierarchy)
          Assigns the default hierarchy for the dimension.
 
Methods inherited from class com.citra.pivot.table.AbstractTableObject
getCaption, getCaption, getDescription, getDescription, getID, getName, setCaption, setCaption, setDescription, setDescription, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.citra.pivot.olap.metadata.OlapObject
getCaption, getDescription, getID, getName
 

Field Detail

hierarchies

protected HierarchyList hierarchies
the dimension's hierarchies

Method Detail

addHierarchy

public void addHierarchy(TableHierarchy hierarchy)
Adds a hierarchy to the dimension.

Parameters:
hierarchy - the hierarchy to add

createHierarchy

public TableHierarchy createHierarchy(String name)
Creates, adds and returns a hierarchy with a given name. The hierarchy is added to the dimension.

Parameters:
name - the hierarchy's name
Returns:
the hierarchy created

getDefaultHierarchy

public OlapHierarchy getDefaultHierarchy()
Retrieves the default hierarchy of the dimension.

Specified by:
getDefaultHierarchy in interface OlapDimension
Returns:
the dimension's default hierarchy

getHierarchies

public HierarchyList getHierarchies()
Retrieves the hierarchies of the dimension.

Specified by:
getHierarchies in interface OlapDimension
Returns:
the dimension's hierarchies

isMeasureDimension

public boolean isMeasureDimension()
Determines whether the dimension is the measure dimension.

Specified by:
isMeasureDimension in interface OlapDimension
Returns:
true if the dimension is the measure dimension, false otherwise

removeHierarchy

public void removeHierarchy(TableHierarchy hierarchy)
Removes a hierarchy from the dimension.

Parameters:
hierarchy - the hierarchy to remove

setDefaultHierarchy

public void setDefaultHierarchy(TableHierarchy hierarchy)
Assigns the default hierarchy for the dimension.

Parameters:
hierarchy - the hierarchy to assign as the dimension's default

Copyright © 2011 Citra Technologies. All Rights Reserved.