com.highqsoft.fwk

Class FwkPropertyGroup

java.lang.Object

java.util.Dictionary<K,V>

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

java.util.Properties

com.highqsoft.fwk.FwkPropertyFile

com.highqsoft.fwk.FwkPropertyGroup

All Implemented Interfaces:

FwkDescriptionInterface, FwkDOMHandlerInterface, FwkInterface, FwkPropertyGroupInterface, FwkTransferableInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class FwkPropertyGroup
extends FwkPropertyFile
implements FwkPropertyGroupInterface

The FwkPropertyGroupFile class.

Example of a PropertyGroup File.

 BEGIN FwkContainer
    LookAndFeel = Windows

    BEGIN Text
       About = Über
       Open = Öffnen

       BEGIN Error
           Open = Konnte Datei nicht öffnen
           Read = Konnte Datei nicht lesen
       END
    END
 END

 AsamCommander.Text.Connect = Verbinden
 // Comments are possible.
 /*
    The last entry leads to:
    BEGIN AsamCommander
       BEGIN Text
           Connect = Verbinden
       END
    END
 */

 

The FwkPropertyGroup has the following features:

• Reading of the normal Property file. The property keyword will be split at a dot and will be ordered hierachycally.
• Reading of a hiearchy PropertyFile (s.a.)
• Reading of XML files.
• Reading of Windows INI files.
• Writing of hierachy PropertyFiles (s.a.)
• Writing of XML files.
• Fileformats will be detected automatically except XML files.
• Hierarchy PropertyFiles contents can be mixed with normal ProperyFile contents (s.a.).
• Getting property group. E.g. FwkContainer in the example above.
• One keyword access is possible. E.g. FwkContainer.Text.Open in the example above.

Since:

$Date: 2017/04/06 13:29:02 $

Version:

$Revision: 1.20 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FwkPropertyGroup.SectionInputStream

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BEGIN
protected static java.lang.String	COMMENT_CHARS
protected static java.lang.String	END
static java.lang.String	version

Fields inherited from class java.util.Properties

defaults

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Constructor Summary

Constructors

