Skip navigation links


com.essbase.eas.essbase.defs
Class ImposedName

java.lang.Object
  extended by com.essbase.eas.essbase.defs.ImposedName

Direct Known Subclasses:
DefinedGeneration, DefinedLevel, OutlineProperties.ArtificialName

public abstract class ImposedName
extends java.lang.Object

implements an abstract base class that represents generation and level names in an outline.

Version:
1.00, 01/16/2002
Author:
Hank Cox
See Also:
DefinedGeneration, DefinedLevel

Field Summary
protected  java.lang.String dimension
          identifies the outline dimension this imposed name is assigned to
protected  java.lang.String name
          identifies the name value of this imposed name
protected  int number
          identifies the "level/generation" number associated with this instance
protected  boolean supportsUnique
          identifies whether the unique flag should be looked at
protected  boolean unique
          identifies whether this "level/generation" restricts members to be unique

 

Constructor Summary
protected ImposedName()
          creates an ImposedName with no set values
protected ImposedName(java.lang.String dimension, int number, java.lang.String name)
          creates an ImposedName with specific values.
protected ImposedName(java.lang.String dimension, int number, java.lang.String name, boolean uniqueness)
          creates an ImposedName with specific values.

 

Method Summary
protected  java.lang.Object clone()
           
 java.lang.String getDimension()
          Returns the dimension this ImposedName is associated with
 java.lang.String getName()
          Returns the name of this ImposedName
 int getNumber()
          Returns the level or generation number of this ImposedName
 boolean getUnique()
           
 void setDimension(java.lang.String value)
          Sets the dimension this ImposedName is associated with
 void setName(java.lang.String value)
          Sets the name for this ImposedName object
 void setNumber(int value)
          Sets the generation or level number of this ImposedName
 void setNumber(short value)
          sets the generation of level number of this ImposedName
 void setUnique(boolean uniqueness)
           
 boolean supportsUnique()
           

 

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

 

Field Detail

dimension

protected java.lang.String dimension
identifies the outline dimension this imposed name is assigned to

name

protected java.lang.String name
identifies the name value of this imposed name

number

protected int number
identifies the "level/generation" number associated with this instance

unique

protected boolean unique
identifies whether this "level/generation" restricts members to be unique

supportsUnique

protected boolean supportsUnique
identifies whether the unique flag should be looked at

Constructor Detail

ImposedName

protected ImposedName()
creates an ImposedName with no set values

ImposedName

protected ImposedName(java.lang.String dimension,
                      int number,
                      java.lang.String name)
creates an ImposedName with specific values.
Parameters:
dimension - the dimension to associate this ImposedName with
number - the level (or generation) number for this ImposedName
name - the name given to this ImposedName

ImposedName

protected ImposedName(java.lang.String dimension,
                      int number,
                      java.lang.String name,
                      boolean uniqueness)
creates an ImposedName with specific values.
Parameters:
dimension - the dimension to associate this ImposedName with
number - the level (or generation) number for this ImposedName
name - the name given to this ImposedName

Method Detail

getDimension

public java.lang.String getDimension()
Returns the dimension this ImposedName is associated with
Returns:
the dimension property
See Also:
setDimension(java.lang.String)

getNumber

public int getNumber()
Returns the level or generation number of this ImposedName
Returns:
the number property
See Also:
setNumber(int)

getName

public java.lang.String getName()
Returns the name of this ImposedName
Returns:
the name property
See Also:
setName(java.lang.String)

getUnique

public boolean getUnique()
Returns:

setDimension

public void setDimension(java.lang.String value)
Sets the dimension this ImposedName is associated with
Parameters:
value - the name of the dimension to associate this ImposedName with
See Also:
getDimension()

setNumber

public void setNumber(int value)
Sets the generation or level number of this ImposedName
Parameters:
value - the generation or level number
See Also:
getNumber()

setNumber

public void setNumber(short value)
sets the generation of level number of this ImposedName
Parameters:
value - the generation or level number.

setName

public void setName(java.lang.String value)
Sets the name for this ImposedName object
Parameters:
value - the new name for this ImposedName object
See Also:
getName()

setUnique

public void setUnique(boolean uniqueness)
Parameters:
uniqueness -

supportsUnique

public boolean supportsUnique()
Returns:

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException
Overrides:
clone in class java.lang.Object
Throws:
java.lang.CloneNotSupportedException

Skip navigation links


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