Package net.simplace.core.customize

Class AbstractConfiguration

java.lang.Object
net.simplace.core.customize.AbstractConfiguration
public abstract class AbstractConfiguration extends Object
Abstract config file with important functions for parsing and writing Data to ASCII Configfiles
Author:
Andreas Enders

  • Field Details

    • RELATIVE_SUFFIX

      public static final String RELATIVE_SUFFIX
      Parameter name suffix indicating a relative parameter value change (by %).
      See Also:

    • iLinesOfFile

      protected Vector<String> iLinesOfFile

    • iFile

      protected File iFile

    • iConfiguration

      protected org.jdom2.Element iConfiguration

  • Constructor Details

    • AbstractConfiguration

      public AbstractConfiguration(File aConfigFile, org.jdom2.Element aConfiguration)
      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

      protected String readValue(int aLineNumber, int aBeginColumnNumber, int aEndColumnNumber)

    • writeValue

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

    • isRelativeParameter

      public boolean isRelativeParameter(String aKey)
      Checks whether key specified a relative parameter value change (by %).
      Parameters:
      aKey - a key
      Returns:
      TRUE when key ends with "_rel", FALSE otherwise.

    • getBaseParameterName

      public String getBaseParameterName(String aKey)
      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

      public String getRelativeParameterName(String aKey)
      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

      public void replaceParametersFromMap(Map<String,Object> aParamMap)
      only if set modified values will be written
      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