Package adams.flow.transformer

Class CompareObjectTypes

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, ObjectPrefixHandler, Serializable, Comparable
    public class CompareObjectTypes
extends AbstractTransformer
implements ObjectPrefixHandler
    Compares the object types between objects from the two reports.
    The first report is considered 'ground truth'.

    Input/output:
    - accepts:
       adams.data.report.Report[]
    - generates:
       adams.data.spreadsheet.SpreadSheet


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: CompareObjectTypes
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this 
    actor encounters an error; the error gets propagated; useful for critical 
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 
    -prefix <java.lang.String> (property: prefix)
    The report field prefix used in the report.
    default: Object.
 
    -type-suffix <java.lang.String> (property: typeSuffix)
    The report field suffix for the type used in the report (ignored if empty
    ).
    default: 
 
    -type-find <adams.core.base.BaseRegExp> (property: typeFind)
    The regular expression to apply to the type, ignored if empty.
    default: 
 
    -type-replace <java.lang.String> (property: typeReplace)
    The replacement string to use with the replacement regular expression.
    default: 
 
    -min-overlap-ratio <double> (property: minOverlapRatio)
    The minimum ratio that an overlap must have before being considered an actual 
    overlap.
    default: 0.0
    minimum: 0.0
    maximum: 1.0
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Prefix

        protected String m_Prefix
        the object prefix to use.

      • m_TypeSuffix

        protected String m_TypeSuffix
        the object type suffix to use.

      • m_TypeFind

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

      • m_TypeReplace

        protected String m_TypeReplace
        the replacement for the type.

      • m_MinOverlapRatio

        protected double m_MinOverlapRatio
        the minimum overlap ratio to use.

    • Constructor Detail

      • CompareObjectTypes

        public CompareObjectTypes()

    • Method Detail

      • setPrefix

        public void setPrefix​(String value)
        Sets the field prefix used in the report.
        Specified by:
        setPrefix in interface ObjectPrefixHandler
        Parameters:
        value - the field prefix

      • prefixTipText

        public String prefixTipText()
        Returns the tip text for this property.
        Specified by:
        prefixTipText in interface ObjectPrefixHandler
        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 empty).
        Parameters:
        value - the field suffix

      • getTypeSuffix

        public String getTypeSuffix()
        Returns the field suffix for the type used in the report (ignored if empty).
        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 empty.
        Parameters:
        value - the expression

      • getTypeFind

        public BaseRegExp getTypeFind()
        Returns the regular expression to apply to the type, ignored if empty.
        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.

      • setTypeReplace

        public void setTypeReplace​(String value)
        Sets the replacement string to use with the replacement regular expression.
        Parameters:
        value - the replacement

      • getTypeReplace

        public String getTypeReplace()
        Returns the replacement string to use with the replacement regular expression.
        Returns:
        the replacement

      • typeReplaceTipText

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

      • setMinOverlapRatio

        public void setMinOverlapRatio​(double value)
        Sets the minimum overlap ratio to use.
        Parameters:
        value - the minimum ratio

      • getMinOverlapRatio

        public double getMinOverlapRatio()
        Returns the minimum overlap ratio to use.
        Returns:
        the minimum ratio

      • minOverlapRatioTipText

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

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        the Class of the generated tokens

      • updateType

        protected void updateType​(LocatedObject obj,
                          String typeKey)
        Updates the type if necessary.
        Parameters:
        obj - the object to update
        typeKey - the key of the type in the meta-data

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message