com.goldencode.p2j.util

Interface EnvironmentReader

All Known Implementing Classes:

FallbackEnvironmentReader, Registry, StanzaIni

public interface EnvironmentReader

Interface describing the methods that should be implemented by the classes that operate with 4GL environment. The environment can be the INI file or registry sections containing the keys.

This is simplified version of the EnvironmentAccessor to have only what is needed on the client side to work with INI files or registry.

Author:

EVL

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_FALLBACK Fallback environment type
static java.lang.String	TYPE_INI Environment type INI file
static java.lang.String	TYPE_REG Environment type registry

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEnvironmentName() Get the environment's name.
java.lang.String	getEnvironmentType() Get the current environment's type.
java.lang.String	getKeyValue(java.lang.String section, java.lang.String key) Getting the key value from the current environment.
boolean	load() Creates application defaults implementing Progress LOAD statement.
void	setKeyValue(java.lang.String section, java.lang.String key, java.lang.String value) Adds, modifies and deletes keys in current environment.
void	unload() Unloads specifies environment from the current one.

Field Detail

TYPE_INI

static final java.lang.String TYPE_INI

Environment type INI file

See Also:

Constant Field Values

TYPE_REG

static final java.lang.String TYPE_REG

Environment type registry

See Also:

Constant Field Values

TYPE_FALLBACK

static final java.lang.String TYPE_FALLBACK

Fallback environment type

See Also:

Constant Field Values

Method Detail

load

boolean load()

Creates application defaults implementing Progress LOAD statement.

Returns:

true if loaded false otherwise

setKeyValue

void setKeyValue(java.lang.String section,
                 java.lang.String key,
                 java.lang.String value)

Adds, modifies and deletes keys in current environment.

Parameters:

section - The name of the section containing the key to modify.

key - The name of the key key to modify or default key if not specified.

value - The new value of the key under modification.

getKeyValue

java.lang.String getKeyValue(java.lang.String section,
                             java.lang.String key)

Getting the key value from the current environment.

Parameters:

section - The name of the section containing the key to get.

key - The name of the key key to get or default key if not specified.

Returns:

The value of the key.

unload

void unload()

Unloads specifies environment from the current one.

getEnvironmentName

java.lang.String getEnvironmentName()

Get the environment's name.

Returns:

See above.

getEnvironmentType

java.lang.String getEnvironmentType()

Get the current environment's type.

Returns:

environment type.