Package adams.flow.transformer

Class XMLFileReader

  • 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 XMLFileReader
extends AbstractTransformer
    Reads an XML file and forwards the parsed org.w3c.dom.Document object.

    Input/output:
    - accepts:
       java.lang.String
       java.io.File
    - generates:
       org.w3c.dom.Document


    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: XMLFileReader
 
    -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
 
    -validating <boolean> (property: validating)
    If enabled, the parser will validate the XML.
    default: false
 
    -name-space-aware <boolean> (property: nameSpaceAware)
    If enabled, the parser will be namespace aware.
    default: false
 
    -x-include-aware <boolean> (property: XIncludeAware)
    If enabled, the parser will be X-include aware.
    default: false
 
    -expand-entity-references <boolean> (property: expandEntityReferences)
    If enabled, the parser will expand entity references.
    default: false
 
    -ignoring-comments <boolean> (property: ignoringComments)
    If enabled, the parser will ignore comments.
    default: false
 
    -coalescing <boolean> (property: coalescing)
    If enabled, then parser will convert CDATA nodes to Text nodes and append 
    it to the adjacent (if any) text node.
    default: false
 
    -ignoring-whitespace <boolean> (property: ignoringWhitespace)
    If enabled, the parser will ignore whitespaces in element content.
    default: false
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Validating

        protected boolean m_Validating
        whether the parser is validating or not.

      • m_NameSpaceAware

        protected boolean m_NameSpaceAware
        whether the parser is namespace aware.

      • m_XIncludeAware

        protected boolean m_XIncludeAware
        Set state of XInclude processing.

      • m_ExpandEntityReferences

        protected boolean m_ExpandEntityReferences
        Specifies that the parser produced by this code will expand entity reference nodes.

      • m_IgnoringComments

        protected boolean m_IgnoringComments
        Specifies that the parser produced by this code will ignore comments.

      • m_Coalescing

        protected boolean m_Coalescing
        Specifies that the parser produced by this code will convert CDATA nodes to Text nodes and append it to the adjacent (if any) text node.

      • m_IgnoringWhitespace

        protected boolean m_IgnoringWhitespace
        Specifies that the parsers created by this factory must eliminate whitespace in element content.

    • Constructor Detail

      • XMLFileReader

        public XMLFileReader()

    • Method Detail

      • setValidating

        public void setValidating​(boolean value)
        Sets whether to use a validating parser.
        Parameters:
        value - true if to use validating parser

      • getValidating

        public boolean getValidating()
        Returns whether a validating parser is used.
        Returns:
        true if validating parser

      • validatingTipText

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

      • setNameSpaceAware

        public void setNameSpaceAware​(boolean value)
        Sets whether to use a namespace aware parser.
        Parameters:
        value - true if to use namespace aware parser

      • getNameSpaceAware

        public boolean getNameSpaceAware()
        Returns whether a namespace aware parser used.
        Returns:
        true if namespace aware

      • nameSpaceAwareTipText

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

      • setXIncludeAware

        public void setXIncludeAware​(boolean value)
        Sets whether to use a X-include aware parser.
        Parameters:
        value - true if to use X-include aware parser

      • getXIncludeAware

        public boolean getXIncludeAware()
        Returns whether a X-include aware parser is used.
        Returns:
        true if X-include aware parser

      • XIncludeAwareTipText

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

      • setExpandEntityReferences

        public void setExpandEntityReferences​(boolean value)
        Sets whether to expand entity references.
        Parameters:
        value - true if to expand entity references

      • getExpandEntityReferences

        public boolean getExpandEntityReferences()
        Returns whether a parser expands entity references.
        Returns:
        true if parser expands entity references

      • expandEntityReferencesTipText

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

      • setIgnoringComments

        public void setIgnoringComments​(boolean value)
        Sets whether to ignore comments.
        Parameters:
        value - true if to ignore comments

      • getIgnoringComments

        public boolean getIgnoringComments()
        Returns whether parser ignores comments
        Returns:
        true if comments ignored

      • ignoringCommentsTipText

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

      • setCoalescing

        public void setCoalescing​(boolean value)
        Sets whether to use a coalescing parser.
        Parameters:
        value - true if to use coalescing parser

      • getCoalescing

        public boolean getCoalescing()
        Returns whether a coalescing parser is used.
        Returns:
        true if coalescing parser

      • coalescingTipText

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

      • setIgnoringWhitespace

        public void setIgnoringWhitespace​(boolean value)
        Sets whether to ignore whitespaces in element content.
        Parameters:
        value - true if to ignore whitespaces in element content

      • getIgnoringWhitespace

        public boolean getIgnoringWhitespace()
        Returns whether parser ignores whitespaces in element content.
        Returns:
        true if whitespaces in element content ignored

      • ignoringWhitespaceTipText

        public String ignoringWhitespaceTipText()
        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:
        java.lang.String.class, java.io.File.class

      • generates

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

      • doExecute

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