de.ipcon.tools

Class ConfigureInfo

java.lang.Object

de.ipcon.tools.ConfigureInfo

public class ConfigureInfo
extends java.lang.Object

Class that allows to define a kind of "mapping" for configuration data in XML format to handling methods of an associated class and then call these handling methods with the respective XML elements from the configuration data XML. The definition for the ConfigureInfo "mapping" is given in XML itself. Note: This configuration method and this class are very old and rarely used today, mostly in other old legacy code. FIXME! TT 2022-12-19: There are some more features which are not explained here, for example "inherit". Example for a possible ConfigureInfo "mapping" definition: This means that the associated class (which is given using other means) will want some configuration value(s) given in the and XML elements of some other XML configuration. Note: The XML element tags for the root element and the children of "Elements" are actually irrelevant and not used and can be anything else, not just "XMLConfigureInfo" and "a". The actual configuration XML for the class might look like: Some data comes here More data of some other kind Note: The name of the root XML element is actually irrelevant and not used and can be anything else, not just "classConfig". When an instance of the class should be configured using that data it first will need to create a ConfigureInfo instance, for example using the ConfigureInfo.declareInfo() factory method, from a given "mapping" definition XML. Using this ConfigureInfo instance the class may then configure an instance of itself via configinfo.configure(classInstanceToBeConfigured, classConfigXML) with the data from the actual configuration XML. The class must contain instance methods handleDataE(e = Element) and handleOtherDataE(e = Element) which will be called and used to actually do something with the data from the XML, for example set some other properties of the to-be-configured instance.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashMap	attributeConverters

Constructor Summary

Constructors

Constructor and Description
ConfigureInfo(java.lang.Class cl, electric.xml.Element root)

Method Summary

Modifier and Type	Method and Description
void	configure(java.lang.Object o, electric.xml.Element confRoot) Configures the given Object - which should be of the class this instance is meant for, otherwise errors will occurr - with the XML data from the given XML Element and its children.
void	declareAttributes(electric.xml.Element root) Interprets the "Attributes" configuration XML element.
void	declareElements(electric.xml.Element root) Interprets the "Elements" configuration XML element.
static ConfigureInfo	declareInfo(java.lang.Class cl, java.lang.String s) Static factory method to create a ConfigureInfo instance for a given class from a given (XML) string.
java.util.Collection	getAttributeCollection()
java.util.Map	getAttributeMap()
static ConfigureInfo	getConfigInfo(java.lang.Class cl) Tries to get a predefined ConfigureInfo instance from the respective static property of the given class.
static ConfigureInfo	getConfigInfo(java.lang.Class cl, java.lang.String prop)
java.util.Collection	getElementCollection()
java.util.Map	getElementMap()
static java.lang.reflect.Field	getStaticProperty(java.lang.Class cl, java.lang.String prop) Convenience method to get a (static) property from a given class.
void	handleAttributes(java.lang.Object o, electric.xml.Element confRoot)
void	handleElements(java.lang.Object o, electric.xml.Element confRoot)
static java.util.HashMap	initAttributeConverters()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

attributeConverters

public static java.util.HashMap attributeConverters

Constructor Detail

ConfigureInfo

public ConfigureInfo(java.lang.Class cl,
                     electric.xml.Element root)

Parameters:

cl - FIXME

root - the XML root Element of the configuration definition

Method Detail

declareInfo

public static ConfigureInfo declareInfo(java.lang.Class cl,
                                        java.lang.String s)

Static factory method to create a ConfigureInfo instance for a given class from a given (XML) string. FIXME! TT 2022-12-19: Today this method would be called of(cl = Class, s = String)

declareAttributes

public void declareAttributes(electric.xml.Element root)

Interprets the "Attributes" configuration XML element.

declareElements

public void declareElements(electric.xml.Element root)

Interprets the "Elements" configuration XML element.

getConfigInfo

public static ConfigureInfo getConfigInfo(java.lang.Class cl)

Tries to get a predefined ConfigureInfo instance from the respective static property of the given class. Throws exceptions if no such property exists or something else goes wrong. FIXME! TT 2022-12-19: Today this method would be called of(cl = Class, prop = String)

Parameters:

cl - the class of interest

prop - the name of the static property supposed to hold the instance; defaults to "CONFIG"

Returns:

the predefined ConfigureInfo instance

getConfigInfo

public static ConfigureInfo getConfigInfo(java.lang.Class cl,
                                          java.lang.String prop)

getStaticProperty

public static java.lang.reflect.Field getStaticProperty(java.lang.Class cl,
                                                        java.lang.String prop)

Convenience method to get a (static) property from a given class.

Parameters:

cl - the class of interest

prop - the name of the requested property

Returns:

the Field corresponding to the requested property

Throws:

java.lang.NoSuchFieldException - if no such property exists

java.lang.SecurityException - if access is not allowed

getAttributeCollection

public java.util.Collection getAttributeCollection()

getElementCollection

public java.util.Collection getElementCollection()

getAttributeMap

public java.util.Map getAttributeMap()

getElementMap

public java.util.Map getElementMap()

initAttributeConverters

public static java.util.HashMap initAttributeConverters()

handleAttributes

public void handleAttributes(java.lang.Object o,
                             electric.xml.Element confRoot)

handleElements

public void handleElements(java.lang.Object o,
                           electric.xml.Element confRoot)

configure

public void configure(java.lang.Object o,
                      electric.xml.Element confRoot)

Configures the given Object - which should be of the class this instance is meant for, otherwise errors will occurr - with the XML data from the given XML Element and its children.