Interface Filter<T extends DataContainer>

    • Method Detail

      • setDontUpdateID

        void setDontUpdateID​(boolean value)
        Sets whether ID update is suppressed.
        Parameters:
        value - true if to suppress
      • getDontUpdateID

        boolean getDontUpdateID()
        Returns whether ID update is suppressed.
        Returns:
        true if suppressed
      • dontUpdateIDTipText

        String dontUpdateIDTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • reset

        void reset()
        Resets the filter. Derived classes must call this method in set-methods of parameters to assure the invalidation of previously generated data.
      • cleanUp

        void cleanUp()
        Cleans up data structures, frees up memory. Sets the input and generated data to null.
        Specified by:
        cleanUp in interface CleanUpHandler
      • destroy

        void destroy()
        Frees up memory in a "destructive" non-reversible way.

        Calls cleanUp() and cleans up the options.
        Specified by:
        destroy in interface Destroyable
      • filter

        T filter​(T data)
        Returns the filtered data.
        Parameters:
        data - the data to filter
        Returns:
        the filtered data
      • compareTo

        int compareTo​(Object o)
        Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

        Only compares the commandlines of the two objects.
        Specified by:
        compareTo in interface Comparable<T extends DataContainer>
        Parameters:
        o - the object to be compared.
        Returns:
        a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
        Throws:
        ClassCastException - if the specified object's type prevents it from being compared to this object.
      • equals

        boolean equals​(Object o)
        Returns whether the two objects are the same.

        Only compares the commandlines of the two objects.
        Overrides:
        equals in class Object
        Parameters:
        o - the object to be compared
        Returns:
        true if the object is the same as this one
      • shallowCopy

        Filter<T> shallowCopy​(boolean expand)
        Returns a shallow copy of itself, i.e., based on the commandline options.
        Specified by:
        shallowCopy in interface ShallowCopySupporter<T extends DataContainer>
        Parameters:
        expand - whether to expand variables to their current values
        Returns:
        the shallow copy