Package adams.data.objectfilter

Class KeepEnclosed

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ObjectFilter, FlowContextHandler, Serializable
    public class KeepEnclosed
extends AbstractObjectFilter
    Uses the outlines of annotations with the specified label to filter out any objects that aren't enclosed by these. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -key <java.lang.String> (property: key)
    The key in the meta-data containing the label.
    default: type
 
    -label <java.lang.String> (property: label)
    The label of the enclosing objects.
    default: object
 
    -allow-partial <boolean> (property: allowPartial)
    Whether to keep only partially enclosed objects as well.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Key

        protected String m_Key
        the key in the meta-data containing the labels.

      • m_Label

        protected String m_Label
        the label of the enclosing annotations.

      • m_AllowPartial

        protected boolean m_AllowPartial
        whether to allow partially enclosed objects.

    • Constructor Detail

      • KeepEnclosed

        public KeepEnclosed()

    • Method Detail

      • setKey

        public void setKey​(String value)
        Sets the key in the meta-data containing the label.
        Parameters:
        value - the key

      • getKey

        public String getKey()
        Returns the key in the meta-data containing the label.
        Returns:
        the key

      • keyTipText

        public String keyTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setLabel

        public void setLabel​(String value)
        Sets the label of the enclosing objects.
        Parameters:
        value - the label

      • getLabel

        public String getLabel()
        Returns the label of the enclosing objects.
        Returns:
        the label

      • labelTipText

        public String labelTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setAllowPartial

        public void setAllowPartial​(boolean value)
        Sets whether to keep partially enclosed objects as well.
        Parameters:
        value - true if to allow

      • getAllowPartial

        public boolean getAllowPartial()
        Returns whether to keep partially enclosed objects as well.
        Returns:
        true if to allow

      • allowPartialTipText

        public String allowPartialTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.