Class DefaultFilenameGenerator

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

    public class DefaultFilenameGenerator
    extends AbstractFilenameGeneratorWithExtension
    The default generator for database ID and ID handlers.

    Valid options are:

    -D <int> (property: debugLevel)
        The greater the number the more additional info the scheme may output to
        the console (0 = off).
        default: 0
        minimum: 0
    -dir <> (property: directory)
        The parent directory of the generated filename.
        default: ${CWD}
    -extension <java.lang.String> (property: extension)
        The extension to use (including the dot).
    -suffix <java.lang.String> (property: suffix)
        The suffix to use (after the DB-ID or ID).
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_Suffix

        protected String m_Suffix
        the suffix to use.
    • Constructor Detail

      • DefaultFilenameGenerator

        public DefaultFilenameGenerator()
    • Method Detail

      • setSuffix

        public void setSuffix​(String value)
        Sets the suffix to use.
        value - the suffix
      • getSuffix

        public String getSuffix()
        Returns the suffix in use.
        the suffix
      • suffixTipText

        public String suffixTipText()
        Returns the tip text for this property.
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • canHandleNullObject

        public boolean canHandleNullObject()
        Returns whether we actually need an object to generate the filename.
        Specified by:
        canHandleNullObject in class AbstractFilenameGenerator
        true if object required
      • doGenerate

        protected String doGenerate​(Object obj)
        Performs the actual generation of the filename.
        Specified by:
        doGenerate in class AbstractFilenameGenerator
        obj - the object to generate the filename for
        the generated filename