Constructor and Description
FwkPropertyGroup() The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
FwkPropertyGroupInterface	addGroup(java.lang.String name, FwkPropertyGroupInterface newGroup) Add a property group.
java.lang.Object	clone() Clone the object.
java.lang.String	getAuthor() Get the author name.
java.lang.String	getBuild() Get the build number.
java.lang.String	getClassName() Get the class name of the FWK object.
java.lang.String	getCompany() Get the company name.
java.lang.String	getCompanyInternetAddress() Get the internet address of the company.
java.lang.String	getCopyright() Get the copyright.
java.lang.String	getCreationDate() Get the creation date.
java.lang.String	getCreationDate(java.lang.String formatString) Get the creation date.
java.lang.String	getDateFormatString() Get the date format string.
java.lang.String	getDescription() Get the description.
FwkPropertyGroupInterface	getGroup(java.lang.String name) Get a group.
FwkIconInterface	getIcon() Get the icon image.
FwkIconInterface	getIcon(int type) Get the image icon of the application
java.lang.String	getIconKey() Get the property keyword of the icon.
java.lang.String	getIconKey(int type) Get the property keyword of the icon.
java.lang.String	getName() Return the name of the ASAM-FWK object.
java.lang.String	getPresentationString() Retrieves the representation string.
java.lang.String	getPresentationString(java.util.Locale locale) Retrieves the representation string.
java.lang.String	getProperty(java.lang.String key) Get the property with the requested name.
boolean	getProperty(java.lang.String key, boolean dflt) Get the property.
byte	getProperty(java.lang.String key, byte dflt) Get the property.
char	getProperty(java.lang.String key, char dflt) Get the property.
java.lang.Object	getProperty(java.lang.String propertyName, java.awt.datatransfer.DataFlavor flavor) Get the property with the requested name.
double	getProperty(java.lang.String key, double dflt) Get the property.
float	getProperty(java.lang.String key, float dflt) Get the property.
int	getProperty(java.lang.String key, int dflt) Get the property.
long	getProperty(java.lang.String key, long dflt) Get the property.
java.lang.Object	getProperty(java.lang.String groupKey, java.lang.Object defaultValue) Get the property with the requested name.
short	getProperty(java.lang.String key, short dflt) Get the property.
java.lang.String	getProperty(java.lang.String groupKey, java.lang.String defaultValue) Get the property with the requested name.
boolean	getProperty(java.lang.String group, java.lang.String propertyName, boolean propertyDefault) Get a property with default.
byte	getProperty(java.lang.String group, java.lang.String propertyName, byte propertyDefault) Get a property with default.
char	getProperty(java.lang.String group, java.lang.String propertyName, char propertyDefault) Get a property with default.
java.lang.Object	getProperty(java.lang.String group, java.lang.String propertyName, java.awt.datatransfer.DataFlavor flavor) Get the property with the requested name.
double	getProperty(java.lang.String group, java.lang.String propertyName, double propertyDefault) Get a property with default.
float	getProperty(java.lang.String group, java.lang.String propertyName, float propertyDefault) Get a property with default.
int	getProperty(java.lang.String group, java.lang.String propertyName, int propertyDefault) Get a property with default.
long	getProperty(java.lang.String group, java.lang.String propertyName, long propertyDefault) Get a property with default.
java.lang.Object	getProperty(java.lang.String group, java.lang.String propertyName, java.lang.Object propertyDefault) Get a property with default.
short	getProperty(java.lang.String group, java.lang.String propertyName, short propertyDefault) Get a property with default.
java.lang.String	getProperty(java.lang.String group, java.lang.String propertyName, java.lang.String propertyDefault) Get a property with default.
FwkPropertyGroupInterface	getPropertyGroup(java.lang.String name) Get a property group.
java.lang.String	getSupportEMail() Get the support e-mail.
java.lang.String	getTitle() Get the title.
java.lang.String	getTitleName() Get the title name.
java.lang.Object	getTransferData(java.awt.datatransfer.DataFlavor flavor) Returns an object which represents the data to be transferred.
java.awt.datatransfer.DataFlavor[]	getTransferDataFlavors() Returns an array of DataFlavor objects indicating the flavors the data can be provided in.
java.lang.String	getVersion() Return the version string of the FWK component.
java.util.Enumeration	groupNames() Return an enumeration of the group names.
boolean	isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor) Returns whether or not the specified data flavor is supported for this object.
void	list(java.io.PrintStream out) Prints this property list out to the specified output stream.
void	list(java.io.PrintWriter out) Prints this property list out to the specified output stream.
void	list(java.io.PrintWriter out, java.lang.String prefix) Prints this property list out to the specified output stream.
void	load(java.io.InputStream inStream) Load the properties from input stream.
boolean	load(java.lang.String resource) Load the property group from file or resource.
void	lostOwnership(java.awt.datatransfer.Clipboard clipboard, java.awt.datatransfer.Transferable contents) Notifies this object that it is no longer the owner of the contents of the clipboard.
static void	main(java.lang.String[] args)
java.util.Enumeration	propertyNames() Return en enumeration of the property names.
java.lang.Object	put(java.lang.Object key, java.lang.Object value) Put a property value into the map.
java.lang.Object	put(java.lang.String group, java.util.Map values) Put a property group.
static FwkPropertyGroupInterface	read(java.io.File file, FwkPropertyGroupInterface ret) Read the property group file.
static FwkPropertyGroupInterface	read(java.io.InputStream is, FwkPropertyGroupInterface ret) Read the property group file.
static FwkPropertyGroupInterface	read(java.io.Reader reader, FwkPropertyGroupInterface ret) Read the property group file.
static FwkPropertyGroupInterface	read(java.lang.String spec, FwkPropertyGroupInterface ret) Read the property group file.
static FwkPropertyGroupInterface	read(java.net.URL url, FwkPropertyGroupInterface ret) Read the property group file.
java.lang.Object	readConstructor(org.w3c.dom.Document document, org.w3c.dom.Element node) Read a construtor dom node.
void	readFromDOM(org.w3c.dom.Document doc, org.w3c.dom.Element element) Read from DOM
boolean	readingDOM() Get the DOM reading flag.
void	readingDOM(boolean flag) Set a flag that the object is currently reading the DOM.
protected static boolean	readNextSection(FwkPropertyGroupInterface parent, java.io.BufferedReader in, java.lang.String sectionName)
FwkPropertyGroupInterface	removeGroup(java.lang.String name) Remove a property group.
boolean	save(java.lang.String resource) Save the property group from file or resource.
void	setAuthor(java.lang.String author) Set the author name.
void	setBuild(java.lang.String buildnr) Set the build number.
void	setClassName(java.lang.String className) Set the class name of the FWK object.
void	setCompany(java.lang.String company) Set the company name.
void	setCompanyInternetAddress(java.lang.String address) Set the internet address of the company.
void	setCopyright(java.lang.String copyright) Set the copyright.
void	setCreationDate(java.lang.String dateString) Set the Date of the application.
void	setCreationDate(java.lang.String dateString, java.lang.String formatString) Set the Date of the application.
void	setDateFormatString(java.lang.String formatString) Set the Date format string.
void	setDescription(java.lang.String description) Set the description of the application.
void	setDescriptor(FwkDescriptionInterface descriptor) Initialize the object with values of the given FwkDescription.
void	setIcon(FwkIconInterface icon) Set the icon image.
void	setIcon(FwkIconInterface icon, int type) Set the image icon of the application
void	setIconKey(java.lang.String key) Set the property keyword of the icon.
void	setIconKey(java.lang.String key, int type) Set the property keyword of the icon.
void	setName(java.lang.String name) Set the name of the ASAM-FWK object.
java.lang.Object	setProperty(java.lang.String key, boolean value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, byte value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, char value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, double value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, float value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, int value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, long value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, short value) Set a property value.
java.lang.Object	setProperty(java.lang.String key, java.lang.String value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, boolean value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, byte value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, char value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, double value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, float value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, int value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, long value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, short value) Set a property value.
java.lang.Object	setProperty(java.lang.String groupKey, java.lang.String key, java.lang.String value) Set a property value.
void	setSupportEMail(java.lang.String eMail) Get the support e-mail.
void	setTitleName(java.lang.String titleName) Set the title of the application.
void	store(java.io.OutputStream out, java.lang.String header) Write the group to the output stream.
java.lang.String	toString() Get a string representation of the object.
org.w3c.dom.Element	writeConstructor(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties) Write a construtor dom node.
org.w3c.dom.Element	writeMapToDOM(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Element node, java.util.Map classProperties) This method writes a map of the given object to DOM.
org.w3c.dom.Element	writeToDOM(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties) Write the container as child to the given DOM node.
boolean	writeToXML(java.lang.String filename, boolean validate) Writes the canvas to an XML file.

