com.highqsoft.athosconfig

Class AthosConfigModel

java.lang.Object

com.highqsoft.athosconfig.AthosConfigModel

All Implemented Interfaces:

AthosConfigModelIF

public class AthosConfigModel
extends java.lang.Object
implements AthosConfigModelIF

This the Athos config model.

Since:

$Date: 2017/04/06 13:28:25 $

Version:

$Revision: 1.14 $

Author:

Andreas Hofmann

See Also:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AthosConfigModel.ReturnNodeList Get product element.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector	pListeners
protected java.util.HashMap	propListeners
protected java.lang.Object	ref
protected org.w3c.dom.Document	theDocument
protected java.util.HashMap	vetoListeners
protected java.util.Vector	vListeners
protected XMLConfiguration	xmlConfig

Constructor Summary

Constructors

Constructor and Description
AthosConfigModel(java.lang.Object ref) The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Add a property change listener.
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener l) Add a property change listener for a specific property.
org.w3c.dom.Element	addService(org.w3c.dom.Element pattern, java.lang.String name, org.w3c.dom.NodeList appNodeList) Add service.
void	addVetoableChangeListener(java.lang.String propertyName, java.beans.VetoableChangeListener l) Add a veto change listener for a specific property.
void	addVetoableChangeListener(java.beans.VetoableChangeListener l) Add a veto change listener.
protected static boolean	booleanValue(java.lang.String value)
org.w3c.dom.NodeList	checkConsistence() check the consistence
void	checkConsistence(AthosConfigModel.ReturnNodeList ret, org.w3c.dom.Element node) check the consistence of a single element.
protected void	createDoc(org.w3c.dom.Document iniDoc) Create a document that has a INI as source.
void	extend(org.w3c.dom.Node serviceNode, org.w3c.dom.Node application) Extends the given product/service node is to be used for the given application node.
protected void	firePropertyChange(java.lang.String propName, java.lang.Object oldValue, java.lang.Object newValue) Fire a property change event.
protected void	fireVetoableChange(java.lang.String propName, java.lang.Object oldValue, java.lang.Object newValue) Fire a vetoable change event.
org.w3c.dom.NodeList	getAvailableApplications() Get an array of available application product.
org.w3c.dom.NodeList	getAvailableProducts() Get an array of available product description attributes.
org.w3c.dom.Document	getDocument() Get the document.
GUIFactoryIF	getFactory() Get the factory that creates the GUI elements.
java.lang.String	getFilename() Get the filename of the configuration.
org.w3c.dom.Element	getGlobal() Get the global node.
org.w3c.dom.NodeList	getNoneDriverNodes() Get an array of non driver nodes.
org.w3c.dom.Element	getProduct(org.w3c.dom.NodeList products, java.lang.String driverName) Get an array of available product description attributes.
java.lang.String	getProperty(java.lang.String key, java.lang.String def) Get a string property.
java.beans.PropertyChangeListener[]	getPropertyChangepListeners() Returns an array of all the property change listeners registered on this model.
java.beans.VetoableChangeListener[]	getVetoableChangepListeners() Returns an array of all the vetoable change listeners registered on this model.
static boolean	hasToBeEncoded(org.w3c.dom.Element variable) Return a boolean whether the element should be defined via the system environment.
protected boolean	hasVariable(org.w3c.dom.NodeList nodeList, java.lang.String name)
boolean	isDesignedFor(org.w3c.dom.Node serviceNode, org.w3c.dom.Node application) Get a boolean whether the given node is designed for the given application node.
static boolean	isEnvironment(org.w3c.dom.Element variable) Return a boolean whether the element should be defined via the system environment.
static boolean	isGlobal(org.w3c.dom.Element variable) Return a boolean whether the element is global in INI file.
static boolean	isINI(org.w3c.dom.Element variable) Return a boolean whether the element should be defined in INI file.
static boolean	isObligatory(org.w3c.dom.Element variable) Return a boolean whether the element is obligatory.
static void	main(java.lang.String[] args) The main testing routine.
void	newConfig() Create a new configuration.
void	openFile(java.io.File file) Open an INI file.
void	openFile(java.lang.String filename) Open an INI file.
void	reduce(org.w3c.dom.Node serviceNode, org.w3c.dom.Node application, org.w3c.dom.NodeList otherApp) Remove the given application dependencies from given product/service node.
void	reduceApplicationAttributes(org.w3c.dom.Node serviceNode, org.w3c.dom.Node application, org.w3c.dom.NodeList otherApp) Remove the given application dependencies from given product/service node.
protected void	removeEnvironment(org.w3c.dom.Node product) Remove envinroment from product node.
protected void	removeGlobal(org.w3c.dom.Node node) Remove global variable from node.
protected void	removeLocal(org.w3c.dom.Node node) Remove local variable from node.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Remove a property change listener.
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener l) Remove a property change listener for a specific property.
void	removeVetoableChangeListener(java.lang.String propertyName, java.beans.VetoableChangeListener l) Remove a vetoable change listener for a specific property.
void	removeVetoableChangeListener(java.beans.VetoableChangeListener l) Remove a vetoable change listener.
void	saveFile(java.io.File file) Save an INI file.
void	saveFile(java.lang.String filename) Save the INI file.
void	setDocument(org.w3c.dom.Document doc) Set the document.
void	setFilename(java.lang.String filename) Set the name of the INI file.

