Package adams.flow.transformer

Class XPath

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class XPath
extends AbstractTransformer
    Applies XPath to the DOM document object.

    Input/output:
    - accepts:
       org.w3c.dom.Document
       org.w3c.dom.NodeList
       org.w3c.dom.Node
    - generates:
       org.w3c.dom.NodeList


    Valid options are: 

    -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: XPath
 
    -annotation <adams.core.base.BaseText> (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 gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -expression <adams.core.base.XPathExpression> (property: expression)
    The XPath expression to apply to the input.
    default: /*
 
    -result-type <NODESET|NODE|STRING|BOOLEAN|NUMBER> (property: resultType)
    The type of result that the XPath expression generates.
    default: NODESET
 
    -name-space <adams.core.base.BaseString> [-name-space ...] (property: nameSpaces)
    The namespaces to use as context for evaluating the expression; format: '
    prefix=URI'.
    default:
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Expression

        protected XPathExpression m_Expression
        the XPath expression to apply.

      • m_ResultType

        protected XPathResult m_ResultType
        the type of output to generate.

      • m_NameSpaces

        protected BaseString[] m_NameSpaces
        the namespaces to use (key=value).

      • m_NameSpaceContext

        protected NamespaceContext m_NameSpaceContext
        the namespace context.

    • Constructor Detail

      • XPath

        public XPath()

    • Method Detail

      • reset

        protected void reset()
        Resets the actor.
        Overrides:
        reset in class AbstractActor

      • setExpression

        public void setExpression​(XPathExpression value)
        Sets the expression to apply.
        Parameters:
        value - the type

      • getExpression

        public XPathExpression getExpression()
        Returns the expression to apply.
        Returns:
        the type

      • expressionTipText

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

      • setResultType

        public void setResultType​(XPathResult value)
        Sets the result type that the expression generates.
        Parameters:
        value - the type

      • getResultType

        public XPathResult getResultType()
        Returns the result type that the expression generates.
        Returns:
        the type

      • resultTypeTipText

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

      • setNameSpaces

        public void setNameSpaces​(BaseString[] value)
        Sets the namespaces to use. format: name=url
        Parameters:
        value - the namespaces in use

      • getNameSpaces

        public BaseString[] getNameSpaces()
        Returns the namespaces in use. format: name=url
        Returns:
        the namespaces

      • nameSpacesTipText

        public String nameSpacesTipText()
        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:
        org.w3c.dom.Document.class, org.w3c.dom.NodeList.class, org.w3c.dom.Node.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        org.w3c.dom.NodeList.class

      • doExecute

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