Methods inherited from class com.highqsoft.fwk.FwkPropertyFile

createKeys, createKeys, createUserKey, createUserKey, fileLoad, getClassLoader, getFwkMimeTypes, getInputStream, getObject, getObject, getParams, load, load, load, release, searchForProperty, urlLoad

Methods inherited from class java.util.Properties

load, loadFromXML, save, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, 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, putAll, remove, size, values

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

release

Field Detail

BEGIN

protected static final java.lang.String BEGIN

See Also:

Constant Field Values

END

protected static final java.lang.String END

See Also:

Constant Field Values

COMMENT_CHARS

protected static final java.lang.String COMMENT_CHARS

See Also:

Constant Field Values

version

public static final java.lang.String version

See Also:

Constant Field Values

Constructor Detail

FwkPropertyGroup

public FwkPropertyGroup()

The constructor.

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

Overrides:

getVersion in class FwkPropertyFile

clone

public java.lang.Object clone()

Clone the object.

Specified by:

clone in interface FwkPropertyGroupInterface

Overrides:

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

getProperty

public java.lang.Object getProperty(java.lang.String group,
                           java.lang.String propertyName,
                           java.awt.datatransfer.DataFlavor flavor)

Get the property with the requested name.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

group - The group of the property.

propertyName - The requested property name.

mimeType - The requested mime type.

Returns:

The requested property.

getProperty

public java.lang.Object getProperty(java.lang.String propertyName,
                           java.awt.datatransfer.DataFlavor flavor)

Get the property with the requested name.

Parameters:

propertyName - The requested property name.

mimeType - The requested mime type.

Returns:

The requested property.

getProperty

public java.lang.Object getProperty(java.lang.String groupKey,
                           java.lang.Object defaultValue)

Get the property with the requested name.
The first of all the method tries to get the group and return the property of the group. If the group or the property is not available the method tries to seperate a group key from the first parameter assuming that the group key is separated by a dot. Then it tries to get the the property by calling the mehtod getProperty(groupName, propKey, defaultValue) where the defaultValue is the second parameter of this call.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

groupKey - The name of the group.

defaultValue - The requested property name.

Returns:

The requested property.

getProperty

