← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to openide/util/src/org/openide/xml/EntityCatalog.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
openide/util/src/org/openide/xml/EntityCatalog.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
package org.openide.xml;
 
42
 
 
43
import org.openide.util.*;
 
44
import org.xml.sax.*;
 
45
 
 
46
import java.io.*;
 
47
 
 
48
import java.util.*;
 
49
 
 
50
import javax.swing.event.*;
 
51
 
 
52
 
 
53
/**
 
54
 * Entity resolver resolving all entities registered by modules.
 
55
 * Use {@link #getDefault} to get the master instance in system. Any parser working with
 
56
 * unknown XML documents should use it to avoid unnecessary Internet
 
57
 * connections.
 
58
 *
 
59
 * <p>You can register your own instances via lookup to add to the resolver pool,
 
60
 * for example using an XML file in the format defined by {@link #PUBLIC_ID},
 
61
 * but for reasons of performance and predictability during startup it is best to provide
 
62
 * the entity (e.g. some DTD you define) as the contents of a file in
 
63
 * the system filesystem, in the <samp>/xml/entities/</samp> folder, where the file path
 
64
 * beneath this folder is based on the public ID as follows:
 
65
 * <ol>
 
66
 * <li>US-ASCII alphanumeric characters and '_' are left as is.
 
67
 * <li>Spaces and various punctuation are converted to '_' (one per character).
 
68
 * <li>Initial '-//' is dropped.
 
69
 * <li>Final '//EN' is dropped.
 
70
 * <li>Exactly two forward slashes in a row are converted to one.
 
71
 * </ol>
 
72
 * Thus for example the public ID <samp>-//NetBeans//Entity&nbsp;Mapping&nbsp;Registration&nbsp;1.0//EN</samp>
 
73
 * would be looked for in the file <samp>/xml/entities/NetBeans/Entity_Mapping_Registration_1_0</samp>.
 
74
 * Naturally this only works if you are defining a fixed number of entities.
 
75
 * <p>It is recommended that the entity file in <samp>/xml/entities/</samp> also be given a file
 
76
 * attribute named <code>hint.originalPublicID</code> with a string value giving the public ID.
 
77
 *
 
78
 * @author  Petr Kuzel
 
79
 * @since   release 3.2
 
80
 */
 
81
public abstract class EntityCatalog implements EntityResolver {
 
82
    /**
 
83
     * DOCTYPE public ID defining grammar used for entity registrations.
 
84
     */
 
85
    public static final String PUBLIC_ID = "-//NetBeans//Entity Mapping Registration 1.0//EN"; // NOI18N
 
86
    private static EntityCatalog instance = new Forwarder();
 
87
 
 
88
    /** Get a master entity catalog which can delegate to any others that have
 
89
     * been registered via lookup.
 
90
     */
 
91
    public static EntityCatalog getDefault() {
 
92
        return instance;
 
93
    }
 
94
 
 
95
    /**
 
96
     * This catalog is forwarding implementation.
 
97
     */
 
98
    private static class Forwarder extends EntityCatalog {
 
99
        private Lookup.Result<EntityCatalog> result;
 
100
 
 
101
        Forwarder() {
 
102
        }
 
103
 
 
104
        public InputSource resolveEntity(String publicID, String systemID)
 
105
        throws IOException, SAXException {
 
106
            if (result == null) {
 
107
                Lookup.Template<EntityCatalog> temp = new Lookup.Template<EntityCatalog>(EntityCatalog.class);
 
108
                result = Lookup.getDefault().lookup(temp);
 
109
            }
 
110
 
 
111
            for (EntityCatalog res : result.allInstances()) {
 
112
                // using resolver's method because EntityCatalog extends EntityResolver
 
113
                InputSource is = res.resolveEntity(publicID, systemID);
 
114
 
 
115
                if (is != null) {
 
116
                    return is;
 
117
                }
 
118
            }
 
119
 
 
120
            return null;
 
121
        }
 
122
    }
 
123
}