Package elki.result

Class ResultWriter.Par

  • All Implemented Interfaces:
    Parameterizer
    Enclosing class:
    ResultWriter
    public static class ResultWriter.Par
extends java.lang.Object
implements Parameterizer
    Parameterization class.
    Author:
    Erich Schubert

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.regex.Pattern filter
      Result filter pattern.
      static OptionID FILTER_PATTERN_ID
      Pattern to filter the output
      private boolean gzip
      Whether or not to do gzip compression on output.
      static OptionID GZIP_OUTPUT_ID
      Flag to control GZIP compression.
      private java.nio.file.Path out
      Holds the file to print results to.
      static OptionID OVERWRITE_OPTION_ID
      Flag to suppress overwrite warning.
      private boolean warnoverwrite
      Whether or not to warn on overwrite

    • Constructor Summary

      Constructors 
      Constructor Description
      Par()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void configure​(Parameterization config)
      Configure the class.
      ResultWriter make()
      Make an instance after successful configuration.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • GZIP_OUTPUT_ID

        public static final OptionID GZIP_OUTPUT_ID
        Flag to control GZIP compression.

      • OVERWRITE_OPTION_ID

        public static final OptionID OVERWRITE_OPTION_ID
        Flag to suppress overwrite warning.

      • FILTER_PATTERN_ID

        public static final OptionID FILTER_PATTERN_ID
        Pattern to filter the output

      • out

        private java.nio.file.Path out
        Holds the file to print results to.

      • gzip

        private boolean gzip
        Whether or not to do gzip compression on output.

      • warnoverwrite

        private boolean warnoverwrite
        Whether or not to warn on overwrite

      • filter

        private java.util.regex.Pattern filter
        Result filter pattern. Optional!

    • Constructor Detail

      • Par

        public Par()

    • Method Detail

      • configure

        public void configure​(Parameterization config)
        Description copied from interface: Parameterizer
        Configure the class.

        Note: the status is collected by the parameterization object, so that multiple errors may arise and be reported in one run.

        Specified by:
        configure in interface Parameterizer
        Parameters:
        config - Parameterization

      • make

        public ResultWriter make()
        Description copied from interface: Parameterizer
        Make an instance after successful configuration.

        Note: your class should return the exact type, only this very broad interface should use Object as return type.

        Specified by:
        make in interface Parameterizer
        Returns:
        a new instance