Package org.planit.output.formatter

Interface CsvTextFileOutputFormatter

  • All Known Implementing Classes:
    CSVOutputFormatter, PlanItOutputFormatter
    public interface CsvTextFileOutputFormatter
    This interfaces defines behaviours which output formatters which generate a CSV output file must have.
    Author:
    gman6028

    • Method Detail

      • getCsvFileName

        List<String> getCsvFileName​(OutputType outputType)
        Returns a list of names of CSV output file for a specified output type
        Parameters:
        outputType - the specified output type
        Returns:
        the name of the output file

      • addCsvFileNamePerOutputType

        void addCsvFileNamePerOutputType​(OutputTypeEnum outputType,
                                 String csvFileName)
        Add a new name of a CSV output file for a specified output type
        Parameters:
        outputType - the specified output type
        csvFileName - the name of the output file to be added for the specified output type

      • setCsvNameRoot

        void setCsvNameRoot​(String csvNameRoot)
        Set the root name of the CSV output file for all output types
        Parameters:
        csvNameRoot - the root name of the output file

      • setCsvNameExtension

        void setCsvNameExtension​(String csvNameExtension)
        Sets the extension of the CSV output file name for all output types
        Parameters:
        csvNameExtension - the extension of the output file names

      • setCsvDirectory

        void setCsvDirectory​(String csvOutputDirectory)
        Sets the directory of the CSV output files for all output types
        Parameters:
        csvOutputDirectory - the directory of the output files