KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > xquark > xpath > TypedXTreeBuilder


1 /*
2  * This file belongs to the XQuark distribution.
3  * Copyright (C) 2003 Universite de Versailles Saint-Quentin.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307.
18  * You can also get it at http://www.gnu.org/licenses/lgpl.html
19  *
20  * For more information on this software, see http://www.xquark.org.
21  */
22
23 package org.xquark.xpath;
24
25 import org.xquark.schema.Declaration;
26
27 /**
28  * This class allows the construction of specific implementations of XTree
29  * giving direct access to XML schema components.
30  *
31  * <p>Adding data to XTreeNode implementations is made possible by derivation
32  * of this object.</p>
33  * <p>Methods in this base class (except allocateNode) must not be overriden
34  * since they are used by other base implementation classes.</p>
35  *
36  */
37 public abstract class TypedXTreeBuilder extends XTreeBuilder
38 {
39     private static final String JavaDoc RCSRevision = "$Revision: 1.1 $";
40     private static final String JavaDoc RCSName = "$Name: $";
41
42     /**
43      * Default constructor.
44      */
45     public TypedXTreeBuilder()
46     {}
47
48     /**
49      * Constructor for adding nodes to an existing tree.
50      * @param tree an existing tree to enrich.
51      */
52     public TypedXTreeBuilder(XTree tree)
53     {
54         super(tree);
55     }
56
57     /**
58      * Creates an instance of <code>XTreeNode</code> or of its sub-class
59      * given a declaration.
60      *
61      * @param parent the parent node of the new node
62      * @param decl the XML schema declaration that will be used to create
63      */
64     public final TypedXTreeNode createTypedNode(
65         XTreeNode parent,
66         Declaration decl)
67     {
68         return (TypedXTreeNode) tree.register(allocateNode(parent, decl));
69     }
70
71     /**
72      * XTreeNode factory to implement. Implementation should create a new node
73      * derived from the base XTreeNode implementation and calling the "super"
74      * constructor that performs parent/child registration.
75      * @param parent parent node of the new node
76      * @param decl the XML schema declaration that will be used to create
77      * @return the new TypedXTreeNode (upcasted)
78      */
79     public abstract XTreeNode allocateNode(XTreeNode parent, Declaration decl);
80 }
81
Popular Tags