Package adams.data.objectfinder

Class ObjectsInRegion

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LenientModeSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ObjectFinder, ObjectPrefixHandler, Serializable
    public class ObjectsInRegion
extends AbstractObjectFinder
    Locates the objects that fall into the defined region.
    Partial hits can be considered as well. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -prefix <java.lang.String> (property: prefix)
    The report field prefix used in the report.
    default: Object.
 
    -top <int> (property: top)
    The y position of the top-left corner.
    default: 1
    minimum: 1
 
    -left <int> (property: left)
    The x position of the top-left corner.
    default: 1
    minimum: 1
 
    -height <int> (property: height)
    The height of the region.
    default: 1
    minimum: 1
 
    -width <int> (property: width)
    The width of the region.
    default: 1
    minimum: 1
 
    -partial <boolean> (property: partial)
    If enabled, partial hits are included as well.
    default: false
 
    -one-based <boolean> (property: oneBased)
    If enabled, coordinates in the report are assumed to be 1-based instead
    of 0-based.
    default: false
 
    -check-type <boolean> (property: checkType)
    If enabled, the type of the objects gets checked as well.
    default: false
 
    -type-suffix <java.lang.String> (property: typeSuffix)
    The report field suffix for the type used in the report (ignored if no check
    ).
    default:
 
    -type-find <adams.core.base.BaseRegExp> (property: typeFind)
    The regular expression to apply to the type, ignored if no check.
    default:
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Top

        protected int m_Top
        the y of the top-left corner.

      • m_Left

        protected int m_Left
        the x of the top-left corner.

      • m_Height

        protected int m_Height
        the height of the window.

      • m_Width

        protected int m_Width
        the width of the window.

      • m_Partial

        protected boolean m_Partial
        whether to include partial hits.

      • m_OneBased

        protected boolean m_OneBased
        whether report contains one-based coordinates.

      • m_CheckType

        protected boolean m_CheckType
        whether to check the type (if a suffix provided).

      • m_TypeSuffix

        protected String m_TypeSuffix
        the suffix for the type.

      • m_TypeFind

        protected BaseRegExp m_TypeFind
        the regular expression to apply to the type.

    • Constructor Detail

      • ObjectsInRegion

        public ObjectsInRegion()

    • Method Detail

      • setTop

        public void setTop​(int value)
        Sets the y of the top-left corner.
        Parameters:
        value - the y

      • getTop

        public int getTop()
        Returns the y of the top-left corner.
        Returns:
        the y

      • topTipText

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

      • setLeft

        public void setLeft​(int value)
        Sets the x of the top-left corner.
        Parameters:
        value - the x

      • getLeft

        public int getLeft()
        Returns the x of the top-left corner.
        Returns:
        the x

      • leftTipText

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

      • setHeight

        public void setHeight​(int value)
        Sets the height of the crop rectangle.
        Parameters:
        value - the height, ignored if less than 1

      • getHeight

        public int getHeight()
        Returns the height of the region.
        Returns:
        the height

      • heightTipText

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

      • setWidth

        public void setWidth​(int value)
        Sets the width of the crop rectangle.
        Parameters:
        value - the width

      • getWidth

        public int getWidth()
        Returns the width of the region.
        Returns:
        the width

      • widthTipText

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

      • setPartial

        public void setPartial​(boolean value)
        Sets whether to include partial hits.
        Parameters:
        value - true if to include partial hits

      • getPartial

        public boolean getPartial()
        Returns whether to include partial hits.
        Returns:
        true if to count partial hits

      • partialTipText

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

      • setOneBased

        public void setOneBased​(boolean value)
        Sets whether to assume 1-based coordinates in report.
        Parameters:
        value - true if to use 1-based coordinates

      • getOneBased

        public boolean getOneBased()
        Returns whether to assume 1-based coordinates in report.
        Returns:
        true if to use 1-based coordinates

      • oneBasedTipText

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

      • setCheckType

        public void setCheckType​(boolean value)
        Sets whether to check the type as well.
        Parameters:
        value - true if to check

      • getCheckType

        public boolean getCheckType()
        Returns the field suffix for the type used in the report (ignored if empty).
        Returns:
        true if to check

      • checkTypeTipText

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

      • setTypeSuffix

        public void setTypeSuffix​(String value)
        Sets the field suffix for the type used in the report (ignored if no check).
        Parameters:
        value - the field suffix

      • getTypeSuffix

        public String getTypeSuffix()
        Returns the field suffix for the type used in the report (ignored if no check).
        Returns:
        the field suffix

      • typeSuffixTipText

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

      • setTypeFind

        public void setTypeFind​(BaseRegExp value)
        Sets the regular expression to apply to the type, ignored if no check.
        Parameters:
        value - the expression

      • getTypeFind

        public BaseRegExp getTypeFind()
        Returns the regular expression to apply to the type, ignored if no check.
        Returns:
        the expression

      • typeFindTipText

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

      • doFind

        protected int[] doFind​(LocatedObjects objects)
        Performs the actual finding of the objects in the list.
        Specified by:
        doFind in class AbstractObjectFinder
        Parameters:
        objects - the list of objects to process
        Returns:
        the indices