Class AbstractFormatter

    • Field Detail

      • overwrite

        public boolean overwrite
      • log

        protected final org.slf4j.Logger log
      • outputExtension

        public java.lang.String outputExtension
        File extension for callers to know.
      • outputType

        protected java.lang.String outputType
      • TEXT_WIDTH

        protected static int TEXT_WIDTH
      • debug

        public boolean debug
      • includeOffsets

        public boolean includeOffsets
        Schema-specific stuff. GIS formats would not make use of offsets. CSV format is only one where offsets make sense.
      • includeCoordinate

        public boolean includeCoordinate
        GIS formats may optionally include coordinates as fields. GDB and SHP have a Point geometry which carries the lat/lon already. KML, CSV, JSON, etc. it makes sense to include these explicitly.
    • Constructor Detail

      • AbstractFormatter

        public AbstractFormatter()
    • Method Detail

      • setParameters

        public void setParameters​(Parameters params)
        Note - output parameters use tag_XYZ flags to indicate date to include or exclude
        Specified by:
        setParameters in interface ResultsFormatter
      • setMatchInterpeter

        public void setMatchInterpeter​(MatchInterpreter mi)
        Override means for how geocoding is determined per row.
      • getGeocoding

        public Geocoding getGeocoding​(TextMatch m)
        The default geocoding interpretation is here. This works for simple stuff like Coordinate extraction
        Specified by:
        getGeocoding in interface MatchInterpreter
        m - TextMatch -- which may or may not be geographic in nature.
      • getJobName

        public java.lang.String getJobName()
        A basic job name that reflects file name
        Specified by:
        getJobName in interface ResultsFormatter
      • setOutputFilename

        public void setOutputFilename​(java.lang.String fname)
        Description copied from interface: ResultsFormatter
        Set the name of the output file.
        Specified by:
        setOutputFilename in interface ResultsFormatter
        fname - file name of output
      • setOutputDir

        public void setOutputDir​(java.lang.String path)
        Description copied from interface: ResultsFormatter
        Set the path to the output directory.
        Specified by:
        setOutputDir in interface ResultsFormatter
        path - output dir path
      • createOutputFileName

        protected java.lang.String createOutputFileName()
        file name with extension
      • getOutputType

        public java.lang.String getOutputType()
        Description copied from interface: ResultsFormatter
        Get the type of output produced by this formatter.
        Specified by:
        getOutputType in interface ResultsFormatter
        type of output
      • deleteOutput

        protected void deleteOutput​( previousRun)
        This is checked only by internal classes as they create output streams.
      • checkOverwrite

        protected void checkOverwrite​( item)
        uniform helper for overwrite check.
      • createOutputStreams

        protected abstract void createOutputStreams()
                                             throws java.lang.Exception
        Create the output stream appropriate for the output type. IO is created using the filename represented by getOutputFilepath()
      • close

        public abstract void close()
      • writeGeocodingResult

        public abstract void writeGeocodingResult​(ExtractionResult rowdata)
        Write your geocoding result directly to output Result should carry ExtractionResult.recordFile as a URI for original.
        rowdata - the data to write out