001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: /*
043: * Locator.java
044: *
045: * Created on March 29, 2006, 3:44 PM
046: *
047: * To change this template, choose Tools | Template Manager
048: * and open the template in the editor.
049: */
050:
051: package org.netbeans.modules.xml.xam.locator;
052:
053: import java.net.URI;
054: import org.netbeans.modules.xml.xam.ModelSource;
055: import org.w3c.dom.ls.LSResourceResolver;
056: import org.xml.sax.EntityResolver;
057:
058: /**
059: *
060: * @author girix
061: */
062: public interface CatalogModel extends EntityResolver,
063: LSResourceResolver {
064:
065: /**
066: * Given the location parameter (schemaLocation for schema and location for wsdl)
067: * this method should return ModelSource object containing the concrete FileObject
068: * of the locally stored file. This method will just look up in the public catalog file
069: * and return result. It Will NOT do relative path resolution.
070: *
071: * @param locationURI
072: * @return ModelSource
073: * @throws CatalogModelException
074: * CatalogModelException will be throw for the following:<B></B>
075: * 1. If the file that was supposed to be there but not found. This case a
076: * FileNotFoundException is wrapped inside<B></B>
077: * 2. If a (java)File object could not be created from the retrived catalog
078: * entry.URISyntaxException will be wrapped inside DepResolverException.<B></B>
079: * 3. IOException will be wrapped around if a (NB)FileObject could not be
080: * created from the File object for various reasons by NB module
081: */
082: public ModelSource getModelSource(URI locationURI)
083: throws CatalogModelException;
084:
085: /**
086: * Given the location parameter (schemaLocation for schema and location for wsdl)
087: * this method should return ModelSource object containing the concrete FileObject
088: * of the locally stored file. This method will just look up in the public catalog file
089: * and return result. If not found in the catalog will then do relative path resolution
090: * against modelSourceOfSourceDocument's FileObject. Relative locations should be resolved using this method
091: *
092: * @param locationURI
093: * @param modelSourceOfSourceDocument
094: * @return ModelSource
095: * @throws CatalogModelException
096: * CatalogModelException will be throw for the following:<B></B>
097: * 1. If the file that was supposed to be there but not found. This case a
098: * FileNotFoundException is wrapped inside<B></B>
099: * 2. If a (java)File object could not be created from the retrived catalog
100: * entry.URISyntaxException will be wrapped inside DepResolverException.<B></B>
101: * 3. IOException will be wrapped around if a (NB)FileObject could not be
102: * created from the File object for various reasons by NB module
103: */
104: public ModelSource getModelSource(URI locationURI,
105: ModelSource modelSourceOfSourceDocument)
106: throws CatalogModelException;
107:
108: }
|