org.trianacode.config

Class TrianaProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

org.trianacode.config.TrianaProperties

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class TrianaProperties
extends java.util.Properties

The TrianaProperties class stores the properties for a Triana instance. Triana properties are propagated through all the relevant Triana classes so that oneset of properties can be used per triana instance. TrianaProperties also contains a default configuration that is packaged with Triana as shipped. These properties can be altered by any third party application to configure the look and feel and locations for the various toolboxes, templates etc.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHECKBOX_TEMPLATE_PROPERTY
static java.lang.String	CREATE_TOOL_INSTANCE_PROPERTY
static java.lang.String	DEFAULT_COMMENTS
static java.lang.String	DOMAIN
static java.lang.String	FOOTER_TEMPLATE_PROPERTY
static java.lang.String	FORM_TEMPLATE_PROPERTY
static java.lang.String	HEADER_TEMPLATE_PROPERTY
static java.lang.String	LOG_LOCATION
static java.lang.String	LOG_TO_RABBITMQ
static java.lang.String	LOGGING_INPUT_VALUES
static java.lang.String	MODULE_SEARCH_PATH_PROPERTY
static java.lang.String	NOHELP_TEMPLATE_PROPERTY
static java.lang.String	PROPERTY_FILE_LIST_PROPERTY
static java.lang.String	PROPERTY_SEARCH_PATH_PROPERTY
static java.lang.String	TEMPLATE_SEARCH_PATH_PROPERTY
static java.lang.String	TOOL_COMPLETED_TEMPLATE_PROPERTY
static java.lang.String	TOOL_CP_HTML_TEMPLATE_PROPERTY
static java.lang.String	TOOL_CP_XML_TEMPLATE_PROPERTY
static java.lang.String	TOOL_DESCRIPTION_TEMPLATE_PROPERTY
static java.lang.String	TOOL_HELP_TEMPLATE_PROPERTY
static java.lang.String	TOOL_INSTANCE_PROPERTY
static java.lang.String	TOOL_PARAMETER_WINDOW_TEMPLATE_PROPERTY
static java.lang.String	TOOLBOX_DESCRIPTION_TEMPLATE_PROPERTY
static java.lang.String	TOOLBOX_SEARCH_PATH_PROPERTY
static java.lang.String	TOOLBOXES_DESCRIPTION_TEMPLATE_PROPERTY
static java.lang.String	TOOLS_DESCRIPTION_TEMPLATE_PROPERTY
static java.lang.String	TRIANA_TEMPLATE_PROPERTY
static java.lang.String	VERSION
static java.lang.String	WEB_TEMPLATE_PROPERTY
static java.lang.String	WEB_TOOL_TEMPLATE_PROPERTY

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
TrianaProperties(TrianaInstance engine)
TrianaProperties(TrianaInstance engine, java.util.Properties initValues) Initialises the properties giving the defaults

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Properties	getDefaultConfiguration()
TrianaInstance	getEngine()
void	overrideUsingSystemProperties()
void	saveProperties() Saves the current properties to App_Dir/org.trianacode.properties
void	saveProperties(java.lang.String comments) Saves the properties to the default config file
java.lang.String	toString() Creates a string version of the current property configuration

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_COMMENTS

public static java.lang.String DEFAULT_COMMENTS

DOMAIN

public static java.lang.String DOMAIN

VERSION

public static java.lang.String VERSION

PROPERTY_SEARCH_PATH_PROPERTY

public static final java.lang.String PROPERTY_SEARCH_PATH_PROPERTY

TOOLBOX_SEARCH_PATH_PROPERTY

public static final java.lang.String TOOLBOX_SEARCH_PATH_PROPERTY

MODULE_SEARCH_PATH_PROPERTY

public static final java.lang.String MODULE_SEARCH_PATH_PROPERTY

LOG_LOCATION

public static final java.lang.String LOG_LOCATION

LOGGING_INPUT_VALUES

public static final java.lang.String LOGGING_INPUT_VALUES

LOG_TO_RABBITMQ

public static final java.lang.String LOG_TO_RABBITMQ

