Package com.appliedolap.essbase.impl

Class EssApplicationConfigurationImpl

java.lang.Object

com.appliedolap.essbase.impl.EssApplicationConfigurationImpl

All Implemented Interfaces:

EssApplicationConfiguration

public class EssApplicationConfigurationImpl
extends Object
implements EssApplicationConfiguration

One configuration key on an application: the catalogue entry describing it, and the value this application gives it if any.

Method Summary

Modifier and Type	Method	Description
void	delete()	Removes this key from the application's configuration, leaving the setting at whatever default Essbase applies.
EssApplication	getApplication()	Gets the application that this configuration item is associated with.
String	getDescription()	What the setting does, in Essbase's own words.
String	getExample()	A filled-in example, e.g.
String	getKey()	Gets the key for this configuration property.
String	getSyntax()	How the setting is written, e.g.
String	getValue()	Gets the value for this configuration property, or null when this application doesn't set it.
boolean	isConfigured()	Whether the application sets this key - which is exactly whether it has a value here, since this is built by merging the catalogue with the application's configurations.
EssApplicationConfiguration	set(String value)	Sets this key on the application, adding it if it wasn't there and replacing the value if it was.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getApplication

public EssApplication getApplication()

Description copied from interface: EssApplicationConfiguration

Gets the application that this configuration item is associated with.

Specified by:

getApplication in interface EssApplicationConfiguration

Returns:

the parent application

getKey

public String getKey()

Description copied from interface: EssApplicationConfiguration

Gets the key for this configuration property.

Specified by:

getKey in interface EssApplicationConfiguration

Returns:

the configuration key name

getValue

public String getValue()

Description copied from interface: EssApplicationConfiguration

Gets the value for this configuration property, or null when this application doesn't set it.

Specified by:

getValue in interface EssApplicationConfiguration

Returns:

the configuration value, or null

getDescription

public String getDescription()

Description copied from interface: EssApplicationConfiguration

What the setting does, in Essbase's own words.

Specified by:

getDescription in interface EssApplicationConfiguration

Returns:

the description, or null for a key not in the server's catalogue

getSyntax

public String getSyntax()

Description copied from interface: EssApplicationConfiguration

How the setting is written, e.g. DATACACHESIZE n or CALCCACHE [dbname] TRUE | FALSE. The square brackets and bars are Essbase's notation, not something to send.

Specified by:

getSyntax in interface EssApplicationConfiguration

Returns:

the syntax, or null

getExample

public String getExample()

Description copied from interface: EssApplicationConfiguration

A filled-in example, e.g. DATACACHESIZE 90M. Worth showing beside the syntax, since the syntax alone rarely settles what a value should look like.

Specified by:

getExample in interface EssApplicationConfiguration

Returns:

the example, or null

isConfigured

public boolean isConfigured()

Whether the application sets this key - which is exactly whether it has a value here, since this is built by merging the catalogue with the application's configurations. See the interface note for why the server's own configured field is not consulted.

Specified by:

isConfigured in interface EssApplicationConfiguration

Returns:

true if this application gives the key a value

set

public EssApplicationConfiguration set(String value)

Description copied from interface: EssApplicationConfiguration

Sets this key on the application, adding it if it wasn't there and replacing the value if it was.

Specified by:

set in interface EssApplicationConfiguration

Parameters:

value - the value, written as EssApplicationConfiguration.getSyntax() describes

Returns:

this setting as the server records it afterwards

delete

public void delete()

Description copied from interface: EssApplicationConfiguration

Removes this key from the application's configuration, leaving the setting at whatever default Essbase applies.

Specified by:

delete in interface EssApplicationConfiguration

toString

public String toString()

Overrides:

toString in class Object