Skip navigation links


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

java.lang.Object
  extended by com.essbase.eas.essbase.defs.ImposedName
      extended by com.essbase.eas.essbase.defs.DefinedGeneration
          extended by com.essbase.eas.essbase.ui.outline.controls.UIDefinedGeneration


public class UIDefinedGeneration
extends DefinedGeneration

extends the DefinedGeneration class to include some UI-related features in order to work inside the GenerationsTable 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 DefinedGeneration 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 UIDefinedGeneration()
           
  UIDefinedGeneration(DefinedGeneration source)
          creates an instance of a UIDefinedGeneration using a DefinedGeneration object as the source.

 

Method Summary
static void addItemToHashtable(java.util.Hashtable t, DefinedGeneration value)
           
static UIDefinedGeneration createEmptyInstance()
          creates and returns an instance of an empty defined generation.
 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 generation.
 boolean isMarkedAsNew()
          returns the markedAsNew property.
 boolean isMarkedForDeletion()
          returns the markedForDeletion property.
static void populateHashtable(java.util.Hashtable t, DefinedGeneration[] values)
          creates a hash table from a set of DefinedGeneration objects.
static UIDefinedGeneration[] retrieveAll(java.util.Hashtable t)
           
static UIDefinedGeneration[] retrieveByDimension(java.util.Hashtable t, java.lang.String dimension, boolean sort)
          retrieves all UIDefinedGeneration objects from a hash table that belong to a specific dimension.
 void setEmpty(boolean value)
          sets the empty named generation 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.
 boolean supportsUnique()
           

 

Methods inherited from class com.essbase.eas.essbase.defs.ImposedName
clone, getDimension, getName, getNumber, getUnique, setDimension, setName, setNumber, setNumber, setUnique

 

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

UIDefinedGeneration

protected UIDefinedGeneration()

UIDefinedGeneration

public UIDefinedGeneration(DefinedGeneration source)
creates an instance of a UIDefinedGeneration using a DefinedGeneration object as the source.

Method Detail

setEmpty

public void setEmpty(boolean value)
sets the empty named generation flag.

isEmpty

public boolean isEmpty()
retrieves the boolean value indicating that this is an "empty" defined generation.

createEmptyInstance

public static UIDefinedGeneration createEmptyInstance()
creates and returns an instance of an empty defined generation.

getOriginalName

public java.lang.String getOriginalName()

getOriginalNumber

public int getOriginalNumber()

getOriginalUnique

public boolean getOriginalUnique()

supportsUnique

public boolean supportsUnique()
Overrides:
supportsUnique in class ImposedName
Returns:

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.

hasUniqueChanged

public boolean hasUniqueChanged()

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.

retrieveAll

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

retrieveByDimension

public static UIDefinedGeneration[] retrieveByDimension(java.util.Hashtable t,
                                                        java.lang.String dimension,
                                                        boolean sort)
retrieves all UIDefinedGeneration objects from a hash table that belong to a specific dimension. The results can be sorted.
Parameters:
t - hashtable containing the UIDefinedGeneration objects.
dimension - string with the name to extract generations for.
sort - boolean indicating whether to sort the results by generation number.

populateHashtable

public static void populateHashtable(java.util.Hashtable t,
                                     DefinedGeneration[] values)
creates a hash table from a set of DefinedGeneration objects.

addItemToHashtable

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

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.