KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jdom > contrib > ids > IdFactory


1 /*--
2
3  $Id: IdFactory.java,v 1.4 2004/12/11 00:01:54 jhunter Exp $
4
5  Copyright (C) 2001-2004 Jason Hunter & Brett McLaughlin.
6  All rights reserved.
7
8  Redistribution and use in source and binary forms, with or without
9  modification, are permitted provided that the following conditions
10  are met:
11
12  1. Redistributions of source code must retain the above copyright
13     notice, this list of conditions, and the following disclaimer.
14
15  2. Redistributions in binary form must reproduce the above copyright
16     notice, this list of conditions, and the disclaimer that follows
17     these conditions in the documentation and/or other materials
18     provided with the distribution.
19
20  3. The name "JDOM" must not be used to endorse or promote products
21     derived from this software without prior written permission. For
22     written permission, please contact <request_AT_jdom_DOT_org>.
23
24  4. Products derived from this software may not be called "JDOM", nor
25     may "JDOM" appear in their name, without prior written permission
26     from the JDOM Project Management <request_AT_jdom_DOT_org>.
27
28  In addition, we request (but do not require) that you include in the
29  end-user documentation provided with the redistribution and/or in the
30  software itself an acknowledgement equivalent to the following:
31      "This product includes software developed by the
32       JDOM Project (http://www.jdom.org/)."
33  Alternatively, the acknowledgment may be graphical using the logos
34  available at http://www.jdom.org/images/logos.
35
36  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
40  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  SUCH DAMAGE.
48
49  This software consists of voluntary contributions made by many
50  individuals on behalf of the JDOM Project and was originally
51  created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
52  Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
53  on the JDOM Project, please see <http://www.jdom.org/>.
54
55  */
56
57 package org.jdom.contrib.ids;
58
59 import org.jdom.Attribute;
60 import org.jdom.Document;
61 import org.jdom.DocType;
62 import org.jdom.Element;
63 import org.jdom.Namespace;
64 import org.jdom.DefaultJDOMFactory;
65
66 /**
67  * The <code>IdFactory</code> extends the default JDOM factory to
68  * build documents that support looking up elements using their ID
69  * attribute.
70  * <p>
71  * Looking-up elements by ID only works if a DTD is associated to
72  * the XML document as the information defining some attributes as
73  * IDs is only available from the DTD and not from the XML document
74  * itself.</p>
75  * <p>
76  * The Documents created by this factory are instances of
77  * {@link IdDocument} which provides the method
78  * {@link IdDocument#getElementById} to look up an element given the
79  * value of its ID attribute.</p>
80  * <p>
81  * The following code snippet demonstrates how to use the
82  * <code>IdFactory</code> with JDOM's SAXBuilder to create an
83  * <code>IdDocument</code>.</p>
84  * <blockquote><pre>
85  * SAXBuilder builder = new SAXBuilder();
86  * builder.setFactory(new IdFactory());
87  *
88  * IdDocument doc = (IdDocument)(builder.build(xmlDocument));
89  *
90  * Element elt = doc.getElementById(idValue);
91  * </pre></blockquote>
92  *
93  * @author Laurent Bihanic
94  */
95 public class IdFactory extends DefaultJDOMFactory {
96
97     /**
98      * Creates a new IdFactory object.
99      */
100     public IdFactory() {
101        super();
102     }
103
104     // Allow Javadocs to inherit from superclass
105
106     public Attribute attribute(String JavaDoc name, String JavaDoc value, Namespace namespace) {
107         return new IdAttribute(name, value, namespace);
108     }
109
110     public Attribute attribute(String JavaDoc name, String JavaDoc value,
111                                             int type, Namespace namespace) {
112         return new IdAttribute(name, value, type, namespace);
113     }
114
115     public Attribute attribute(String JavaDoc name, String JavaDoc value) {
116         return new IdAttribute(name, value);
117     }
118
119     public Attribute attribute(String JavaDoc name, String JavaDoc value, int type) {
120         return new IdAttribute(name, value, type);
121     }
122
123     public Document document(Element rootElement, DocType docType) {
124         return new IdDocument(rootElement, docType);
125     }
126     public Document document(Element rootElement) {
127         return new IdDocument(rootElement);
128     }
129
130     public Element element(String JavaDoc name, Namespace namespace) {
131         return new IdElement(name, namespace);
132     }
133     public Element element(String JavaDoc name) {
134         return new IdElement(name);
135     }
136     public Element element(String JavaDoc name, String JavaDoc uri) {
137         return new IdElement(name, uri);
138     }
139     public Element element(String JavaDoc name, String JavaDoc prefix, String JavaDoc uri) {
140         return new IdElement(name, prefix, uri);
141     }
142 }
143
144
Popular Tags