Package adams.flow.transformer

Class ViaAnnotationsToReports

  • All Implemented Interfaces:
    AdditionalInformationHandler, ArrayProvider, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ArrayProvider, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class ViaAnnotationsToReports
extends AbstractArrayProvider
    Converts the JSON object passing through to Reports.

    Input/output:
    - accepts:
       net.minidev.json.JSONObject
    - generates:
       adams.data.report.Report


    -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: ViaAnnotationsToReports
 
    -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
 
    -output-array <boolean> (property: outputArray)
    Whether to output the Reports as array or one-by-one.
    default: false
 
    -default-label <java.lang.String> (property: defaultLabel)
    Replaces empty labels with provided label. No default label if empty.
    default:
 
    -label-mapping <adams.core.base.BaseKeyValuePair> [-label-mapping ...] (property: labelMapping)
    Label mapping, in the form old=new\n. No label mapping if empty.
    default:
    Author:
    Hisham Abdel Qader (habdelqa at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_DefaultLabel

        protected String m_DefaultLabel
        the default label to replace empty labels.

      • m_LabelMapping

        protected BaseKeyValuePair[] m_LabelMapping
        the label mappings to use, in the format old=new\n.

      • m_Mappings

        protected Map<String,​String> m_Mappings
        the label mappings converted into a Map of (key,value) pairs.

    • Constructor Detail

      • ViaAnnotationsToReports

        public ViaAnnotationsToReports()

    • Method Detail

      • setDefaultLabel

        public void setDefaultLabel​(String value)
        Sets the default label.
        Parameters:
        value - the default label

      • getDefaultLabel

        public String getDefaultLabel()
        Returns the default label.
        Returns:
        the default label

      • defaultLabelTipText

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

      • setLabelMapping

        public void setLabelMapping​(BaseKeyValuePair[] value)
        Sets the label mappings.
        Parameters:
        value - the label mappings

      • getLabelMapping

        public BaseKeyValuePair[] getLabelMapping()
        Returns the label mappings.
        Returns:
        the label mappings

      • labelMappingTipText

        public String labelMappingTipText()
        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.
        Returns:
        the Class of objects that can be processed

      • doExecute

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