public java.lang.String getProperty(java.lang.String groupKey,
                           java.lang.String defaultValue)

Get the property with the requested name.
The first of all the method tries to get the group and return the property of the group. If the group or the property is not available the method tries to seperate a group key from the first parameter assuming that the group key is separated by a dot. Then it tries to get the the property by calling the mehtod getProperty(groupName, propKey, defaultValue) where the defaultValue is the second parameter of this call.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Overrides:

getProperty in class java.util.Properties

Parameters:

groupKey - The name of the group.

defaultValue - The requested property name.

Returns:

The requested property.

getProperty

public boolean getProperty(java.lang.String key,
                  boolean dflt)

Get the property.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

public int getProperty(java.lang.String key,
              int dflt)

Get the property.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

key - The name of the group.

dflt - The default value.

Returns:

The requested property.

getProperty

public short getProperty(java.lang.String key,
                short dflt)

Get the property.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

public byte getProperty(java.lang.String key,
               byte dflt)

Get the property.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

public char getProperty(java.lang.String key,
               char dflt)

Get the property.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

public long getProperty(java.lang.String key,
               long dflt)

Get the property.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

public float getProperty(java.lang.String key,
                float dflt)

Get the property.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

public double getProperty(java.lang.String key,
                 double dflt)

Get the property.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

key - The name of the property. The group name must be separated by a dot from group property name.

dflt - The default value.

Returns:

The requested property.

getProperty

public java.lang.String getProperty(java.lang.String key)

Get the property with the requested name.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Overrides:

getProperty in class java.util.Properties

Parameters:

propertyName - The requested property name.

Returns:

The requested property.

setProperty

