Package org.pentaho.reporting.engine.classic.core.modules.output.csv

Class CSVWriter

    • Constructor Detail

      • CSVWriter

        public CSVWriter()
        Deprecated.
        DefaulConstructor. Creates a CSVWriter with a dependency level of -1 and a default CSVQuoter.

    • Method Detail

      • isWriteDataRowNames

        public boolean isWriteDataRowNames()
        Deprecated.
        Returns whether to print dataRow column names as header.
        Returns:
        true, if column names are printed, false otherwise.

      • setWriteDataRowNames

        public void setWriteDataRowNames​(boolean writeDataRowNames)
        Deprecated.
        Defines, whether to print column names in the first row.
        Parameters:
        writeDataRowNames - true, if column names are printed, false otherwise

      • isWriteStateColumns

        public boolean isWriteStateColumns()
        Deprecated.

      • setWriteStateColumns

        public void setWriteStateColumns​(boolean writeStateColumns)
        Deprecated.

      • isEnableGroupFooter

        public boolean isEnableGroupFooter()
        Deprecated.

      • setEnableGroupFooter

        public void setEnableGroupFooter​(boolean enableGroupFooter)
        Deprecated.

      • isEnableGroupHeader

        public boolean isEnableGroupHeader()
        Deprecated.

      • setEnableGroupHeader

        public void setEnableGroupHeader​(boolean enableGroupHeader)
        Deprecated.

      • isEnableItemband

        public boolean isEnableItemband()
        Deprecated.

      • setEnableItemband

        public void setEnableItemband​(boolean enableItemband)
        Deprecated.

      • isEnableReportFooter

        public boolean isEnableReportFooter()
        Deprecated.

      • setEnableReportFooter

        public void setEnableReportFooter​(boolean enableReportFooter)
        Deprecated.

      • isEnableReportHeader

        public boolean isEnableReportHeader()
        Deprecated.

      • setEnableReportHeader

        public void setEnableReportHeader​(boolean enableReportHeader)
        Deprecated.

      • getWriter

        public Writer getWriter()
        Deprecated.
        Returns the writer used to output the generated data.
        Returns:
        the writer

      • setWriter

        public void setWriter​(Writer w)
        Deprecated.
        Defines the writer which should be used to output the generated data.
        Parameters:
        w - the writer

      • setSeparator

        public void setSeparator​(String separator)
        Deprecated.
        Defines the separator, which is used to separate columns in a row.
        Parameters:
        separator - the separator string, never null.
        Throws:
        NullPointerException - if the separator is null.
        IllegalArgumentException - if the separator is an empty string.

      • getSeparator

        public String getSeparator()
        Deprecated.
        Gets the separator which is used to separate columns in a row.
        Returns:
        the separator, never null.

      • itemsStarted

        public void itemsStarted​(ReportEvent event)
        Deprecated.
        Receives notification that a group of item bands is about to be processed.

        The next events will be itemsAdvanced events until the itemsFinished event is raised.

        Specified by:
        itemsStarted in interface ReportListener
        Overrides:
        itemsStarted in class AbstractFunction
        Parameters:
        event - The event.

      • itemsFinished

        public void itemsFinished​(ReportEvent event)
        Deprecated.
        Receives notification that a group of item bands has been completed.

        The itemBand is finished, the report starts to close open groups.

        Specified by:
        itemsFinished in interface ReportListener
        Overrides:
        itemsFinished in class AbstractFunction
        Parameters:
        event - The event.

      • getValue

        public Object getValue()
        Deprecated.
        Return a selfreference of this CSVWriter. This selfreference is used to confiugre the output process.
        Specified by:
        getValue in interface Expression
        Returns:
        this CSVWriter.

      • getDependencyLevel

        public int getDependencyLevel()
        Deprecated.
        The dependency level defines the level of execution for this function. Higher dependency functions are executed before lower dependency functions. For ordinary functions and expressions, the range for dependencies is defined to start from 0 (lowest dependency possible) to 2^31 (upper limit of int).

        PageLayouter functions override the default behaviour an place them self at depency level -1, an so before any user defined function.

        Specified by:
        getDependencyLevel in interface Expression
        Overrides:
        getDependencyLevel in class AbstractExpression
        Returns:
        the level.

      • setDependencyLevel

        public void setDependencyLevel​(int deplevel)
        Deprecated.
        Overrides the depency level. Should be lower than any other function depency.
        Specified by:
        setDependencyLevel in interface Expression
        Overrides:
        setDependencyLevel in class AbstractExpression
        Parameters:
        deplevel - the new depency level.

      • deriveForStorage

        public OutputFunction deriveForStorage()
        Deprecated.
        This method simply clones the function. The CSVWriter does not maintain large internal states and therefore need not to be aware of any advanced optimizations.
        Specified by:
        deriveForStorage in interface OutputFunction
        Returns:
        the derived function.

      • deriveForPagebreak

        public OutputFunction deriveForPagebreak()
        Deprecated.
        This method simply clones the function. The CSVWriter does not maintain large internal states and therefore need not to be aware of any advanced optimizations.
        Specified by:
        deriveForPagebreak in interface OutputFunction
        Returns:
        the derived function.

      • clone

        public Object clone()
             throws CloneNotSupportedException
        Deprecated.
        Clones the expression. The expression should be reinitialized after the cloning.

        Expressions maintain no state, cloning is done at the beginning of the report processing to disconnect the expression from any other object space.

        Specified by:
        clone in interface Expression
        Overrides:
        clone in class AbstractExpression
        Returns:
        a clone of this expression.
        Throws:
        CloneNotSupportedException - this should never happen.