001: /*
002: * Copyright (c) 2003 The Visigoth Software Society. All rights
003: * reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions
007: * are met:
008: *
009: * 1. Redistributions of source code must retain the above copyright
010: * notice, this list of conditions and the following disclaimer.
011: *
012: * 2. Redistributions in binary form must reproduce the above copyright
013: * notice, this list of conditions and the following disclaimer in
014: * the documentation and/or other materials provided with the
015: * distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowledgement:
019: * "This product includes software developed by the
020: * Visigoth Software Society (http://www.visigoths.org/)."
021: * Alternately, this acknowledgement may appear in the software itself,
022: * if and wherever such third-party acknowledgements normally appear.
023: *
024: * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
025: * project contributors may be used to endorse or promote products derived
026: * from this software without prior written permission. For written
027: * permission, please contact visigoths@visigoths.org.
028: *
029: * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
030: * nor may "FreeMarker" or "Visigoth" appear in their names
031: * without prior written permission of the Visigoth Software Society.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of the Visigoth Software Society. For more
049: * information on the Visigoth Software Society, please see
050: * http://www.visigoths.org/
051: */
052:
053: package freemarker.template;
054:
055: /**
056: * Describes objects that are nodes in a tree.
057: * If you have a tree of objects, they can be recursively
058: * <em>visited</em> using the <#visit...> and <#recurse...>
059: * FTL directives. This API is largely based on the W3C Document Object Model
060: * (DOM) API. However, it is meant to be generally useful for describing
061: * any tree of objects that you wish to navigate using a recursive visitor
062: * design pattern.
063: * @since FreeMarker 2.3
064: * @author <a href="mailto:jon@revusky.com">Jonathan Revusky</a>
065: */
066:
067: public interface TemplateNodeModel extends TemplateModel {
068:
069: /**
070: * @return the parent of this node or null, in which case
071: * this node is the root of the tree.
072: */
073: TemplateNodeModel getParentNode() throws TemplateModelException;
074:
075: /**
076: * @return a sequence containing this node's children.
077: * If the returned value is null or empty, this is essentially
078: * a leaf node.
079: */
080: TemplateSequenceModel getChildNodes() throws TemplateModelException;
081:
082: /**
083: * @return a String that is used to determine the processing
084: * routine to use. In the XML implementation, if the node
085: * is an element, it returns the element's tag name. If it
086: * is an attribute, it returns the attribute's name. It
087: * returns "@text" for text nodes, "@pi" for processing instructions,
088: * and so on.
089: */
090: String getNodeName() throws TemplateModelException;
091:
092: /**
093: * @return a String describing the <em>type</em> of node this is.
094: * In the W3C DOM, this should be "element", "text", "attribute", etc.
095: * A TemplateNodeModel implementation that models other kinds of
096: * trees could return whatever it appropriate for that application. It
097: * can be null, if you don't want to use node-types.
098: */
099: String getNodeType() throws TemplateModelException;
100:
101: /**
102: * @return the XML namespace URI with which this node is
103: * associated. If this TemplateNodeModel implementation is
104: * not XML-related, it will almost certainly be null. Even
105: * for XML nodes, this will often be null.
106: */
107: String getNodeNamespace() throws TemplateModelException;
108: }
|