public java.lang.Object setProperty(java.lang.String key,
                           java.lang.String value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Overrides:

setProperty in class java.util.Properties

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String key,
                           boolean value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String key,
                           int value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String key,
                           short value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String key,
                           byte value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String key,
                           char value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String key,
                           long value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String key,
                           float value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String key,
                           double value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           java.lang.String value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           boolean value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           int value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           short value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           byte value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           char value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           long value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           float value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

setProperty

public java.lang.Object setProperty(java.lang.String groupKey,
                           java.lang.String key,
                           double value)

Set a property value.

Specified by:

setProperty in interface FwkPropertyGroupInterface

Parameters:

groupKey - - The name of the group.

key - - the key to be placed into this property list.

value - - the value corresponding to key.

getProperty

public boolean getProperty(java.lang.String group,
                  java.lang.String propertyName,
                  boolean propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public int getProperty(java.lang.String group,
              java.lang.String propertyName,
              int propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public short getProperty(java.lang.String group,
                java.lang.String propertyName,
                short propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public byte getProperty(java.lang.String group,
               java.lang.String propertyName,
               byte propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public char getProperty(java.lang.String group,
               java.lang.String propertyName,
               char propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public long getProperty(java.lang.String group,
               java.lang.String propertyName,
               long propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public float getProperty(java.lang.String group,
                java.lang.String propertyName,
                float propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public double getProperty(java.lang.String group,
                 java.lang.String propertyName,
                 double propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public java.lang.String getProperty(java.lang.String group,
                           java.lang.String propertyName,
                           java.lang.String propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getProperty

public java.lang.Object getProperty(java.lang.String group,
                           java.lang.String propertyName,
                           java.lang.Object propertyDefault)

Get a property with default. If the requested property can not be found on the property bus the default value is returned. This is a convienience function to avoid tedious error checking in the calling method.

Specified by:

getProperty in interface FwkPropertyGroupInterface

Parameters:

group - The name of the group.

propertyName - The name of the property.

propertyDefault - The default property.

Returns:

The requested property or it's default.

getPropertyGroup

public FwkPropertyGroupInterface getPropertyGroup(java.lang.String name)

Get a property group.

Specified by:

getPropertyGroup in interface FwkPropertyGroupInterface

Parameters:

name - the name of the property group.

Returns:

the requested group or null

addGroup

public FwkPropertyGroupInterface addGroup(java.lang.String name,
                                 FwkPropertyGroupInterface newGroup)

Add a property group.

Specified by:

addGroup in interface FwkPropertyGroupInterface

Parameters:

name - the name of the property group.

newGroup - The group to be added.

Returns:

the newly created or expanded group or null if not possible.

removeGroup

public FwkPropertyGroupInterface removeGroup(java.lang.String name)

Remove a property group.

Specified by:

removeGroup in interface FwkPropertyGroupInterface

Parameters:

name - the name of the property group.

Returns:

the removed group or null if not found

list

public void list(java.io.PrintStream out)

Prints this property list out to the specified output stream. This method is useful for debugging.

Specified by:

list in interface FwkPropertyGroupInterface

Overrides:

list in class java.util.Properties

Parameters:

out - an output stream.

list

public void list(java.io.PrintWriter out)

Prints this property list out to the specified output stream. This method is useful for debugging.

Specified by:

list in interface FwkPropertyGroupInterface

Overrides:

list in class java.util.Properties

Parameters:

out - an output stream.

list

public void list(java.io.PrintWriter out,
        java.lang.String prefix)

Prints this property list out to the specified output stream. This method is useful for debugging.

Specified by:

list in interface FwkPropertyGroupInterface

Parameters:

out - an output stream.

prefix - a line prefix for output.

store

public void store(java.io.OutputStream out,
         java.lang.String header)
           throws java.io.IOException

Write the group to the output stream.

Overrides:

store in class java.util.Properties

Throws:

java.io.IOException

groupNames

public java.util.Enumeration groupNames()

Return an enumeration of the group names.

Specified by:

groupNames in interface FwkPropertyGroupInterface

Returns:

the enumeration.

propertyNames

public java.util.Enumeration propertyNames()

Return en enumeration of the property names.

Specified by:

propertyNames in interface FwkPropertyGroupInterface

Overrides:

propertyNames in class java.util.Properties

Returns:

the enumeration.

load

public boolean load(java.lang.String resource)

Load the property group from file or resource.

Specified by:

load in interface FwkPropertyGroupInterface

Overrides:

load in class FwkPropertyFile

Parameters:

resource - The resource or filename.

Returns:

true if successful.

save

public boolean save(java.lang.String resource)

Save the property group from file or resource.

Specified by:

save in interface FwkPropertyGroupInterface

Parameters:

resource - The resource or filename.

Returns:

true if successful.

load

public void load(java.io.InputStream inStream)

Load the properties from input stream.

Overrides:

load in class java.util.Properties

Parameters:

inStream - the input stream.

read

public static FwkPropertyGroupInterface read(java.lang.String spec,
                             FwkPropertyGroupInterface ret)

Read the property group file.

Parameters:

spec - the url or file spec to be read.

group - The group to that the value should be append. If null the method creates and returns a new one.

read

public static FwkPropertyGroupInterface read(java.io.File file,
                             FwkPropertyGroupInterface ret)

Read the property group file.

Parameters:

file - the file to be read.

group - The group to that the value should be append. If null the method creates and returns a new one.

getGroup

public FwkPropertyGroupInterface getGroup(java.lang.String name)

Get a group.

Specified by:

getGroup in interface FwkPropertyGroupInterface

Parameters:

name - the name of the group.

Returns:

the group or null

put

public java.lang.Object put(java.lang.String group,
                   java.util.Map values)

Put a property group.

Parameters:

group - The property group.

values - the properties of the group.

put

public java.lang.Object put(java.lang.Object key,
                   java.lang.Object value)

Put a property value into the map.

Specified by:

put in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

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

Parameters:

key - The key including the group separated by dot.

value - The value.

readConstructor

public java.lang.Object readConstructor(org.w3c.dom.Document document,
                               org.w3c.dom.Element node)

Read a construtor dom node.

Specified by:

readConstructor in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

dtd - The dtd descriptor.

node - The node.

classProperties - Map the contains the writable object properties. May be null.

readFromDOM

public void readFromDOM(org.w3c.dom.Document doc,
               org.w3c.dom.Element element)

Read from DOM

Specified by:

readFromDOM in interface FwkDOMHandlerInterface

writeConstructor

public org.w3c.dom.Element writeConstructor(org.w3c.dom.Document document,
                                   FwkXmlDtdInterface dtd,
                                   org.w3c.dom.Node node,
                                   java.util.Map classProperties)

Write a construtor dom node.

Specified by:

writeConstructor in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

dtd - The dtd descriptor.

node - The node.

classProperties - Map the contains the writable object properties. May be null.

Returns:

the create document element.

writeToDOM

public org.w3c.dom.Element writeToDOM(org.w3c.dom.Document document,
                             FwkXmlDtdInterface dtd,
                             org.w3c.dom.Node node,
                             java.util.Map classProperties)

Write the container as child to the given DOM node.

Specified by:

writeToDOM in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

node - The parent node.

classProperties - Map the contains the writable object properties. May be null.

Returns:

The create document element.

writeMapToDOM

public org.w3c.dom.Element writeMapToDOM(org.w3c.dom.Document document,
                                FwkXmlDtdInterface dtd,
                                org.w3c.dom.Element node,
                                java.util.Map classProperties)

This method writes a map of the given object to DOM.

Parameters:

map - The map that should be dumped to DOM.

document - The document object model.

dtd - The dtd descriptor.

node - The node of the object.

classProperties - Map the contains the writable properties. May be null.

writeToXML

public boolean writeToXML(java.lang.String filename,
                 boolean validate)

Writes the canvas to an XML file.

Specified by:

writeToXML in interface FwkDOMHandlerInterface

Parameters:

filename - The name of the xml file.

validate - Write a validated cml file.

readingDOM

public void readingDOM(boolean flag)

Set a flag that the object is currently reading the DOM.

Specified by:

readingDOM in interface FwkDOMHandlerInterface

Parameters:

flag - true if the object reads currently fom DOM.

readingDOM

public boolean readingDOM()

Get the DOM reading flag.

Specified by:

readingDOM in interface FwkDOMHandlerInterface

Returns:

true if the object reads currently fom DOM.

getAuthor

public java.lang.String getAuthor()

Get the author name.

Specified by:

getAuthor in interface FwkDescriptionInterface

Returns:

The name of the author.

See Also:

setAuthor(String)

getBuild

public java.lang.String getBuild()

Get the build number.

Specified by:

getBuild in interface FwkDescriptionInterface

Returns:

The string representing the build number.

See Also:

#setBuild(int)

getClassName

public java.lang.String getClassName()

Get the class name of the FWK object.

Specified by:

getClassName in interface FwkDescriptionInterface

Returns:

The class name.

See Also:

setClassName(String)

getCompany

public java.lang.String getCompany()

Get the company name.

Specified by:

getCompany in interface FwkDescriptionInterface

Specified by:

getCompany in interface FwkDOMHandlerInterface

Returns:

The name of the company.

See Also:

setCompany(String)

getCompanyInternetAddress

public java.lang.String getCompanyInternetAddress()

Get the internet address of the company.

Specified by:

getCompanyInternetAddress in interface FwkDescriptionInterface

Returns:

A string containing the internet address of the company.

getCopyright

public java.lang.String getCopyright()

Get the copyright.

Specified by:

getCopyright in interface FwkDescriptionInterface

Returns:

The copyright string.

See Also:

setCopyright(String)

getCreationDate

public java.lang.String getCreationDate()

Get the creation date.

Specified by:

getCreationDate in interface FwkDescriptionInterface

Returns:

The date of the creation.

See Also:

#setCreationDate(Date)

getCreationDate

public java.lang.String getCreationDate(java.lang.String formatString)

Get the creation date.

Specified by:

getCreationDate in interface FwkDescriptionInterface

Parameters:

formatString - The date format string

Returns:

The date of the creation.

See Also:

#java.text.SimpleDateFormat, #setCreationDate(Date)

getDateFormatString

public java.lang.String getDateFormatString()

Get the date format string.

Specified by:

getDateFormatString in interface FwkDescriptionInterface

Returns:

The date format string.

getDescription

public java.lang.String getDescription()

Get the description.

Specified by:

getDescription in interface FwkDescriptionInterface

Returns:

The description of the application.

See Also:

setDescription(String)

getIcon

public FwkIconInterface getIcon()

Get the icon image.

Specified by:

getIcon in interface FwkDescriptionInterface

Returns:

The icon of the application.

See Also:

setIcon(FwkIconInterface)

getIcon

public FwkIconInterface getIcon(int type)

Get the image icon of the application

Specified by:

getIcon in interface FwkDescriptionInterface

Parameters:

type - The type of the icon, use the predefined values (see above).

Returns:

Icon

See Also:

#setIcon(Icon)

getIconKey

public java.lang.String getIconKey()

Get the property keyword of the icon.

Specified by:

getIconKey in interface FwkDescriptionInterface

Returns:

The keyword for the icon.

getIconKey

public java.lang.String getIconKey(int type)

Get the property keyword of the icon.

Specified by:

getIconKey in interface FwkDescriptionInterface

Parameters:

type - The type of the icon, use the predefined values (see above).

Returns:

The keyword for the icon.

getName

public java.lang.String getName()

Return the name of the ASAM-FWK object.

Specified by:

getName in interface FwkDescriptionInterface

Returns:

The name of the object.

getPresentationString

public java.lang.String getPresentationString(java.util.Locale locale)

Retrieves the representation string. The presentation string is a complete representation of the object including its data. This feature is required for copy/paste and drag/drop operations. The locale parameter allows to make the representation string locale language dependent.

Specified by:

getPresentationString in interface FwkDescriptionInterface

Parameters:

locale - The Locale object or null.

Returns:

The localized presentation string.

getPresentationString

public java.lang.String getPresentationString()

Retrieves the representation string. The presentation string is a complete representation of the object including its data. This feature is required for copy/paste and drag/drop operations. The locale parameter allows to make the representation string locale language dependent.

Specified by:

getPresentationString in interface FwkDescriptionInterface

Returns:

The presentation string.

getSupportEMail

public java.lang.String getSupportEMail()

Get the support e-mail.

Specified by:

getSupportEMail in interface FwkDescriptionInterface

Returns:

A string containing the support e-mail.

getTitle

public java.lang.String getTitle()

Get the title.

Specified by:

getTitle in interface FwkDescriptionInterface

Returns:

The title of the application.

getTitleName

public java.lang.String getTitleName()

Get the title name.

Specified by:

getTitleName in interface FwkDescriptionInterface

Returns:

The title name of the application.

See Also:

setName(String)

setAuthor

public void setAuthor(java.lang.String author)

Set the author name.

Specified by:

setAuthor in interface FwkDescriptionInterface

Parameters:

author - The name of the author.

See Also:

getAuthor()

setBuild

public void setBuild(java.lang.String buildnr)

Set the build number.

Specified by:

setBuild in interface FwkDescriptionInterface

Parameters:

buildnr - The string representing the build number.

See Also:

getBuild()

setClassName

public void setClassName(java.lang.String className)

Set the class name of the FWK object.

Specified by:

setClassName in interface FwkDescriptionInterface

Parameters:

className - The class name.

See Also:

getClassName()

setCompany

public void setCompany(java.lang.String company)

Set the company name.

Specified by:

setCompany in interface FwkDescriptionInterface

Parameters:

company - The name of the company.

See Also:

getCompany()

setCompanyInternetAddress

public void setCompanyInternetAddress(java.lang.String address)

Set the internet address of the company.

Specified by:

setCompanyInternetAddress in interface FwkDescriptionInterface

setCopyright

public void setCopyright(java.lang.String copyright)

Set the copyright.

Specified by:

setCopyright in interface FwkDescriptionInterface

Parameters:

The - copyright string.

See Also:

getCopyright()

setCreationDate

public void setCreationDate(java.lang.String dateString,
                   java.lang.String formatString)

Set the Date of the application. The default input format string FwkDescription.RCS_DATE_FORMAT. The default output format string FwkDescription.DATE_FORMAT.

Specified by:

setCreationDate in interface FwkDescriptionInterface

Parameters:

dateString - The Date of the application.

formatString - The format string.

See Also:

#java.text.SimpleDateFormat, getCreationDate()

setCreationDate

public void setCreationDate(java.lang.String dateString)

Set the Date of the application.

Specified by:

setCreationDate in interface FwkDescriptionInterface

Parameters:

dateString - The Date of the application.

See Also:

#java.text.SimpleDateFormat, getCreationDate()

setDateFormatString

public void setDateFormatString(java.lang.String formatString)

Set the Date format string.

Specified by:

setDateFormatString in interface FwkDescriptionInterface

Parameters:

formatString - The format string.

See Also:

#java.text.SimpleDateFormat, getCreationDate()

setDescription

public void setDescription(java.lang.String description)

Set the description of the application.

Specified by:

setDescription in interface FwkDescriptionInterface

Parameters:

description - The description of the application.

See Also:

getDescription()

setDescriptor

public void setDescriptor(FwkDescriptionInterface descriptor)
                   throws FwkException

Initialize the object with values of the given FwkDescription.

Specified by:

setDescriptor in interface FwkDescriptionInterface

Parameters:

descriptor - The FwkDescription from that the value should be copied.

Throws:

FwkException

setIcon

public void setIcon(FwkIconInterface icon)

Set the icon image.

Specified by:

setIcon in interface FwkDescriptionInterface

Parameters:

The - icon of the application.

See Also:

getIcon()

setIcon

public void setIcon(FwkIconInterface icon,
           int type)

Set the image icon of the application

Specified by:

setIcon in interface FwkDescriptionInterface

Parameters:

icon - The icon to be set.

type - The type of the icon, use predefined values defined above. If this value is out of range, no icon will be set.

See Also:

getIcon()

setIconKey

public void setIconKey(java.lang.String key)

Set the property keyword of the icon.

Specified by:

setIconKey in interface FwkDescriptionInterface

Parameters:

key - The keyword for the icon.

setIconKey

public void setIconKey(java.lang.String key,
              int type)

Set the property keyword of the icon.

Specified by:

setIconKey in interface FwkDescriptionInterface

Parameters:

key - The keyword for the icon.

type - The type of the icon, use predefined values defined above.

setName

public void setName(java.lang.String name)

Set the name of the ASAM-FWK object.

Specified by:

setName in interface FwkDescriptionInterface

Parameters:

name - The name of the object.

See Also:

getName()

setSupportEMail

public void setSupportEMail(java.lang.String eMail)

Get the support e-mail.

Specified by:

setSupportEMail in interface FwkDescriptionInterface

Parameters:

eMail - A string containing the support e-mail.

setTitleName

public void setTitleName(java.lang.String titleName)

Set the title of the application.

Specified by:

setTitleName in interface FwkDescriptionInterface

Parameters:

name - The name of the title.

See Also:

getName()

toString

public java.lang.String toString()

Get a string representation of the object.

Overrides:

toString in class FwkPropertyFile

Returns:

The string representation of the object.

getTransferDataFlavors

public java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()

Returns an array of DataFlavor objects indicating the flavors the data can be provided in. The array should be ordered according to preference for providing the data (from most richly descriptive to least descriptive).

Specified by:

getTransferDataFlavors in interface java.awt.datatransfer.Transferable

Returns:

an array of data flavors in which this data can be transferred

isDataFlavorSupported

public boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor)

Returns whether or not the specified data flavor is supported for this object.

Specified by:

isDataFlavorSupported in interface java.awt.datatransfer.Transferable

Parameters:

flavor - - the requested flavor for the data

Returns:

boolean indicating wjether or not the data flavor is supported

getTransferData

public java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor flavor)
                                 throws java.awt.datatransfer.UnsupportedFlavorException,
                                        java.io.IOException

Returns an object which represents the data to be transferred. The class of the object returned is defined by the representation class of the flavor.

Specified by:

getTransferData in interface java.awt.datatransfer.Transferable

Parameters:

flavor - - the requested flavor for the data

Throws:

java.io.IOException - - if the data is no longer available in the requested flavor. UnsupportedFlavorException - if the requested data flavor is not supported.

java.awt.datatransfer.UnsupportedFlavorException

See Also:

java.awt.datatransfer.DataFlavor.getRepresentationClass()

lostOwnership

public void lostOwnership(java.awt.datatransfer.Clipboard clipboard,
                 java.awt.datatransfer.Transferable contents)

Notifies this object that it is no longer the owner of the contents of the clipboard.

Specified by:

lostOwnership in interface java.awt.datatransfer.ClipboardOwner

Parameters:

clipboard - - the clipboard that is no longer owned

contents - - the contents which this owner had placed on the clipboard

read

public static FwkPropertyGroupInterface read(java.net.URL url,
                             FwkPropertyGroupInterface ret)

Read the property group file.

Parameters:

url - the url to be read.

group - The group to that the value should be append. If null the method creates and returns a new one.

read

public static FwkPropertyGroupInterface read(java.io.InputStream is,
                             FwkPropertyGroupInterface ret)

Read the property group file.

Parameters:

is - the inputstream from that the group should be filled up.

group - The group to that the value should be append. If null the method creates and returns a new one.

read

public static FwkPropertyGroupInterface read(java.io.Reader reader,
                             FwkPropertyGroupInterface ret)

Read the property group file.

Parameters:

reader - the reader from that the group should be filled up.

group - The group to that the value should be append. If null the method creates and returns a new one.

readNextSection

protected static boolean readNextSection(FwkPropertyGroupInterface parent,
                      java.io.BufferedReader in,
                      java.lang.String sectionName)

main

public static void main(java.lang.String[] args)