com.highqsoft.fwk

Class FwkPropertyFile

java.lang.Object

java.util.Dictionary<K,V>

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

java.util.Properties

com.highqsoft.fwk.FwkPropertyFile

All Implemented Interfaces:

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

Direct Known Subclasses:

FwkPropertyGroup

public class FwkPropertyFile
extends java.util.Properties
implements FwkInterface, java.util.Map<java.lang.Object,java.lang.Object>

The FwkPropertyFile object implements the access to the properties.

The properties can deliver different types of objects. The following types are defined:

Type	Classname	Default value
String	java.lang.String	null
Long	java.lang.Long	0
Double	java.lang.Double	0.0
Font	java.awt.Font	null
Color	java.awt.Color	null

The class determines the name of the node and the username. The properties which are stored get the prefix [node].[username].[type].key. The search order of the keys is:

1.	node.username.type.key
2.	username.type.key
3.	node.type.key
4.	type.key
5.	key

If the key isn't found null is returned for objects and the value 0 is returned otherwise.

The resource files will be loaded in following order. If one step loads the file successfully it stops the chain.

as file	FwkContainer.getSystemProperty(resource+".Properties")
as URL	FwkContainer.getSystemProperty(resource+".Properties")
as file	PropertyBus.getProperty(resource+".Properties")
as URL	PropertyBus.getProperty(resource+".Properties")
as file	resource+".properties_de_DE"
as URL	ClassLocation/resource+".properties_de_DE"
as file	resource+".properties"
as file	resource+".properties_de"
as file	resource+".properties_DE"
as URL	ClassLocation/resource+".properties"
as URL	ClassLocation/resource+".properties_de"
as URL	ClassLocation/resource+".properties_DE"

Since:

$Date: 2017/04/28 08:47:41 $

Version:

$Revision: 1.17 $

Author:

Karst Schaap, HighQSoft GmbH, Andreas Hofmann

See Also:

, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	version

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
FwkPropertyFile()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String[]	createKeys(java.lang.String key) Create a list with possible keys.
protected java.lang.String[]	createKeys(java.lang.String type, java.lang.String key) Create a list with possible keys.
protected java.lang.String	createUserKey(java.lang.String key) Create a user key.
protected java.lang.String	createUserKey(java.lang.String type, java.lang.String key) Create a user key.
boolean	fileLoad(java.lang.String filename, java.lang.ClassLoader loader) Reads a property list (key and element pairs) from the input stream.
protected java.lang.ClassLoader	getClassLoader(java.lang.Class clazz)
FwkArrayInterface	getFwkMimeTypes()
protected java.io.InputStream	getInputStream(java.lang.String filename, java.lang.ClassLoader classLoader)
java.lang.Object	getObject(java.lang.String key) Get an object for the property key.
java.lang.Object	getObject(java.lang.String type, java.lang.String key) Get an object for the property key.
java.lang.String	getParams() This function returns a string containing all parameters of the object.
java.lang.String	getVersion() Return the version string of the FWK component.
boolean	load(java.lang.String filename) Reads a property list (key and element pairs) from the input stream.
boolean	load(java.lang.String resource, java.lang.Class clazz) Reads a property list (key and element pairs) from the input stream.
boolean	load(java.lang.String resource, java.lang.String className, java.lang.ClassLoader loader) Reads a property list (key and element pairs) from the input stream.
boolean	load(java.net.URL url) Reads a property list (key and element pairs) from the input stream.
void	release() Release the object.
protected java.lang.Object	searchForProperty(java.lang.String[] keyList) Search for the property.
java.lang.String	toString() Get the string representation of the object.
boolean	urlLoad(java.lang.String urlString) Reads a property list (key and element pairs) from the input stream.

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

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

Constructor Detail

FwkPropertyFile

public FwkPropertyFile()

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

getFwkMimeTypes

public FwkArrayInterface getFwkMimeTypes()

release

public void release()

Release the object.

Specified by:

release in interface FwkInterface

createKeys

protected java.lang.String[] createKeys(java.lang.String key)

Create a list with possible keys. The keys are store in the search order given above.

Parameters:

key - The key (type is a part of the key).

Returns:

A list with the possible search keys.

createKeys

protected java.lang.String[] createKeys(java.lang.String type,
                            java.lang.String key)

Create a list with possible keys. The keys are stored in the search order given above.

Parameters:

type - The type of the key.

key - The key.

Returns:

