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: * CatalogModel.java
044: *
045: * Created on October 11, 2005, 1:11 AM
046: */
047:
048: package org.netbeans.modules.xml.retriever.catalog;
049:
050: import java.beans.PropertyChangeListener;
051: import java.io.IOException;
052: import java.net.URI;
053: import java.util.Collection;
054: import org.netbeans.modules.xml.xam.dom.DocumentModel;
055: import org.netbeans.modules.xml.xam.locator.*;
056: import org.openide.filesystems.FileObject;
057:
058: /**
059: * API interface for all the operations exposed
060: * by the CatalogModel. There will be one Catalog file per Project.
061: * @author girix
062: */
063: public interface CatalogWriteModel extends CatalogModel {
064:
065: public static final String CATALOG_FILE_EXTENSION = ".xml";
066:
067: public static final String PUBLIC_CATALOG_FILE_NAME = "catalog";
068:
069: /**
070: * Given the location parameter (schemaLocation for schema and location for wsdl)
071: * this method should return the parget URI after looking up in the public catalog file
072: * This method will just look up in the public catalog file and return result.
073: * If not found in the catalog a null will be returned.
074: *
075: * @param locationURI
076: * @return URI
077: */
078: public URI searchURI(URI locationURI);
079:
080: /**
081: * Adds an URI to FileObject (in the same project) mapping in to the catalog.
082: * URI already present will be overwritten.
083: *
084: * This call might throw IllegalStateException if the catalog files are corrupted.
085: * Call isResolverStateValid() before calling this method to detect and avoid above exception
086: *
087: * @param locationURI
088: * @param fileObj
089: */
090: public void addURI(URI locationURI, FileObject fileObj)
091: throws IOException;
092:
093: /**
094: * Adds an URI to URI mapping in to the catalog.
095: * URI already present will be overwritten.
096: *
097: * This call might throw IllegalStateException if the catalog files are corrupted.
098: * Call isResolverStateValid() before calling this method to detect and avoid above exception
099: *
100: * @param locationURI
101: * @param alternateURI
102: */
103:
104: public void addURI(URI locationURI, URI alternateURI)
105: throws IOException;
106:
107: /**
108: * Remove a URI from the catalog.
109: * @param locationURI - locationURI to be removed.
110: */
111: public void removeURI(URI locationURI) throws IOException;
112:
113: /**
114: * Returns list of all registered catalog entries
115: *
116: * This call might throw IllegalStateException if the catalog files are corrupted.
117: * Call isResolverStateValid() before calling this method to detect and avoid above exception
118: */
119: public Collection<CatalogEntry> getCatalogEntries();
120:
121: /**
122: * This method tell if the resolver is in a sane state to retrive the correct values.
123: * If false is returned means there is some problem with the resolver. For more information
124: * call getState() to get the exact status message. This method should be called before calling
125: * most of the resolver methods.
126: */
127: public boolean isWellformed();
128:
129: /**
130: * Returns the current satus of the resolver.
131: * Consult the return value and display appropriate messages to the user
132: */
133: public DocumentModel.State getState();
134:
135: /**
136: * Returns the FileObject of the catalog file that this object is bound to.
137: */
138: public FileObject getCatalogFileObject();
139:
140: public void addPropertychangeListener(PropertyChangeListener pcl);
141:
142: public void removePropertyChangeListener(PropertyChangeListener pcl);
143:
144: /**
145: * Adds nextCatalogFileURI to the catalog file as nextCatalog entry. If
146: * relativize is true and nextCatalogFileURI is absolute, then nextCatalogFileURI is
147: * relativized against this catalog file URI itself before writing.
148: */
149: public void addNextCatalog(URI nextCatalogFileURI,
150: boolean relativize) throws IOException;
151:
152: public void removeNextCatalog(URI nextCatalogFileRelativeURI)
153: throws IOException;
154:
155: }
|