org.netbeans.modules.xml.xam.locator
Interface CatalogModel

All Superinterfaces:
org.xml.sax.EntityResolver, org.w3c.dom.ls.LSResourceResolver
All Known Implementing Classes:
MyCatalogModel, MyCatalogModel

public interface CatalogModel
extends org.xml.sax.EntityResolver, org.w3c.dom.ls.LSResourceResolver

Author:
girix

Method Summary
 ModelSource getModelSource(java.net.URI locationURI)
          Given the location parameter (schemaLocation for schema and location for wsdl) this method should return ModelSource object containing the concrete FileObject of the locally stored file.
 ModelSource getModelSource(java.net.URI locationURI, ModelSource modelSourceOfSourceDocument)
          Given the location parameter (schemaLocation for schema and location for wsdl) this method should return ModelSource object containing the concrete FileObject of the locally stored file.
 
Methods inherited from interface org.xml.sax.EntityResolver
resolveEntity
 
Methods inherited from interface org.w3c.dom.ls.LSResourceResolver
resolveResource
 

Method Detail

getModelSource

ModelSource getModelSource(java.net.URI locationURI)
                           throws CatalogModelException
Given the location parameter (schemaLocation for schema and location for wsdl) this method should return ModelSource object containing the concrete FileObject of the locally stored file. This method will just look up in the public catalog file and return result. It Will NOT do relative path resolution.

Parameters:
locationURI -
Returns:
ModelSource
Throws:
CatalogModelException - CatalogModelException will be throw for the following: 1. If the file that was supposed to be there but not found. This case a FileNotFoundException is wrapped inside 2. If a (java)File object could not be created from the retrived catalog entry.URISyntaxException will be wrapped inside DepResolverException. 3. IOException will be wrapped around if a (NB)FileObject could not be created from the File object for various reasons by NB module

getModelSource

ModelSource getModelSource(java.net.URI locationURI,
                           ModelSource modelSourceOfSourceDocument)
                           throws CatalogModelException
Given the location parameter (schemaLocation for schema and location for wsdl) this method should return ModelSource object containing the concrete FileObject of the locally stored file. This method will just look up in the public catalog file and return result. If not found in the catalog will then do relative path resolution against modelSourceOfSourceDocument's FileObject. Relative locations should be resolved using this method

Parameters:
locationURI -
modelSourceOfSourceDocument -
Returns:
ModelSource
Throws:
CatalogModelException - CatalogModelException will be throw for the following: 1. If the file that was supposed to be there but not found. This case a FileNotFoundException is wrapped inside 2. If a (java)File object could not be created from the retrived catalog entry.URISyntaxException will be wrapped inside DepResolverException. 3. IOException will be wrapped around if a (NB)FileObject could not be created from the File object for various reasons by NB module