Methods inherited from class java.lang.Object

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

Field Detail

pListeners

protected java.util.Vector pListeners

propListeners

protected java.util.HashMap propListeners

vListeners

protected java.util.Vector vListeners

vetoListeners

protected java.util.HashMap vetoListeners

theDocument

protected org.w3c.dom.Document theDocument

xmlConfig

protected XMLConfiguration xmlConfig

ref

protected java.lang.Object ref

Constructor Detail

AthosConfigModel

public AthosConfigModel(java.lang.Object ref)
                 throws java.lang.Exception

The constructor.

Throws:

java.lang.Exception

Method Detail

newConfig

public void newConfig()

Create a new configuration. Discard the current one.

Specified by:

newConfig in interface AthosConfigModelIF

getProperty

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

Get a string property.

Specified by:

getProperty in interface AthosConfigModelIF

Parameters:

key - the property keyword.

def - the default value.

getFactory

public GUIFactoryIF getFactory()

Get the factory that creates the GUI elements.

Specified by:

getFactory in interface AthosConfigModelIF

getDocument

public org.w3c.dom.Document getDocument()

Get the document.

Specified by:

getDocument in interface AthosConfigModelIF

Returns:

the document describing the currnet configuration.

setFilename

public void setFilename(java.lang.String filename)
                 throws java.lang.Exception

Set the name of the INI file.

Throws:

java.lang.Exception

setDocument

public void setDocument(org.w3c.dom.Document doc)

Set the document.

Parameters:

doc - the document.

openFile

public void openFile(java.lang.String filename)
              throws java.lang.Exception

Open an INI file.

Specified by:

openFile in interface AthosConfigModelIF

Parameters:

filename - the name of the file to be opened.

Throws:

java.lang.Exception

openFile

public void openFile(java.io.File file)
              throws java.lang.Exception

Open an INI file.

Specified by:

openFile in interface AthosConfigModelIF

Parameters:

file - the file descriptor of the file to be opened.

Throws:

java.lang.Exception

saveFile

public void saveFile(java.lang.String filename)
              throws java.lang.Exception

Save the INI file.

Specified by:

saveFile in interface AthosConfigModelIF

Parameters:

filename - the name of the file to be saved.

Throws:

java.lang.Exception

saveFile

public void saveFile(java.io.File file)
              throws java.lang.Exception

Save an INI file.

Specified by:

saveFile in interface AthosConfigModelIF

Parameters:

file - the file descriptor of the file to be saved.

Throws:

java.lang.Exception

getGlobal

public org.w3c.dom.Element getGlobal()

Get the global node.

Specified by:

getGlobal in interface AthosConfigModelIF

addService

public org.w3c.dom.Element addService(org.w3c.dom.Element pattern,
                             java.lang.String name,
                             org.w3c.dom.NodeList appNodeList)

Add service.

Specified by:

addService in interface AthosConfigModelIF

Parameters:

pattern - the product node that should be added.

name - the name of the new service.

Returns:

the new configuration element node.

getProduct

public org.w3c.dom.Element getProduct(org.w3c.dom.NodeList products,
                             java.lang.String driverName)
                               throws java.lang.Exception

Get an array of available product description attributes.

Throws:

java.lang.Exception

getAvailableProducts

public org.w3c.dom.NodeList getAvailableProducts()
                                          throws java.lang.Exception

Get an array of available product description attributes.

Specified by:

getAvailableProducts in interface AthosConfigModelIF

Throws:

java.lang.Exception

getNoneDriverNodes

public org.w3c.dom.NodeList getNoneDriverNodes()
                                        throws java.lang.Exception

Get an array of non driver nodes.

Specified by:

getNoneDriverNodes in interface AthosConfigModelIF

Throws:

java.lang.Exception

getAvailableApplications

public org.w3c.dom.NodeList getAvailableApplications()
                                              throws java.lang.Exception

Get an array of available application product.

Specified by:

getAvailableApplications in interface AthosConfigModelIF

Throws:

java.lang.Exception

extend

public void extend(org.w3c.dom.Node serviceNode,
          org.w3c.dom.Node application)

Extends the given product/service node is to be used for the given application node.

Specified by:

extend in interface AthosConfigModelIF

removeEnvironment

protected void removeEnvironment(org.w3c.dom.Node product)

Remove envinroment from product node.

removeLocal

protected void removeLocal(org.w3c.dom.Node node)

Remove local variable from node.

