Package org.planit.output.formatter

Interface XmlTextFileOutputFormatter

  • All Known Implementing Classes:
    PlanItOutputFormatter
    public interface XmlTextFileOutputFormatter
    This interfaces defines behaviours which output formatters which generate an XML output file must have.
    Author:
    gman6028

    • Method Detail

      • getXmlFileName

        String getXmlFileName​(OutputType outputType)
        Returns the XML output file name for a specified output type
        Parameters:
        outputType - the specified output type
        Returns:
        the name of the output file

      • setXmlFileNamePerOutputType

        void setXmlFileNamePerOutputType​(OutputType outputType,
                                 String xmlFileName)
        Set the name of an XML output file for a specified output type
        Parameters:
        outputType - the specified output type
        xmlFileName - the name of the output file to be added for the specified output type

      • setXmlNameRoot

        void setXmlNameRoot​(String xmlNameRoot)
        Set the root name of the XML output file for all output types
        Parameters:
        xmlNameRoot - the root name of the output file

      • setXmlNameExtension

        void setXmlNameExtension​(String xmlNameExtension)
        Sets the extension of the XML output file name for all output types
        Parameters:
        xmlNameExtension - the extension of the output file names

      • setXmlDirectory

        void setXmlDirectory​(String xmlOutputDirectory)
        Sets the directory of the XML output files for all output types
        Parameters:
        xmlOutputDirectory - the directory of the output files