Class AbstractFilter.FilterJob<T extends DataContainer>

    • Field Detail

      • m_Filter

        protected Filter m_Filter
        the filter to use.
      • m_Data

        protected T extends DataContainer m_Data
        the data to push through the filter.
      • m_FilteredData

        protected T extends DataContainer m_FilteredData
        the filtered data.
    • Constructor Detail

      • FilterJob

        public FilterJob​(Filter filter,
                         T data)
        Initializes the job.
        Parameters:
        filter - the filter to use for filtering
        data - the data to pass through the filter
    • Method Detail

      • getFilter

        public Filter getFilter()
        Returns the filter being used.
        Returns:
        the filter in use
      • getData

        public T getData()
        The input data.
        Returns:
        the input data
      • getFilteredData

        public T getFilteredData()
        The output data, if any.
        Returns:
        the output data, or null in case of an error
      • preProcessCheck

        protected String preProcessCheck()
        Checks whether all pre-conditions have been met.
        Specified by:
        preProcessCheck in class AbstractJob
        Returns:
        null if everything is OK, otherwise an error message
      • process

        protected void process()
                        throws Exception
        Does the actual execution of the job.
        Specified by:
        process in class AbstractJob
        Throws:
        Exception - if fails to execute job
      • postProcessCheck

        protected String postProcessCheck()
        Checks whether all post-conditions have been met.
        Specified by:
        postProcessCheck in class AbstractJob
        Returns:
        null if everything is OK, otherwise an error message
      • getAdditionalErrorInformation

        protected String getAdditionalErrorInformation()
        Returns additional information to be added to the error message.
        Overrides:
        getAdditionalErrorInformation in class AbstractJob
        Returns:
        the additional information
      • toString

        public String toString()
        Returns a string representation of the job.
        Specified by:
        toString in class AbstractJob
        Returns:
        a string representation