Skip navigation links


com.essbase.eas.essbase.defs.outline
Interface Settings

All Known Implementing Classes:
DefaultSettings, UISettings

public interface Settings
Author:
srasmuss TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

Field Summary
static short MAX_ALIAS_TABLES
          maximum number of alias tables permitted in an outline.
static short MAX_ALIAS_TABLES_TALLEYRAND
           

 

Method Summary
 void addAliasTable(AliasTable table)
          adds an alias table to this outline.
 void addAliasTable(java.lang.String tableName)
          adds an alias table to this outline.
 AliasTable[] getAliasTables()
          returns the collection of alias tables for this outline.
 java.lang.String getDateFormat()
          Returns the Date format supported by the outline
 OutlineType getOutlineType()
          returns the type of the outline.
 boolean getProvideWarnings()
          retrieves the provide warnings flag.
 boolean isAutoConfigure()
          returns the auto configure dimension storage.
 boolean isCaseSensitive()
          returns the outline's case sensitive member names flag.
 boolean isCurrentAliasTable(java.lang.String tableName)
          determines whether an alias table with a name currently exists.
 boolean isNonUnique()
          Returns whether non-unique names are enabled.
 boolean isTextualMeasuresEnabled()
          Returns whether the Outline supports Textual Measures
 boolean isVaryingAttributesEnabled()
          Returns whether the Outline supports Slowly Changing / varying attributes
 boolean removeAliasTable(AliasTable table)
          removes an alias table from this outline.
 boolean removeAliasTable(java.lang.String tableName)
          removes an alias table from this outline.
 void renameAliasTable(AliasTable table, java.lang.String tableName)
          renames an alias table.
 void renameAliasTable(java.lang.String currentName, java.lang.String newName)
          renames an alias table.
 void setAliasTables(AliasTable[] values)
          sets the collection of alias table for this outline.
 void setAutoConfigure(boolean value)
          sets the auto configure dimension storage.
 void setCaseSensitive(boolean value)
          sets the outline's case sensitive member names flag.
 void setDateFormat(java.lang.String format)
          Sets the date format supported by the outline
 void setNonUnique(boolean b)
          Set whether non unique names are enabled.
 void setOutlineType(OutlineType value)
          sets the type of the outline.
 void setProvideWarnings(boolean value)
          sets the provide warning on non-optimal configuarion flag.
 void setTextualMeasuresEnabled(boolean enable)
          Sets whether the Outline supports textual measures or not
 void setVaryingAttributesEnabled(boolean enable)
          Sets whether the Outline supports Slowly Changing / varying attributes or not

 

Field Detail

MAX_ALIAS_TABLES

static final short MAX_ALIAS_TABLES
maximum number of alias tables permitted in an outline.
See Also:
Constant Field Values

MAX_ALIAS_TABLES_TALLEYRAND

static final short MAX_ALIAS_TABLES_TALLEYRAND
See Also:
Constant Field Values

Method Detail

isCaseSensitive

boolean isCaseSensitive()
returns the outline's case sensitive member names flag.

setCaseSensitive

void setCaseSensitive(boolean value)
sets the outline's case sensitive member names flag.

getOutlineType

OutlineType getOutlineType()
returns the type of the outline. Once an outline has been created, this property cannot be changed; therefore, editors should not permit this field to be modified.

setOutlineType

void setOutlineType(OutlineType value)
sets the type of the outline. This method is only provided so that the value of this property can be relayed from the Essbase server to the consumers of the outline. Editors should not display this property as a modifiable property.

isAutoConfigure

boolean isAutoConfigure()
returns the auto configure dimension storage. If this flag is set to true, the server will automatically configure the dense/sparse setting for dimensions when the outline is saved.

setAutoConfigure

void setAutoConfigure(boolean value)
sets the auto configure dimension storage. If this flag is set to true, the server will automatically configure the dense/sparse setting for dimensions when the outline is saved.

getProvideWarnings

boolean getProvideWarnings()
retrieves the provide warnings flag.

setProvideWarnings

void setProvideWarnings(boolean value)
sets the provide warning on non-optimal configuarion flag.

getAliasTables

AliasTable[] getAliasTables()
returns the collection of alias tables for this outline. The first entry will be the default table and cannot be renamed by editors.

setAliasTables

void setAliasTables(AliasTable[] values)
                    throws AliasTableException
sets the collection of alias table for this outline. The first entry must be the default table; if it isn't, an AliasTableException is thrown. An AliasTableException will also be thrown if there are more than the maximum number of alias tables, currently 10. Calling this method with a null value will remove all alias tables except the default one.
Throws:
AliasTableException

addAliasTable

void addAliasTable(AliasTable table)
adds an alias table to this outline.
Parameters:
table - the alias table object to add.
Throws:
AliasTableException - if this would overflow the alias table.

addAliasTable

void addAliasTable(java.lang.String tableName)
                   throws AliasTableException
adds an alias table to this outline.
Parameters:
tableName - name of an alias table to add.
Throws:
AliasTableException - if this would overflow the alias table or if the table name is too long.

isCurrentAliasTable

boolean isCurrentAliasTable(java.lang.String tableName)
determines whether an alias table with a name currently exists.
Parameters:
tableName - name of the table we're interested in.
Returns:
true if the alias table exists; false, otherwise

removeAliasTable

boolean removeAliasTable(AliasTable table)
removes an alias table from this outline.
Parameters:
table - the alias table to remove.
Returns:
true if the table is removed; false otherwise.

removeAliasTable

boolean removeAliasTable(java.lang.String tableName)
removes an alias table from this outline.
Parameters:
tableName - the alias table to remove.
Returns:
true if the table is removed; false otherwise.

renameAliasTable

void renameAliasTable(AliasTable table,
                      java.lang.String tableName)
renames an alias table.
Parameters:
table - alias table object to rename.
tableName - new name for the alias table.
Throws:
AliasTableException - if this is a duplicate name or if the table is the default table.

renameAliasTable

void renameAliasTable(java.lang.String currentName,
                      java.lang.String newName)
renames an alias table.
Parameters:
currentName - the existing name of the alias table.
newName - the new name to use.
Throws:
AliasTableException - if the old name isn't found, the table is the default table, or if the new name is a duplicate name.

isNonUnique

boolean isNonUnique()
Returns whether non-unique names are enabled.
Returns:
false if the outline only allows unique names.

setNonUnique

void setNonUnique(boolean b)
Set whether non unique names are enabled.
Parameters:
btrue - if the outline allows non unique names

isVaryingAttributesEnabled

boolean isVaryingAttributesEnabled()
Returns whether the Outline supports Slowly Changing / varying attributes
Returns:
true if slowly changing attributes are supported

setVaryingAttributesEnabled

void setVaryingAttributesEnabled(boolean enable)
Sets whether the Outline supports Slowly Changing / varying attributes or not

isTextualMeasuresEnabled

boolean isTextualMeasuresEnabled()
Returns whether the Outline supports Textual Measures
Returns:
true if Textual measures are supported

setTextualMeasuresEnabled

void setTextualMeasuresEnabled(boolean enable)
Sets whether the Outline supports textual measures or not

getDateFormat

java.lang.String getDateFormat()
Returns the Date format supported by the outline

setDateFormat

void setDateFormat(java.lang.String format)
Sets the date format supported by the outline

Skip navigation links


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