Package com.nuix.superutilities.reporting

Class IntersectionReportSheetConfiguration

  • public class IntersectionReportSheetConfiguration
extends java.lang.Object

    • Constructor Detail

      • IntersectionReportSheetConfiguration

        public IntersectionReportSheetConfiguration()

    • Method Detail

      • getRowCriteria

        public java.util.List<NamedQuery> getRowCriteria()
        Gets the list of criteria used for each row.
        Returns:
        List of row criteria.

      • setRowCriteria

        public void setRowCriteria​(java.util.List<NamedQuery> rowCriteria)
        Sets the list of criteria used for each row.
        Parameters:
        rowCriteria - The list of criteria which defines each row.

      • addRowCriterion

        public void addRowCriterion​(NamedQuery criterion)
        Adds a single NamedQuery to the list of row criteria.
        Parameters:
        criterion - The named query to add to the list of row criteria.

      • addRowCriterion

        public void addRowCriterion​(java.lang.String name,
                            java.lang.String query)
        Adds a single NamedQuery, constructed from the provided arguments, to the list of row criteria.
        Parameters:
        name - Name value used when constructing the NamedQuery object.
        query - Query value used when constructing the NamedQuery object.

      • clearRowCriteria

        public void clearRowCriteria()
        Removes all currently assigned row criteria.

      • getColCriteria

        public java.util.List<NamedQuery> getColCriteria()
        Gets the list of criteria used for each primary column category.
        Returns:
        The list of criteria used for each primary column category.

      • setColCriteria

        public void setColCriteria​(java.util.List<NamedQuery> colCriteria)
        Sets the list of criteria used for each primary column category.
        Parameters:
        colCriteria - The list of criteria to use for each primary column category.

      • addColCriterion

        public void addColCriterion​(NamedQuery criterion)
        Adds a single NamedQuery to the list of primary column criteria.
        Parameters:
        criterion - The named query to add to the list of primary column criteria.

      • addColCriterion

        public void addColCriterion​(java.lang.String name,
                            java.lang.String query)
        Adds a single NamedQuery, constructed from the provided arguments, to the list of primary column criteria.
        Parameters:
        name - Name value used when constructing the NamedQuery object.
        query - Query value used when constructing the NamedQuery object.

      • getValueGenerators

        public java.util.List<ColumnValueGenerator> getValueGenerators()
        Gets the list of ColumnValueGenerator objects used to calculate the value of each secondary column nested beneath any given primary column.
        Returns:
        The list of ColumnValueGenerator objects used to calculate the value of each secondary column nested beneath any given primary column.

      • setValueGenerators

        public void setValueGenerators​(java.util.List<ColumnValueGenerator> valueGenerators)
        Sets the list of ColumnValueGenerator objects used to calculate the value of each secondary column nested beneath any given primary column.
        Parameters:
        valueGenerators - The list of ColumnValueGenerator objects used to calculate the value of each secondary column nested beneath any given primary column.

      • addScriptedValueGenerator

        public void addScriptedValueGenerator​(java.lang.String label,
                                      java.util.function.BiFunction<nuix.Case,​java.lang.String,​java.lang.Object> expression)
        Adds a ColumnValueGenerator which calculates its value using the expression provided.
        Parameters:
        label - The label used for this secondary column
        expression - The expression used to calculate this secondary column's value. Expression is provided a Nuix Case object and query and should return an object such as a String or integer value.

      • getRowCategoryLabel

        public java.lang.String getRowCategoryLabel()
        Gets the overall row category label.
        Returns:
        The overall row category label.

      • setRowCategoryLabel

        public void setRowCategoryLabel​(java.lang.String rowCategoryLabel)
        Sets the overall row category label. For example if each row is a search term, then you might set the label to "Terms".
        Parameters:
        rowCategoryLabel - The overall row category label.

      • getColPrimaryCategoryLabel

        public java.lang.String getColPrimaryCategoryLabel()
        Gets the overall primary column category label.
        Returns:
        The overall primary column category label.

      • setColPrimaryCategoryLabel

        public void setColPrimaryCategoryLabel​(java.lang.String colPrimaryCategoryLabel)
        Sets the overall primary column category label. For example, if each primary column is a custodian name, then you might set the label to "Custodians".
        Parameters:
        colPrimaryCategoryLabel - The overall primary column label.

      • getScopeQuery

        public java.lang.String getScopeQuery()
        Gets the current scope query which scopes the overall item set reported on. A blank value is equivalent to no overall scope.
        Returns:
        The current overall scope query.

      • setScopeQuery

        public void setScopeQuery​(java.lang.String scopeQuery)
        Sets the current scope query which scopes the overall item set reported on. A blank value is equivalent to no overall scope.
        Parameters:
        scopeQuery - The overall scope query to use.

      • getBatchLoadMinDate

        public org.joda.time.DateTime getBatchLoadMinDate()
        Gets the minimum batch load date an item must have to be reported. A null value means batch load date is not to be considered.
        Returns:
        the minimum batch load date an item must have to be reported

      • setBatchLoadMinDate

        public void setBatchLoadMinDate​(org.joda.time.DateTime batchLoadMinDate)
        Sets the minimum batch load date an item must have to be reported. A null value means batch load date is not to be considered.
        Parameters:
        batchLoadMinDate - the minimum batch load date an item must have to be reported

      • getBatchLoadMaxDate

        public org.joda.time.DateTime getBatchLoadMaxDate()
        Gets the maximum batch load date an item must have to be reported. A null value means batch load date is not to be considered.
        Returns:
        the maximum batch load date an item must have to be reported

      • setBatchLoadMaxDate

        public void setBatchLoadMaxDate​(org.joda.time.DateTime batchLoadMaxDate)
        Sets the maximum batch load date an item must have to be reported. A null value means batch load date is not to be considered.
        Parameters:
        batchLoadMaxDate - the maximum batch load date an item must have to be reported

      • hasBatchLoadDateCriteria

        public boolean hasBatchLoadDateCriteria()

      • getFreezePanes

        public boolean getFreezePanes()
        Gets whether "freeze panes" will be applied to this sheet. When true, first column and first 2 rows will be frozen into place.
        Returns:
        Whether "freeze panes" will be applied to this sheet.

      • setFreezePanes

        public void setFreezePanes​(boolean freezePanes)
        Sets whether "freeze panes" will be applied to this sheet. When true, first column and first 2 rows will be frozen into place.
        Parameters:
        freezePanes - Whether "freeze panes" will be applied to this sheet.