Package adams.flow.transformer

Class GetJsonValue

  • 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 GetJsonValue
extends AbstractArrayProvider
    Obtains the value associated with the specified key from the JSON object passing through.
    Null values are only forwarded if requested.

    Input/output:
    - accepts:
       net.minidev.json.JSONAware
       net.minidev.json.JSONObject
       java.lang.String
    - generates:
       net.minidev.json.JSONObject


    -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: GetJsonValue
 
    -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 JSON values as array or one-by-one.
    default: false
 
    -path <adams.core.base.JsonPathExpression> (property: path)
    The path (or key if not starting with '$') of the value(s) to retrieve.
    default:
    more: https://github.com/json-path/JsonPath
 
    -data-type <BOOLEAN|NUMBER|STRING|OBJECT|ARRAY> (property: dataType)
    The type of the data that is output.
    default: OBJECT
 
    -forward-null <boolean> (property: forwardNull)
    If enabled, null values are forward as well.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_DataType

        protected JsonDataType m_DataType
        the output data type.

      • m_ForwardNull

        protected boolean m_ForwardNull
        whether to forward null values.

      • m_ActualPath

        protected transient com.jayway.jsonpath.JsonPath m_ActualPath
        the compiled path.

      • m_PathCompiled

        protected transient boolean m_PathCompiled
        whether path has been compiled.

    • Constructor Detail

      • GetJsonValue

        public GetJsonValue()

    • Method Detail

      • setPath

        public void setPath​(JsonPathExpression value)
        Sets the path (or simple key if not starting with $) of the value(s).
        Parameters:
        value - the path or key

      • getPath

        public JsonPathExpression getPath()
        Returns the path (or simple key if not starting with $) of the value(s).
        Returns:
        the path or key

      • pathTipText

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

      • setDataType

        public void setDataType​(JsonDataType value)
        Sets the type of the value(s).
        Parameters:
        value - the type

      • getDataType

        public JsonDataType getDataType()
        Returns the type of the value(s).
        Returns:
        the type

      • dataTypeTipText

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

      • setForwardNull

        public void setForwardNull​(boolean value)
        Sets whether to forward null values.
        Parameters:
        value - true if to forward

      • getForwardNull

        public boolean getForwardNull()
        Returns whether to forward null values.
        Returns:
        true if to forward

      • forwardNullTipText

        public String forwardNullTipText()
        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