removeGlobal

protected void removeGlobal(org.w3c.dom.Node node)

Remove global variable from node.

reduce

public void reduce(org.w3c.dom.Node serviceNode,
          org.w3c.dom.Node application,
          org.w3c.dom.NodeList otherApp)

Remove the given application dependencies from given product/service node. Watch of the dependencies given ba the third parameter application node list.

Specified by:

reduce in interface AthosConfigModelIF

reduceApplicationAttributes

public void reduceApplicationAttributes(org.w3c.dom.Node serviceNode,
                               org.w3c.dom.Node application,
                               org.w3c.dom.NodeList otherApp)

Remove the given application dependencies from given product/service node. Watch of the dependencies given ba the third parameter application node list.

isDesignedFor

public boolean isDesignedFor(org.w3c.dom.Node serviceNode,
                    org.w3c.dom.Node application)
                      throws java.lang.Exception

Get a boolean whether the given node is designed for the given application node.

Specified by:

isDesignedFor in interface AthosConfigModelIF

Throws:

java.lang.Exception

isObligatory

public static boolean isObligatory(org.w3c.dom.Element variable)

Return a boolean whether the element is obligatory.

hasToBeEncoded

public static boolean hasToBeEncoded(org.w3c.dom.Element variable)

Return a boolean whether the element should be defined via the system environment.

isEnvironment

public static boolean isEnvironment(org.w3c.dom.Element variable)

Return a boolean whether the element should be defined via the system environment.

isGlobal

public static boolean isGlobal(org.w3c.dom.Element variable)

Return a boolean whether the element is global in INI file.

isINI

public static boolean isINI(org.w3c.dom.Element variable)

Return a boolean whether the element should be defined in INI file.

hasVariable

protected boolean hasVariable(org.w3c.dom.NodeList nodeList,
                  java.lang.String name)

checkConsistence

public org.w3c.dom.NodeList checkConsistence()

check the consistence

Specified by:

checkConsistence in interface AthosConfigModelIF

Returns:

a node list of nodes that are not well defined.

checkConsistence

public void checkConsistence(AthosConfigModel.ReturnNodeList ret,
                    org.w3c.dom.Element node)

check the consistence of a single element.

getFilename

public java.lang.String getFilename()

Get the filename of the configuration.

Specified by:

getFilename in interface AthosConfigModelIF

Returns:

thefile of the configuration.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Add a property change listener.

Parameters:

l - the listener

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                             java.beans.PropertyChangeListener l)

Add a property change listener for a specific property.

Parameters:

propertyName - the name of the property.

l - the listener

getPropertyChangepListeners

public java.beans.PropertyChangeListener[] getPropertyChangepListeners()

Returns an array of all the property change listeners registered on this model.

Returns:

an array containing the pListeners.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Remove a property change listener.

Parameters:

l - the listener

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                java.beans.PropertyChangeListener l)

Remove a property change listener for a specific property.

Parameters:

propertyName - the name of the property.

l - the listener

firePropertyChange

protected void firePropertyChange(java.lang.String propName,
                      java.lang.Object oldValue,
                      java.lang.Object newValue)

Fire a property change event.

Parameters:

propertyName - the property name

oldValue - theold value.

newValue - the new value

addVetoableChangeListener

public void addVetoableChangeListener(java.beans.VetoableChangeListener l)

Add a veto change listener.

Parameters:

l - the listener

addVetoableChangeListener

public void addVetoableChangeListener(java.lang.String propertyName,
                             java.beans.VetoableChangeListener l)

Add a veto change listener for a specific property.

Parameters:

propertyName - the name of the property.

l - the listener

getVetoableChangepListeners

public java.beans.VetoableChangeListener[] getVetoableChangepListeners()

Returns an array of all the vetoable change listeners registered on this model.

Returns:

an array containing the pListeners.

removeVetoableChangeListener

public void removeVetoableChangeListener(java.beans.VetoableChangeListener l)

Remove a vetoable change listener.

Parameters:

l - the listener

removeVetoableChangeListener

public void removeVetoableChangeListener(java.lang.String propertyName,
                                java.beans.VetoableChangeListener l)

Remove a vetoable change listener for a specific property.

Parameters:

propertyName - the name of the property.

l - the listener

fireVetoableChange

protected void fireVetoableChange(java.lang.String propName,
                      java.lang.Object oldValue,
                      java.lang.Object newValue)
                           throws java.beans.PropertyVetoException

Fire a vetoable change event.

Parameters:

propertyName - the property name

oldValue - theold value.

newValue - the new value

Throws:

java.beans.PropertyVetoException

booleanValue

protected static boolean booleanValue(java.lang.String value)

createDoc

protected void createDoc(org.w3c.dom.Document iniDoc)
                  throws java.lang.Exception

Create a document that has a INI as source.

Throws:

java.lang.Exception

main

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

The main testing routine.

Parameters:

args - The runtime parameters.