Skip navigation links


com.essbase.eas.essbase.defs.outline
Class DefaultSettings

java.lang.Object
  extended by com.essbase.eas.essbase.defs.outline.DefaultSettings

All Implemented Interfaces:
Settings, java.io.Serializable
Direct Known Subclasses:
UISettings

public class DefaultSettings
extends java.lang.Object
implements Settings, java.io.Serializable

default implementation of a settings interface.

Since:
6.5.1
Version:
7.0.0
Author:
Hank Cox
See Also:
Serialized Form

Field Summary

 

Fields inherited from interface com.essbase.eas.essbase.defs.outline.Settings
MAX_ALIAS_TABLES, MAX_ALIAS_TABLES_TALLEYRAND

 

Constructor Summary
DefaultSettings()
           

 

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 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 the non unique status for the outline
 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 Slowly Changing attributes or not
 void setVaryingAttributesEnabled(boolean enable)
          Sets whether the Outline supports Slowly Changing attributes or not
 void updateFrom(Settings s)
          updates the values in this DefaultSettings object to match a predefined set of values.

 

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

 

Constructor Detail

DefaultSettings

public DefaultSettings()

Method Detail

isCaseSensitive

public boolean isCaseSensitive()
Description copied from interface: Settings
returns the outline's case sensitive member names flag.
Specified by:
isCaseSensitive in interface Settings

setCaseSensitive

public void setCaseSensitive(boolean value)
Description copied from interface: Settings
sets the outline's case sensitive member names flag.
Specified by:
setCaseSensitive in interface Settings

getOutlineType

public OutlineType getOutlineType()
Description copied from interface: Settings
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.
Specified by:
getOutlineType in interface Settings

setOutlineType

public void setOutlineType(OutlineType value)
Description copied from interface: Settings
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.
Specified by:
setOutlineType in interface Settings

isAutoConfigure

public boolean isAutoConfigure()
Description copied from interface: Settings
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.
Specified by:
isAutoConfigure in interface Settings

setAutoConfigure

public void setAutoConfigure(boolean value)
Description copied from interface: Settings
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.
Specified by:
setAutoConfigure in interface Settings

getProvideWarnings

public boolean getProvideWarnings()
Description copied from interface: Settings
retrieves the provide warnings flag.
Specified by:
getProvideWarnings in interface Settings

setProvideWarnings

public void setProvideWarnings(boolean value)
Description copied from interface: Settings
sets the provide warning on non-optimal configuarion flag.
Specified by:
setProvideWarnings in interface Settings

getAliasTables

public AliasTable[] getAliasTables()
Description copied from interface: Settings
returns the collection of alias tables for this outline. The first entry will be the default table and cannot be renamed by editors.
Specified by:
getAliasTables in interface Settings

setAliasTables

public void setAliasTables(AliasTable[] values)
                    throws AliasTableException
Description copied from interface: Settings
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.
Specified by:
setAliasTables in interface Settings
Throws:
AliasTableException

addAliasTable

public void addAliasTable(AliasTable table)
Description copied from interface: Settings
adds an alias table to this outline.
Specified by:
addAliasTable in interface Settings
Parameters:
table - the alias table object to add.

addAliasTable

public void addAliasTable(java.lang.String tableName)
                   throws AliasTableException
Description copied from interface: Settings
adds an alias table to this outline.
Specified by:
addAliasTable in interface Settings
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

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

removeAliasTable

public boolean removeAliasTable(AliasTable table)
Description copied from interface: Settings
removes an alias table from this outline.
Specified by:
removeAliasTable in interface Settings
Parameters:
table - the alias table to remove.
Returns:
true if the table is removed; false otherwise.

removeAliasTable

public boolean removeAliasTable(java.lang.String tableName)
Description copied from interface: Settings
removes an alias table from this outline.
Specified by:
removeAliasTable in interface Settings
Parameters:
tableName - the alias table to remove.
Returns:
true if the table is removed; false otherwise.

renameAliasTable

public void renameAliasTable(AliasTable table,
                             java.lang.String tableName)
Description copied from interface: Settings
renames an alias table.
Specified by:
renameAliasTable in interface Settings
Parameters:
table - alias table object to rename.
tableName - new name for the alias table.

renameAliasTable

public void renameAliasTable(java.lang.String currentName,
                             java.lang.String newName)
Description copied from interface: Settings
renames an alias table.
Specified by:
renameAliasTable in interface Settings
Parameters:
currentName - the existing name of the alias table.
newName - the new name to use.

isNonUnique

public boolean isNonUnique()
Description copied from interface: Settings
Returns whether non-unique names are enabled.
Specified by:
isNonUnique in interface Settings
Returns:
false if the outline only allows unique names.

setNonUnique

public void setNonUnique(boolean b)
Set the non unique status for the outline
Specified by:
setNonUnique in interface Settings
Parameters:
b -

updateFrom

public void updateFrom(Settings s)
updates the values in this DefaultSettings object to match a predefined set of values.

isVaryingAttributesEnabled

public boolean isVaryingAttributesEnabled()
Returns whether the Outline supports Slowly Changing attributes
Specified by:
isVaryingAttributesEnabled in interface Settings
Returns:
true if slowly changing attributes are supported

setVaryingAttributesEnabled

public void setVaryingAttributesEnabled(boolean enable)
Sets whether the Outline supports Slowly Changing attributes or not
Specified by:
setVaryingAttributesEnabled in interface Settings

isTextualMeasuresEnabled

public boolean isTextualMeasuresEnabled()
Returns whether the Outline supports Textual Measures
Specified by:
isTextualMeasuresEnabled in interface Settings
Returns:
true if Textual Measures are supported

setTextualMeasuresEnabled

public void setTextualMeasuresEnabled(boolean enable)
Sets whether the Outline supports Slowly Changing attributes or not
Specified by:
setTextualMeasuresEnabled in interface Settings

getDateFormat

public java.lang.String getDateFormat()
Description copied from interface: Settings
Returns the Date format supported by the outline
Specified by:
getDateFormat in interface Settings

setDateFormat

public void setDateFormat(java.lang.String format)
Description copied from interface: Settings
Sets the date format supported by the outline
Specified by:
setDateFormat in interface Settings

Skip navigation links


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