TEMPLATE_SEARCH_PATH_PROPERTY

public static final java.lang.String TEMPLATE_SEARCH_PATH_PROPERTY

PROPERTY_FILE_LIST_PROPERTY

public static final java.lang.String PROPERTY_FILE_LIST_PROPERTY

TOOLBOXES_DESCRIPTION_TEMPLATE_PROPERTY

public static final java.lang.String TOOLBOXES_DESCRIPTION_TEMPLATE_PROPERTY

TOOLS_DESCRIPTION_TEMPLATE_PROPERTY

public static final java.lang.String TOOLS_DESCRIPTION_TEMPLATE_PROPERTY

TOOLBOX_DESCRIPTION_TEMPLATE_PROPERTY

public static final java.lang.String TOOLBOX_DESCRIPTION_TEMPLATE_PROPERTY

TOOL_DESCRIPTION_TEMPLATE_PROPERTY

public static final java.lang.String TOOL_DESCRIPTION_TEMPLATE_PROPERTY

CREATE_TOOL_INSTANCE_PROPERTY

public static final java.lang.String CREATE_TOOL_INSTANCE_PROPERTY

TOOL_INSTANCE_PROPERTY

public static final java.lang.String TOOL_INSTANCE_PROPERTY

TOOL_PARAMETER_WINDOW_TEMPLATE_PROPERTY

public static final java.lang.String TOOL_PARAMETER_WINDOW_TEMPLATE_PROPERTY

FORM_TEMPLATE_PROPERTY

public static final java.lang.String FORM_TEMPLATE_PROPERTY

CHECKBOX_TEMPLATE_PROPERTY

public static final java.lang.String CHECKBOX_TEMPLATE_PROPERTY

TOOL_COMPLETED_TEMPLATE_PROPERTY

public static final java.lang.String TOOL_COMPLETED_TEMPLATE_PROPERTY

TRIANA_TEMPLATE_PROPERTY

public static final java.lang.String TRIANA_TEMPLATE_PROPERTY

HEADER_TEMPLATE_PROPERTY

public static final java.lang.String HEADER_TEMPLATE_PROPERTY

FOOTER_TEMPLATE_PROPERTY

public static final java.lang.String FOOTER_TEMPLATE_PROPERTY

NOHELP_TEMPLATE_PROPERTY

public static final java.lang.String NOHELP_TEMPLATE_PROPERTY

TOOL_CP_XML_TEMPLATE_PROPERTY

public static final java.lang.String TOOL_CP_XML_TEMPLATE_PROPERTY

TOOL_CP_HTML_TEMPLATE_PROPERTY

public static final java.lang.String TOOL_CP_HTML_TEMPLATE_PROPERTY

WEB_TEMPLATE_PROPERTY

public static final java.lang.String WEB_TEMPLATE_PROPERTY

WEB_TOOL_TEMPLATE_PROPERTY

public static final java.lang.String WEB_TOOL_TEMPLATE_PROPERTY

TOOL_HELP_TEMPLATE_PROPERTY

public static final java.lang.String TOOL_HELP_TEMPLATE_PROPERTY

Constructor Detail

TrianaProperties

public TrianaProperties(TrianaInstance engine)

TrianaProperties

public TrianaProperties(TrianaInstance engine,
                java.util.Properties initValues)

Initialises the properties giving the defaults

Parameters:

initValues -

Method Detail

overrideUsingSystemProperties

public void overrideUsingSystemProperties()

getDefaultConfiguration

public static java.util.Properties getDefaultConfiguration()

toString

public java.lang.String toString()

Creates a string version of the current property configuration

Overrides:

toString in class java.util.Hashtable<java.lang.Object,java.lang.Object>

Returns:

a String of the properties.

saveProperties

public void saveProperties()
                    throws java.io.IOException

Saves the current properties to App_Dir/org.trianacode.properties

Throws:

java.io.IOException

saveProperties

public void saveProperties(java.lang.String comments)
                    throws java.io.IOException

Saves the properties to the default config file

Throws:

java.io.IOException

getEngine

public TrianaInstance getEngine()