Package net.simplace.core.customize

Class AbstractXMLConfiguration

java.lang.Object

net.simplace.core.customize.AbstractXMLConfiguration

public abstract class AbstractXMLConfiguration
extends Object

Abstract config file with important functions for parsing and writing Data to ASCII Configfiles

Author:

Andreas Enders

Field Summary

Fields

Modifier and Type	Field	Description
protected org.jdom2.Element	iConfiguration
protected org.jdom2.Document	iDocument
protected File	iFile

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractXMLConfiguration()
	AbstractXMLConfiguration(File aConfigFile, org.jdom2.Element aConfiguration)
	AbstractXMLConfiguration(File aConfigFile, org.jdom2.Element aConfiguration, Map<String,Object> aParameterMap)

Method Summary

Modifier and Type	Method	Description
void	commit()	if is setModified() new Values will be written to config file.
protected abstract void	commitValues()	has to be implemented by FileFields
String	getConfigurationParmeterValue(String aKey)	only if set modified values will be written
protected abstract void	initializeFileValues()	has to be implemented by FileFields
protected String	readValue(String aXPath)
void	replaceParametersFromMap(Map<String,Object> aParamMap)
void	setModified()	only if set modified values will be written
void	setUnModified()	only if set modified values will be written
String	toString()
protected void	writeValue(String aValue, int aLineNumber, int aBeginColumnNumber, int aEndColumnNumber)

Methods inherited from class java.lang.Object

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

Field Details

iDocument

protected org.jdom2.Document iDocument

iFile

protected File iFile

iConfiguration

protected org.jdom2.Element iConfiguration

Constructor Details

AbstractXMLConfiguration

public AbstractXMLConfiguration(File aConfigFile,
 org.jdom2.Element aConfiguration)

Parameters:

aConfigFile -

aConfiguration -

AbstractXMLConfiguration

public AbstractXMLConfiguration(File aConfigFile,
 org.jdom2.Element aConfiguration,
 Map<String,Object> aParameterMap)

Parameters:

aConfigFile -

aConfiguration -

aParameterMap -

AbstractXMLConfiguration

protected AbstractXMLConfiguration()

Method Details

initializeFileValues

protected abstract void initializeFileValues()

has to be implemented by FileFields

commitValues

protected abstract void commitValues()

has to be implemented by FileFields

commit

public void commit()

if is setModified() new Values will be written to config file.

readValue

protected String readValue(String aXPath)

writeValue

protected void writeValue(String aValue,
 int aLineNumber,
 int aBeginColumnNumber,
 int aEndColumnNumber)

replaceParametersFromMap

public void replaceParametersFromMap(Map<String,Object> aParamMap)

Parameters:

aParamMap -

getConfigurationParmeterValue

public String getConfigurationParmeterValue(String aKey)

only if set modified values will be written

Parameters:

aKey -

Returns:

setModified

public void setModified()

only if set modified values will be written

setUnModified

public void setUnModified()

only if set modified values will be written

toString

public String toString()

Overrides:

toString in class Object