Skip navigation links

com.essbase.eas.essbase.ui.outline.controls
Class UIDefinedLevel

java.lang.Object
com.essbase.eas.essbase.defs.ImposedName
com.essbase.eas.essbase.defs.DefinedLevel
com.essbase.eas.essbase.ui.outline.controls.UIDefinedLevel

public class UIDefinedLevel

extends DefinedLevel

extends the DefinedLevel class to include some UI-related features in order to work inside the LevelsTable control. The markedForDeletion, markedAsNew, nameChanged, numberChanged, and empty properties can be used by a UI component to provide visual indicators of changes that have been made to a DefinedLevel object.

Version:

1.00, 01/16/2002

Author:

Hank Cox

Field Summary

Fields inherited from class com.essbase.eas.essbase.defs.ImposedName

dimension, name, number, supportsUnique, unique

Constructor Summary

protected	UIDefinedLevel()
	UIDefinedLevel(DefinedLevel source) creates an instance of a UIDefinedLevel using a DefinedLevel object as the source.

Method Summary

static void	addItemToHashtable(java.util.Hashtable t, DefinedLevel value)
static UIDefinedLevel	createEmptyInstance() creates and returns an instance of an empty defined level.
java.lang.String	getOriginalName()
int	getOriginalNumber()
boolean	getOriginalUnique()
boolean	hasNameChanged() returns the nameChanged property.
boolean	hasNumberChanged() returns the numberChanged property.
boolean	hasUniqueChanged()
boolean	isEmpty() retrieves the boolean value indicating that this is an "empty" defined level.
boolean	isMarkedAsNew() returns the markedAsNew property.
boolean	isMarkedForDeletion() returns the markedForDeletion property.
static void	populateHashtable(java.util.Hashtable t, DefinedLevel[] values) creates a hash table from a set of DefinedLevel objects.
static UIDefinedLevel[]	retrieveAll(java.util.Hashtable t)
static UIDefinedLevel[]	retrieveByDimension(java.util.Hashtable t, java.lang.String dimension, boolean sort) retrieves all UIDefinedLevel objects from a hash table that belong to a specific dimension.
void	setEmpty(boolean value) sets the empty named level flag.
void	setMarkedAsNew(boolean value) sets the markedAsNew property.
void	setMarkedForDeletion(boolean value) sets the markedForDeletion property.
void	setNameChanged(boolean value) sets the nameChanged property.
void	setNumberChanged(boolean value) sets the numberChanged property.
void	setUnique(boolean uniqueness)

Methods inherited from class com.essbase.eas.essbase.defs.ImposedName

clone, getDimension, getName, getNumber, getUnique, setDimension, setName, setNumber, setNumber, supportsUnique

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UIDefinedLevel

protected UIDefinedLevel()

UIDefinedLevel

public UIDefinedLevel(DefinedLevel source)

creates an instance of a UIDefinedLevel using a DefinedLevel object as the source.

Method Detail

setEmpty

public void setEmpty(boolean value)

sets the empty named level flag.

isEmpty

public boolean isEmpty()

retrieves the boolean value indicating that this is an "empty" defined level.

createEmptyInstance

public static UIDefinedLevel createEmptyInstance()

creates and returns an instance of an empty defined level.

getOriginalName

public java.lang.String getOriginalName()

getOriginalNumber

public int getOriginalNumber()

getOriginalUnique

public boolean getOriginalUnique()

hasUniqueChanged

public boolean hasUniqueChanged()

hasNameChanged

public boolean hasNameChanged()

returns the nameChanged property.

setNameChanged

public void setNameChanged(boolean value)

sets the nameChanged property.

hasNumberChanged

public boolean hasNumberChanged()

returns the numberChanged property.

setNumberChanged

public void setNumberChanged(boolean value)

sets the numberChanged property.

isMarkedAsNew

public boolean isMarkedAsNew()

returns the markedAsNew property.

setMarkedAsNew

public void setMarkedAsNew(boolean value)

sets the markedAsNew property.

isMarkedForDeletion

public boolean isMarkedForDeletion()

returns the markedForDeletion property.

setMarkedForDeletion

public void setMarkedForDeletion(boolean value)

sets the markedForDeletion property.

setUnique

public void setUnique(boolean uniqueness)

Overrides:

setUnique in class ImposedName

retrieveAll

public static UIDefinedLevel[] retrieveAll(java.util.Hashtable t)

retrieveByDimension

public static UIDefinedLevel[] retrieveByDimension(java.util.Hashtable t,
                                                   java.lang.String dimension,
                                                   boolean sort)

retrieves all UIDefinedLevel objects from a hash table that belong to a specific dimension. The results can be sorted.

Parameters:

t - hashtable containing the UIDefinedLevel objects.

dimension - string with the name to extract levels for.

sort - boolean indicating whether to sort the results by level number.

populateHashtable

public static void populateHashtable(java.util.Hashtable t,
                                     DefinedLevel[] values)

creates a hash table from a set of DefinedLevel objects.

addItemToHashtable

public static void addItemToHashtable(java.util.Hashtable t,
                                      DefinedLevel value)

Skip navigation links