← Back to branch summary

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

« back to all changes in this revision

Viewing changes to xml/xam/src/org/netbeans/modules/xml/xam/locator/CatalogModel.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:
xml/xam/src/org/netbeans/modules/xml/xam/locator/CatalogModel.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
 
 
42
/*
 
43
 * Locator.java
 
44
 *
 
45
 * Created on March 29, 2006, 3:44 PM
 
46
 *
 
47
 * To change this template, choose Tools | Template Manager
 
48
 * and open the template in the editor.
 
49
 */
 
50
 
 
51
package org.netbeans.modules.xml.xam.locator;
 
52
 
 
53
import java.net.URI;
 
54
import org.netbeans.modules.xml.xam.ModelSource;
 
55
import org.w3c.dom.ls.LSResourceResolver;
 
56
import org.xml.sax.EntityResolver;
 
57
 
 
58
/**
 
59
 *
 
60
 * @author girix
 
61
 */
 
62
public interface CatalogModel extends EntityResolver, LSResourceResolver{
 
63
    
 
64
    /**
 
65
     * Given the location parameter (schemaLocation for schema and location for wsdl)
 
66
     * this method should return ModelSource object containing the concrete FileObject
 
67
     * of the locally stored file. This method will just look up in the public catalog file
 
68
     * and return result. It Will NOT do relative path resolution.
 
69
     *
 
70
     * @param locationURI
 
71
     * @return ModelSource
 
72
     * @throws CatalogModelException
 
73
     * CatalogModelException will be throw for the following:<B></B>
 
74
     * 1. If the file that was supposed to be there but not found. This case a
 
75
     * FileNotFoundException is wrapped inside<B></B>
 
76
     * 2. If a (java)File object could not be created from the retrived catalog
 
77
     * entry.URISyntaxException will be wrapped inside DepResolverException.<B></B>
 
78
     * 3. IOException will be wrapped around if a (NB)FileObject could not be
 
79
     * created from the File object for various reasons by NB module
 
80
     */
 
81
    public ModelSource getModelSource(URI locationURI) throws CatalogModelException;
 
82
    
 
83
    
 
84
    /**
 
85
     * Given the location parameter (schemaLocation for schema and location for wsdl)
 
86
     * this method should return ModelSource object containing the concrete FileObject
 
87
     * of the locally stored file. This method will just look up in the public catalog file
 
88
     * and return result. If not found in the catalog will then do relative path resolution
 
89
     * against modelSourceOfSourceDocument's FileObject. Relative locations should be resolved using this method
 
90
     *
 
91
     * @param locationURI
 
92
     * @param modelSourceOfSourceDocument
 
93
     * @return ModelSource
 
94
     * @throws CatalogModelException
 
95
     * CatalogModelException will be throw for the following:<B></B>
 
96
     * 1. If the file that was supposed to be there but not found. This case a
 
97
     * FileNotFoundException is wrapped inside<B></B>
 
98
     * 2. If a (java)File object could not be created from the retrived catalog
 
99
     * entry.URISyntaxException will be wrapped inside DepResolverException.<B></B>
 
100
     * 3. IOException will be wrapped around if a (NB)FileObject could not be
 
101
     * created from the File object for various reasons by NB module
 
102
     */
 
103
    public ModelSource getModelSource(URI locationURI, ModelSource modelSourceOfSourceDocument) throws CatalogModelException;
 
104
    
 
105
}