Package adams.data.objectfilter

Class AttachOverlappingMetaData

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ObjectFilter, FlowContextHandler, Serializable
    public class AttachOverlappingMetaData
extends AbstractObjectFilter
    Attaches meta-data from the stored report 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -storage-name <adams.flow.control.StorageName> (property: storageName)
    The name of the report in storage to obtain the meta-data from.
    default: storage
 
    -finder <adams.data.objectfinder.ObjectFinder> (property: finder)
    The object finder for locating the objects of interest in the storage report.
    default: adams.data.objectfinder.AllFinder
 
    -overlap-detection <adams.data.objectoverlap.ObjectOverlap> (property: overlapDetection)
    The algorithm to use for determining the overlapping objects.
    default: adams.data.objectoverlap.AreaRatio
 
    -meta-data-key <adams.core.base.BaseString> [-meta-data-key ...] (property: metaDataKeys)
    The keys of the meta-data values to attach.
    default:
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_StorageName

        protected StorageName m_StorageName
        the storage item.

      • m_Finder

        protected ObjectFinder m_Finder
        the object finder to use.

      • m_OverlapDetection

        protected ObjectOverlap m_OverlapDetection
        the object overlap calculation to use.

      • m_MetaDataKeys

        protected BaseString[] m_MetaDataKeys
        the meta-data keys to attach.

    • Constructor Detail

      • AttachOverlappingMetaData

        public AttachOverlappingMetaData()

    • Method Detail

      • setStorageName

        public void setStorageName​(StorageName value)
        Sets the name of the report in storage to obtain the meta-data from.
        Parameters:
        value - the name

      • getStorageName

        public StorageName getStorageName()
        Returns the name of the report in storage to obtain the meta-data from.
        Returns:
        the name

      • storageNameTipText

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

      • setFinder

        public void setFinder​(ObjectFinder value)
        Sets the object finder for locating the objects in the storage report.
        Parameters:
        value - the finder

      • getFinder

        public ObjectFinder getFinder()
        Returns object finder for locating the objects in the storage report.
        Returns:
        the finder

      • finderTipText

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

      • setOverlapDetection

        public void setOverlapDetection​(ObjectOverlap value)
        Sets the algorithm for determining the overlapping objects
        Parameters:
        value - the algorithm

      • getOverlapDetection

        public ObjectOverlap getOverlapDetection()
        Returns the algorithm for determining the overlapping objects.
        Returns:
        the algorithm

      • overlapDetectionTipText

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

      • setMetaDataKeys

        public void setMetaDataKeys​(BaseString[] value)
        Sets the keys of the meta-data values to attach.
        Parameters:
        value - the keys

      • getMetaDataKeys

        public BaseString[] getMetaDataKeys()
        Returns the keys of the meta-data values to attach.
        Returns:
        the keys

      • metaDataKeysTipText

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

      • requiresFlowContext

        protected boolean requiresFlowContext()
        Returns whether flow context is actually required.
        Overrides:
        requiresFlowContext in class AbstractObjectFilter
        Returns:
        true if required

      • check

        protected String check​(LocatedObjects objects)
        Hook method for checking the object list before processing it.
        Overrides:
        check in class AbstractObjectFilter
        Parameters:
        objects - the object list to check
        Returns:
        null if successful, otherwise error message