Skip navigation links


com.essbase.eas.essbase.defs
Class OutlineProperties

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


public class OutlineProperties
extends java.lang.Object

implements all of the properties of an outline. These can be broken down into several subsets: outline information, generation names, level names, and attribute specifications.


Nested Class Summary
static class OutlineProperties.ArtificialName
          Deprecated. this inner class is deprecated.
static class OutlineProperties.AttributeSpecifications
          inner class used for attribute specifications for this outline.

 

Constructor Summary
OutlineProperties()
           

 

Method Summary
 void addAliastTable(java.lang.String value)
           
 void addGeneration(java.lang.String dimension, int number, java.lang.String name)
           
 void addGeneration(java.lang.String dimension, int number, java.lang.String name, boolean unique)
          creates a defined generation object and adds it to the collection of generations.
 void addLevel(java.lang.String dimension, int number, java.lang.String name)
           
 void addLevel(java.lang.String dimension, int number, java.lang.String name, boolean unique)
          creates a defined level object and adds it to the collection of levels.
 void changeGenerationNumber(ImposedName value, int newNumber)
          changes the "number of a defined generation.
 void changeGenerationNumber(java.lang.String dimension, int number, int newNumber)
          changes the "number" of a defined generation.
 void changeLevelNumber(ImposedName value, int newNumber)
          changes the "number" of a defined level
 void changeLevelNumber(java.lang.String dimension, int number, int newNumber)
          changes the "number" of a defined level
 void clearAliasTables()
           
 void clearGenerations()
          empties the collection of generation objects.
 void clearLevels()
          empties the collection of level objects.
 java.lang.String[] getAliasTables()
           
 OutlineProperties.AttributeSpecifications getAttributeSpecifications()
           
 boolean getAutoConfigure()
           
 boolean getCaseSensitive()
           
 DefinedGeneration[] getDefinedGenerations()
          returns an array of DefinedGeneration objects representing all of the named generations for this this outline.
 DefinedLevel[] getDefinedLevels()
          returns an array of DefinedLevel objects representing all of the named levels for this this outline.
 OutlineProperties.ArtificialName[] getGenerations()
          Deprecated. replaced by getDefinedGenerations()
 OutlineProperties.ArtificialName[] getLevels()
          Deprecated. replaced by getDefinedLevels()
 short getOutlineType()
           
 java.lang.String getOutlineTypeAsString()
           
 void removeGeneration(ImposedName value)
          removes a generation from the collection of defined generations.
 void removeGeneration(java.lang.String dimension, int number)
          removes a generation from the set of defined generations.
 void removeLevel(ImposedName value)
          removes a level from the collection of defined levels.
 void removeLevel(java.lang.String dimension, int number)
          removes a level from the collection of defined levels.
 void renameGeneration(ImposedName value, java.lang.String newName)
          renames a generation in the collection of defined generations
 void renameGeneration(java.lang.String dimension, int number, java.lang.String newName)
          renames a generation in the set of defined generations.
 void renameLevel(ImposedName value, java.lang.String newName)
          renames a level in the collection of defined levels
 void renameLevel(java.lang.String dimension, int number, java.lang.String newName)
          renames a level in the collection of defined levels.
 void setAutoConfigure(boolean value)
           
 void setCaseSensitive(boolean value)
           
 void setOutlineType(short value)
           

 

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

 

Constructor Detail

OutlineProperties

public OutlineProperties()

Method Detail

getCaseSensitive

public boolean getCaseSensitive()

setCaseSensitive

public void setCaseSensitive(boolean value)

getOutlineType

public short getOutlineType()

getOutlineTypeAsString

public java.lang.String getOutlineTypeAsString()

setOutlineType

public void setOutlineType(short value)

getAutoConfigure

public boolean getAutoConfigure()

setAutoConfigure

public void setAutoConfigure(boolean value)

addAliastTable

public void addAliastTable(java.lang.String value)

addGeneration

public void addGeneration(java.lang.String dimension,
                          int number,
                          java.lang.String name)

addGeneration

public void addGeneration(java.lang.String dimension,
                          int number,
                          java.lang.String name,
                          boolean unique)
creates a defined generation object and adds it to the collection of generations.
Parameters:
dimension - the dimension containing the generation
number - the generation's number
name - the generation's name

addLevel

public void addLevel(java.lang.String dimension,
                     int number,
                     java.lang.String name)

addLevel

public void addLevel(java.lang.String dimension,
                     int number,
                     java.lang.String name,
                     boolean unique)