A list with the possible search keys.

createUserKey

protected java.lang.String createUserKey(java.lang.String type,
                             java.lang.String key)

Create a user key.

Parameters:

type - The type of the key.

key - The key.

Returns:

The user key.

createUserKey

protected java.lang.String createUserKey(java.lang.String key)

Create a user key. Expect the type as a part of the key.

Parameters:

key - The key.

Returns:

The user key.

getParams

public java.lang.String getParams()

This function returns a string containing all parameters of the object.

Returns:

The string representation of the parameters of the object.

getObject

public java.lang.Object getObject(java.lang.String key)

Get an object for the property key. The object is delivered as an 'untyped' object, the calling application only knows the type of the object.

Parameters:

key - The key of the propery.

Returns:

The value of the property of the type the object is stored. If the property not exist the key is returned.

getObject

public java.lang.Object getObject(java.lang.String type,
                         java.lang.String key)

Get an object for the property key.

Parameters:

type - The type of the object.

key - The key of the propery.

Returns:

The value of the property. If the property not exist the key is returned.

getClassLoader

protected java.lang.ClassLoader getClassLoader(java.lang.Class clazz)

getInputStream

protected java.io.InputStream getInputStream(java.lang.String filename,
                                 java.lang.ClassLoader classLoader)

load

public boolean load(java.lang.String resource,
           java.lang.Class clazz)

Reads a property list (key and element pairs) from the input stream. Each property occupies one line in the input stream. Each line is terminated by a line terminator (\n or \r or \r\n). Lines from the input stream are processed until end of file is reached. The method tries to load the properties in the following order (xx = language, YY = country):
file: .properties_xx_YY
URL: .properties_xx_YY
file: .properties_xx
file: .properties_YY
file: .properties
URL: .properties_xx
URL: .properties_YY
URL: .properties

Parameters:

resource - Name of the property resource.

clazz - The class to determine the class loader. Could be null.

Returns:

true if properties have been loaded.

fileLoad

public boolean fileLoad(java.lang.String filename,
               java.lang.ClassLoader loader)

Reads a property list (key and element pairs) from the input stream. Every property occupies one line of the input stream. Each line is terminated by a line terminator (\n or \r or \r\n). Lines from the input stream are processed until end of file is reached on the input stream.

Parameters:

filename - Name of the property file.

loader - The class loadler. Could be null.

Returns:

true if the property file was loaded.

urlLoad

public boolean urlLoad(java.lang.String urlString)

Reads a property list (key and element pairs) from the input stream. Every property occupies one line of the input stream. Each line is terminated by a line terminator (\n or \r or \r\n). Lines from the input stream are processed until end of file is reached on the input stream.

Parameters:

urlString - Name of the property file.

Returns:

true if the property file was loaded.

load

public boolean load(java.lang.String resource,
           java.lang.String className,
           java.lang.ClassLoader loader)

Reads a property list (key and element pairs) from the input stream. Each property occupies one line in the input stream. Each line is terminated by a line terminator (\n or \r or \r\n). Lines from the input stream are processed until end of file is reached. The method tries to load the properties in the following order (xx = language, YY = country):
file: .properties_xx_YY
URL: .properties_xx_YY
file: .properties_xx
file: .properties_YY
file: .properties
URL: .properties_xx
URL: .properties_YY
URL: .properties

Parameters:

resource - Name of the property resource.

className - The name of the class.

loader - The class loader. Could be null.

Returns:

true if properties have been loaded.

load

public boolean load(java.lang.String filename)

Reads a property list (key and element pairs) from the input stream. Every property occupies one line of the input stream. Each line is terminated by a line terminator (\n or \r or \r\n). Lines from the input stream are processed until end of file is reached on the input stream.

Parameters:

filename - Name of the property file.

Returns:

true if successful.

load

public boolean load(java.net.URL url)

Reads a property list (key and element pairs) from the input stream. Every property occupies one line of the input stream. Each line is terminated by a line terminator (\n or \r or \r\n). Lines from the input stream are processed until end of file is reached on the input stream.

Parameters:

url - Name of the property url.

Returns:

true if successful.

searchForProperty

protected java.lang.Object searchForProperty(java.lang.String[] keyList)

Search for the property.

Parameters:

keyList - The list with the keys in the search order.

Returns:

The found property.

toString

public java.lang.String toString()

Get the string representation of the object.

Overrides:

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

Returns:

The string representation of the object.