Package com.inductiveautomation.factorypmi.plugins.reporting.components.rowselector

Class AbstractFilter

java.lang.Object
com.inductiveautomation.factorypmi.plugins.reporting.components.rowselector.AbstractFilter
All Implemented Interfaces:
Filter
Direct Known Subclasses:
CustomDateFilter, DayFilter, DiscreteFilter, MonthFilter, ShiftFilter, StringFilter, YearFilter
public abstract class AbstractFilter extends Object implements Filter

  • Field Details

    • columnName

      protected String columnName
      The column name in which to find the date.

    • iconPath

      protected String iconPath
      The path to the icon to be displayed. Can be null.

    • icon

      protected PathIcon icon
      The icon for this node itself

    • datasetInspected

      protected boolean datasetInspected
      Transient flag for validation attempted

    • columnIndex

      protected int columnIndex
      Transient column index number

    • isReverseSort

      protected boolean isReverseSort

  • Constructor Details

    • AbstractFilter

      public AbstractFilter()

  • Method Details

    • getColumnName

      public String getColumnName()
      Description copied from interface: Filter
      Returns the name of the column that this filter looks at
      Specified by:
      getColumnName in interface Filter

    • setColumnName

      public void setColumnName(String columnName)
      Description copied from interface: Filter
      Sets the column that the filter looks at
      Specified by:
      setColumnName in interface Filter

    • classify

      public Comparable classify(Dataset data, int row)
      Description copied from interface: Filter
      Returns a classification key for the given row in the dataset. If the row can't be classified for some reason, like the classification column not exsiting, null should be returned.
      Specified by:
      classify in interface Filter

    • invalidateCache

      public void invalidateCache()
      Description copied from interface: Filter
      Called when the dataset being passed to classify has changed. This is used for Filters who do some work up front on the DataSet the first time classify is called, such as calculating the column index that they are working on.
      Specified by:
      invalidateCache in interface Filter

    • classifyObject

      public abstract Comparable classifyObject(Object obj)

    • getIconPath

      public String getIconPath()
      Specified by:
      getIconPath in interface Filter

    • setIconPath

      public void setIconPath(String iconPath)
      Specified by:
      setIconPath in interface Filter

    • isReverseSort

      public boolean isReverseSort()
      Specified by:
      isReverseSort in interface Filter

    • setReverseSort

      public void setReverseSort(boolean isReverseSort)
      Specified by:
      setReverseSort in interface Filter

    • setIsReverseSort

      @Deprecated public void setIsReverseSort(boolean isReverseSort)
      Deprecated.
      This was the old method signature that caused IGN-1897. Leaving it here on the off chance somebody was calling this method from scripting.

    • copyProps

      protected void copyProps(AbstractFilter that)