| java.lang.Object
 freemarker.ext.xml.NodeListModel
| NodeListModel | | public class NodeListModel implements TemplateHashModel,TemplateMethodModel,TemplateScalarModel,TemplateSequenceModel,TemplateNodeModel(Code) | | A data model adapter for three widespread XML document object model
representations: W3C DOM, dom4j, and JDOM. The adapter automatically
recognizes the used XML object model and provides a unified interface for it
toward the template. The model provides access to all XML InfoSet features
of the XML document and includes XPath support if it has access to the XPath-
evaluator library Jaxen. The model's philosophy (which closely follows that
of XML InfoSet and XPath) is as follows: it always wraps a list of XML nodes
(the "nodelist"). The list can be empty, can have a single element, or can
have multiple elements. Every operation applied to the model is applied to
all nodes in its nodelist. You usually start with a single- element nodelist,
usually the root element node or the document node of the XML tree.
Additionally, the nodes can contain String objects as a result of certain
evaluations (getting the names of elements, values of attributes, etc.)
Implementation note: If you are using W3C DOM documents
built by the Crimson XML parser (or you are using the built-in JDK 1.4 XML
parser, which is essentially Crimson), make sure you call
setNamespaceAware(true) on the
javax.xml.parsers.DocumentBuilderFactory instance used for document
building even when your documents don't use XML namespaces. Failing to do so,
you will experience incorrect behavior when using the documents wrapped with
this model.
freemarker.ext.dom.NodeModel
version:
$Id: NodeListModel.java,v 1.15 2004/01/06 17:06:43 szegedia Exp $
author:
Attila Szegedi |
| Constructor Summary | |
| public | NodeListModel(Object nodes)
Creates a new NodeListModel, wrapping the passed nodes.
Parameters:
nodes - you can pass it a single XML node from any supporteddocument model, or a Java collection containing any number of nodes.Passing null is prohibited. |
| NodeListModel | | public NodeListModel(Object nodes)(Code) | | Creates a new NodeListModel, wrapping the passed nodes.
Parameters:
nodes - you can pass it a single XML node from any supporteddocument model, or a Java collection containing any number of nodes.Passing null is prohibited. To create an empty model, pass it an emptycollection. If a collection is passed, all passed nodes must belong tothe same XML object model, i.e. you can't mix JDOM and dom4j in a singleinstance of NodeListModel. The model itself doesn't check for this condition,as it can be time consuming, but will throw spuriousClassCastExceptions when it encounters mixed objects.
throws:
IllegalArgumentException - if you pass null |
| get | | public TemplateModel get(String key) throws TemplateModelException(Code) | | Returns a new NodeListModel containing the nodes that result from applying
an operator to this model's nodes.
Parameters:
key - the operator to apply to nodes. Available operators are:| Key name | Evaluates to |
|---|
| * or _children | all direct element children of current nodes (non-recursive).Applicable to element and document nodes. | | @* or _attributes | all attributes of current nodes. Applicable to elements only. | | @attributeName | named attributes of current nodes. Applicable to elements, doctypes and processing instructions. On doctypes it supports attributes publicId, systemId and elementName. On processing instructions, it supports attributes target and data, as well as any other attribute name specified in data as name="value" pair on dom4j or JDOM models. The attribute nodes for doctype and processing instruction are synthetic, and as such have no parent. Note, however that @* does NOT operate on doctypes or processing instructions. | | _ancestor | all ancestors up to root element (recursive) of current nodes.Applicable to same node types as _parent. | | _ancestorOrSelf | all ancestors of current nodes plus current nodes. Applicable to same node types as _parent. | | _cname | the canonical names of current nodes (namespace URI + local name), one string per node (non-recursive). Applicable to elements and attributes | | _content | the complete content of current nodes, including children elements, text, entity references, and processing instructions (non-recursive). Applicable to elements and documents. | | _descendant | all recursive descendant element children of current nodes. Applicable to document and element nodes. | | _descendantOrSelf | all recursive descendant element children of current nodes plus current nodes. Applicable to document and element nodes. | | _document | all documents the current nodes belong to. Applicable to all nodes except text. | | _doctype | doctypes of the current nodes. Applicable to document nodes only. | | _filterType | is a filter-by-type template method model. When called, it will yield a node list that contains only those current nodes whose type matches one of types passed as argument. You can passas many string arguments as you want, each representing one ofthe types to select: "attribute", "cdata","comment", "document", "documentType", "element", "entity", "entityReference","namespace", "processingInstruction", or"text". | | _name | the names of current nodes, one string per node (non-recursive). Applicable to elements and attributes (returns their local names), entity references, processing instructions (returns its target), doctypes (returns its publicID) | | _nsprefix | the namespace prefixes of current nodes, one string per node (non-recursive). Applicable to elements and attributes | | _nsuri | the namespace URIs of current nodes, one string per node (non-recursive). Applicable to elements and attributes | | _parent | parent elements of current nodes. Applicable to element, attribute, comment, entity, processing instruction. | | _qname | the qualified names of current nodes in [namespacePrefix:]localName form, one string per node (non-recursive). Applicable to elements and attributes | | _registerNamespace(prefix, uri) | register a XML namespace with the specified prefix and URI forthe current node list and all node lists that are derived from the current node list. After registering, you can use thenodelist["prefix:localname"] or nodelist["@prefix:localname"] syntaxes to reach elements and attributes whose names are namespace-scoped.Note that the namespace prefix need not match the actual prefix used by the XML document itself since namespaces are compared solely by their URI. | | _text | the text of current nodes, one string per node (non-recursive). Applicable to elements, attributes, comments, processing instructions (returns its data) and CDATA sections. The reserved XML characters ('<' and '&') are NOT escaped. | | _type | Returns a string describing the type of nodes, onestring per node. The returned values are "attribute","cdata", "comment", "document","documentType", "element", "entity", "entityReference", "namespace", "processingInstruction", "text", or "unknown". | | _unique | a copy of the current nodes that keeps only the first occurrence of every node, eliminating duplicates. Duplicates canoccur in the node list by applying uptree-traversals _parent, _ancestor, _ancestorOrSelf,and _document on a node list with multiple elements. I.e. foo._children._parent will return a node list thathas duplicates of nodes in foo - each node will have the number of occurrences equal to the number of its children. In these cases, use foo._children._parent._unique to eliminate duplicates. Applicable to all node types. | | any other key | element children of current nodes with name matching the key. This allows for convenience child traversal in book.chapter.title style syntax. Applicable to document and element nodes. |
a new NodeListModel containing the nodes that result from applyingthe operator to this model's nodes.
See Also: freemarker.template.TemplateHashModel.get(String) |
| getAsString | | public String getAsString() throws TemplateModelException(Code) | | Returns the string representation of the wrapped nodes. String objects in
the nodelist are rendered as-is (with no XML escaping applied). All other
nodes are rendered in the default XML serialization format ("plain XML").
This makes the model quite suited for use as an XML-transformation tool.
the string representation of the wrapped nodes. String objectsin the nodelist are rendered as-is (with no XML escaping applied). Allother nodes are rendered in the default XML serialization format ("plainXML").
See Also: freemarker.template.TemplateScalarModel.getAsString |
| registerNamespace | | public void registerNamespace(String prefix, String uri)(Code) | | Registers a namespace prefix-URI pair for subsequent use in
NodeListModel.get(String) as well as for use in XPath expressions.
Parameters:
prefix - the namespace prefix to use for the namespace
Parameters:
uri - the namespace URI that identifies the namespace. |
|
|