creates a defined level object and adds it to the collection of levels.
Parameters:
dimension - the dimension containing the level
number - the level's number
name - the level's name

removeGeneration

public void removeGeneration(java.lang.String dimension,
                             int number)
removes a generation from the set of defined generations.
Parameters:
dimension - the dimension containing the generation
number - the generation's number

removeGeneration

public void removeGeneration(ImposedName value)
removes a generation from the collection of defined generations.
Parameters:
value - an ImposedName representing the generation

removeLevel

public void removeLevel(java.lang.String dimension,
                        int number)
removes a level from the collection of defined levels.
Parameters:
dimension - the dimension containing the level
number - the level's number

removeLevel

public void removeLevel(ImposedName value)
removes a level from the collection of defined levels.
Parameters:
value - an ImposedName representing the level

renameGeneration

public void renameGeneration(java.lang.String dimension,
                             int number,
                             java.lang.String newName)
renames a generation in the set of defined generations.
Parameters:
dimension - the dimension containing the generation
number - the generation's number
newName - the generation's new name.

renameGeneration

public void renameGeneration(ImposedName value,
                             java.lang.String newName)
renames a generation in the collection of defined generations
Parameters:
value - an ImposedName object representing the generation to change
newName - the generation's new name.

renameLevel

public void renameLevel(java.lang.String dimension,
                        int number,
                        java.lang.String newName)
renames a level in the collection of defined levels.
Parameters:
dimension - the dimension containing the level
number - the level's number
newName - the level's new name

renameLevel

public void renameLevel(ImposedName value,
                        java.lang.String newName)
renames a level in the collection of defined levels
Parameters:
value - an ImposedName object representing the level to change
newName - the level's new name.

changeGenerationNumber

public void changeGenerationNumber(java.lang.String dimension,
                                   int number,
                                   int newNumber)
changes the "number" of a defined generation.
Parameters:
dimension - the dimension containing the generation
number - the old number of the generation
newNumber - the new number of the generation

changeGenerationNumber

public void changeGenerationNumber(ImposedName value,
                                   int newNumber)
changes the "number of a defined generation.
Parameters:
value - an ImposedName object representing the generation
newNumber - the new number of the generation

changeLevelNumber

public void changeLevelNumber(java.lang.String dimension,
                              int number,
                              int newNumber)
changes the "number" of a defined level
Parameters:
dimension - the dimension containing the level
number - the old number of the level
newNumber - the new number of the level

changeLevelNumber

public void changeLevelNumber(ImposedName value,
                              int newNumber)
changes the "number" of a defined level
Parameters:
value - an ImposedName object representing the level
newNumber - the new number of the level

clearGenerations

public void clearGenerations()
empties the collection of generation objects.

clearLevels

public void clearLevels()
empties the collection of level objects.

clearAliasTables

public void clearAliasTables()

getAliasTables

public java.lang.String[] getAliasTables()

getAttributeSpecifications

public OutlineProperties.AttributeSpecifications getAttributeSpecifications()

getGenerations

public OutlineProperties.ArtificialName[] getGenerations()
Deprecated. replaced by getDefinedGenerations()
returns an array of ArtificialName objects representing all of the named generations for this outline.

getDefinedGenerations

public DefinedGeneration[] getDefinedGenerations()
returns an array of DefinedGeneration objects representing all of the named generations for this this outline. These DefinedGeneration objects are clones of the objects in the collection, so changing the returned objects will not affect the collection stored in this OutlineProperties instance. If changing the collection is required, use the methods listed below.
Returns:
an array of DefinedGeneration objects
See Also:
addGeneration(java.lang.String, int, java.lang.String), renameGeneration(java.lang.String, int, java.lang.String), removeGeneration(java.lang.String, int), changeGenerationNumber(java.lang.String, int, int)

getLevels

public OutlineProperties.ArtificialName[] getLevels()
Deprecated. replaced by getDefinedLevels()
returns an array of ArtificialName objects representing all of the named levels for this outline.

getDefinedLevels

public DefinedLevel[] getDefinedLevels()
returns an array of DefinedLevel objects representing all of the named levels for this this outline. These DefinedLevel objects are clones of the objects in the collection, so changing the returned objects will not affect the collection stored in this OutlineProperties instance. If changing the collection is required, use the methods listed below.
Returns:
an array of DefinedLevel objects
See Also:
addLevel(java.lang.String, int, java.lang.String), renameLevel(java.lang.String, int, java.lang.String), removeLevel(java.lang.String, int), changeLevelNumber(java.lang.String, int, int)

Skip navigation links


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