Package net.simplace.core.customize
Class AbstractConfiguration
java.lang.Object
net.simplace.core.customize.AbstractConfiguration
Abstract config file with important functions for parsing and writing Data to ASCII Configfiles
- Author:
- Andreas Enders
-
Field Summary
-
Constructor Summary
ModifierConstructorDescriptionprotected
AbstractConfiguration
(File aConfigFile, org.jdom2.Element aConfiguration) -
Method Summary
Modifier and TypeMethodDescriptionvoid
commit()
if is setModified() new Values will be written to config file.protected abstract void
has to be implemented by FileFieldsgetBaseParameterName
(String aKey) If specified key specifies a relative parameter value change (by %), the function returns the base parameter name.only if set modified values will be writtenReturns the key, which specifies a relative parameter value change (by %) for the specified parameter name.protected abstract void
has to be implemented by FileFieldsboolean
isRelativeParameter
(String aKey) Checks whether key specified a relative parameter value change (by %).protected String
readValue
(int aLineNumber, int aBeginColumnNumber, int aEndColumnNumber) void
replaceParametersFromMap
(Map<String, Object> aParamMap) only if set modified values will be writtenvoid
only if set modified values will be writtenvoid
only if set modified values will be writtentoString()
protected void
writeValue
(String aValue, int aLineNumber, int aBeginColumnNumber, int aEndColumnNumber)
-
Field Details
-
RELATIVE_SUFFIX
Parameter name suffix indicating a relative parameter value change (by %).- See Also:
-
iLinesOfFile
-
iFile
-
iConfiguration
protected org.jdom2.Element iConfiguration
-
-
Constructor Details
-
AbstractConfiguration
- Parameters:
aConfigFile
-aConfiguration
-
-
AbstractConfiguration
protected AbstractConfiguration()
-
-
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
-
writeValue
protected void writeValue(String aValue, int aLineNumber, int aBeginColumnNumber, int aEndColumnNumber) -
isRelativeParameter
Checks whether key specified a relative parameter value change (by %).- Parameters:
aKey
- a key- Returns:
- TRUE when key ends with "_rel", FALSE otherwise.
-
getBaseParameterName
If specified key specifies a relative parameter value change (by %), the function returns the base parameter name. Otherwise the specified key itself is returned.- Parameters:
aKey
- a key- Returns:
-
getRelativeParameterName
Returns the key, which specifies a relative parameter value change (by %) for the specified parameter name.- Parameters:
aKey
- a key- Returns:
- aKey itself if key already specifies a relative parameter change
-
replaceParametersFromMap
only if set modified values will be written- Parameters:
aParamMap
-
-
getConfigurationParmeterValue
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
-