Style Intelligence v12.0

inetsoft.uql.erm
Class ERMDimension

java.lang.Object
  extended by inetsoft.uql.erm.ERMDimension
All Implemented Interfaces:
XDimension, Serializable, Cloneable
Direct Known Subclasses:
ERMDateDimension

public class ERMDimension
extends Object
implements XDimension

Represents a cube dimension.

Since:
6.0
See Also:
Serialized Form

Constructor Summary
ERMDimension(String name)
          Create a new instance of XDimension.
 
Method Summary
 void addLevel(ERMCubeMember member)
          Add a level to this dimension.
 Object clone()
          Create a copy of this object.
 String getDescription()
          Get a description of this dimension.
 XCubeMember getLevel(String name)
          Get the dimension level with the specified name.
 XCubeMember getLevelAt(int idx)
          Get the specified level.
 int getLevelCount()
          Get the number of levels in this dimension.
 Enumeration getLevels()
          Get all the levels contained in this dimension.
 String getName()
          Get the name of this dimension.
 int getScope(String levelName)
          Get the scope (index) of the specified level.
 int getType()
          Get the type of this dimension.
 int indexOf(String level)
          Get the index of the requested level.
 void removeLevel(String name)
          Remove the specified level from this dimension.
 void renameLevel(String oldName, String newName)
          Rename a level in this dimension.
 void setDescription(String description)
          Set the description of this dimension.
 void setName(String name)
          Set the name of this dimension.
 void setScope(String name, int scope)
          Set the scope of the specified level.
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ERMDimension

public ERMDimension(String name)
Create a new instance of XDimension.

Parameters:
name - the name of the dimension.
Method Detail

getName

public String getName()
Get the name of this dimension.

Specified by:
getName in interface XDimension
Returns:
the dimension name.

setName

public void setName(String name)
Set the name of this dimension.

Parameters:
name - the dimension name.

getDescription

public String getDescription()
Get a description of this dimension.

Returns:
a description.

setDescription

public void setDescription(String description)
Set the description of this dimension.

Parameters:
description - a description.

getLevelCount

public int getLevelCount()
Get the number of levels in this dimension.

Specified by:
getLevelCount in interface XDimension
Returns:
the number of levels in this dimension.

getLevelAt

public XCubeMember getLevelAt(int idx)
Get the specified level.

Specified by:
getLevelAt in interface XDimension
Parameters:
idx - the index of the requested level.
Returns:
members have got.
Throws:
ArrayIndexOutOfBoundsException - if the index is outside the range of levels contained in this dimension.

getLevel

public XCubeMember getLevel(String name)
Get the dimension level with the specified name.

Parameters:
name - the name of the dimension level.
Returns:
a dimension level or null if this dimension does not contain a level with the specifed name.

getType

public int getType()
Get the type of this dimension.

Specified by:
getType in interface XDimension
Returns:
the type of this dimension.

getLevels

public Enumeration getLevels()
Get all the levels contained in this dimension.

Returns:
an Enumeration containing ERMCubeMember objects

addLevel

public void addLevel(ERMCubeMember member)
Add a level to this dimension.

Parameters:
member - the level to add.

removeLevel

public void removeLevel(String name)
Remove the specified level from this dimension.

Parameters:
name - the name of the level to remove.

renameLevel

public void renameLevel(String oldName,
                        String newName)
Rename a level in this dimension.

Parameters:
oldName - the old name of the level.
newName - the new name of the level.

getScope

public int getScope(String levelName)
Get the scope (index) of the specified level.

Specified by:
getScope in interface XDimension
Parameters:
levelName - the name of the level.
Returns:
the index of the specified level.

setScope

public void setScope(String name,
                     int scope)
Set the scope of the specified level. Shifts any displaced members to a narrower scope.

Parameters:
name - the name of the level.
scope - the scope, 0 being the widest.

clone

public Object clone()
Create a copy of this object.

Overrides:
clone in class Object
Returns:
a copy of this object.

toString

public String toString()
Overrides:
toString in class Object

indexOf

public int indexOf(String level)
Get the index of the requested level.


Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.