Class NodeModel

    • Constructor Detail

      • NodeModel

        protected NodeModel​(Node node)
    • Method Detail

      • setDocumentBuilderFactory

        public static void setDocumentBuilderFactory​(DocumentBuilderFactory docBuilderFactory)
        Sets the DOM Parser implementation to be used when building NodeModel objects from XML files.
      • getDocumentBuilderFactory

        public static DocumentBuilderFactory getDocumentBuilderFactory()
        Returns:
        the DOM Parser implementation that is used when building NodeModel objects from XML files.
      • setErrorHandler

        public static void setErrorHandler​(ErrorHandler errorHandler)
        sets the error handler to use when parsing the document.
      • getErrorHandler

        public static ErrorHandler getErrorHandler()
        Since:
        2.3.20
      • getNode

        public Node getNode()
        Returns:
        the underling W3C DOM Node object that this TemplateNodeModel is wrapping.
      • getNodeType

        public final String getNodeType()
                                 throws TemplateModelException
        Specified by:
        getNodeType in interface TemplateNodeModel
        Returns:
        a String describing the type of node this is. In the W3C DOM, this should be "element", "text", "attribute", etc. A TemplateNodeModel implementation that models other kinds of trees could return whatever it appropriate for that application. It can be null, if you don't want to use node-types.
        Throws:
        TemplateModelException
      • size

        public final int size()
        Specified by:
        size in interface TemplateSequenceModel
        Returns:
        the number of items in the list.
      • get

        public final TemplateModel get​(int i)
        Description copied from interface: TemplateSequenceModel
        Retrieves the i-th template model in this sequence.
        Specified by:
        get in interface TemplateSequenceModel
        Returns:
        the item at the specified index, or null if the index is out of bounds. Note that a null value is interpreted by FreeMarker as "variable does not exist", and accessing a missing variables is usually considered as an error in the FreeMarker Template Language, so the usage of a bad index will not remain hidden, unless the default value for that case was also specified in the template.
      • getNodeNamespace

        public String getNodeNamespace()
        Specified by:
        getNodeNamespace in interface TemplateNodeModel
        Returns:
        the XML namespace URI with which this node is associated. If this TemplateNodeModel implementation is not XML-related, it will almost certainly be null. Even for XML nodes, this will often be null.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • removeComments

        public static void removeComments​(Node node)
        Recursively removes all comment nodes from the subtree.
        See Also:
        simplify(org.w3c.dom.Node)
      • removePIs

        public static void removePIs​(Node node)
        Recursively removes all processing instruction nodes from the subtree.
        See Also:
        simplify(org.w3c.dom.Node)
      • mergeAdjacentText

        public static void mergeAdjacentText​(Node node)
        Merges adjacent text/cdata nodes, so that there are no adjacent text/cdata nodes. Operates recursively on the entire subtree. You thus lose information about any CDATA sections occurring in the doc.
        See Also:
        simplify(org.w3c.dom.Node)
      • simplify

        public static void simplify​(Node node)
        Removes comments and processing instruction, and then unites adjacent text nodes. Note that CDATA sections count as text nodes.
      • useDefaultXPathSupport

        public static void useDefaultXPathSupport()
        Tells the system to use (restore) the default (initial) XPath system used by this FreeMarker version on this system.
      • useJaxenXPathSupport

        public static void useJaxenXPathSupport()
                                         throws Exception
        Convenience method. Tells the system to use Jaxen for XPath queries.
        Throws:
        Exception - if the Jaxen classes are not present.
      • useXalanXPathSupport

        public static void useXalanXPathSupport()
                                         throws Exception
        Convenience method. Tells the system to use Xalan for XPath queries.
        Throws:
        Exception - if the Xalan XPath classes are not present.
      • useSunInternalXPathSupport

        public static void useSunInternalXPathSupport()
                                               throws Exception
        Throws:
        Exception
      • setXPathSupportClass

        public static void setXPathSupportClass​(Class cl)
        Set an alternative implementation of freemarker.ext.dom.XPathSupport to use as the XPath engine.
        Parameters:
        cl - the class, or null to disable XPath support.
      • getXPathSupportClass

        public static Class getXPathSupportClass()
        Get the currently used freemarker.ext.dom.XPathSupport used as the XPath engine. Returns null if XPath support is disabled.
      • getAdaptedObject

        public Object getAdaptedObject​(Class hint)
        Description copied from interface: AdapterTemplateModel
        Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.
        Specified by:
        getAdaptedObject in interface AdapterTemplateModel
        Parameters:
        hint - the desired class of the returned value. An implementation should make reasonable effort to retrieve an object of the requested class, but if that is impossible, it must at least return the underlying object as-is. As a minimal requirement, an implementation must always return the exact underlying object when hint.isInstance(underlyingObject) holds. When called with java.lang.Object.class, it should return a generic Java object (i.e. if the model is wrapping a scripting language object that is further wrapping a Java object, the deepest underlying Java object should be returned).
        Returns:
        the underlying object, or its value accommodated for the hint class.
      • explainTypeError

        public Object[] explainTypeError​(Class[] expectedClasses)
        Specified by:
        explainTypeError in interface freemarker.core._UnexpectedTypeErrorExplainerTemplateModel