SchemaModelReference


1   
2   /*
3    * The contents of this file are subject to the terms of the Common Development
4    * and Distribution License (the License). You may not use this file except in
5    * compliance with the License.
6    *
7    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
8    * or http://www.netbeans.org/cddl.txt.
9   
10   * When distributing Covered Code, include this CDDL Header Notice in each file
11   * and include the License file at http://www.netbeans.org/cddl.txt.
12   * If applicable, add the following below the CDDL Header, with the fields
13   * enclosed by brackets [] replaced by your own identifying information:
14   * "Portions Copyrighted [year] [name of copyright owner]"
15   *
16   * The Original Software is NetBeans. The Initial Developer of the Original
17   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
18   * Microsystems, Inc. All Rights Reserved.
19   */
20  
21  package org.netbeans.modules.xml.schema.model;
22  
23  import org.netbeans.modules.xml.xam.locator.CatalogModelException;
24  
25  /**
26   * The SchemaModelReference interface is implemented by classes which reference
27   * other schema models (Import, Include, and Redefine). This interface provides
28   * a uniform way of obtaining the referenced model.
29   * @author Chris Webster
30   */
31  public interface SchemaModelReference extends SchemaComponent {
32      public static final String   SCHEMA_LOCATION_PROPERTY = "schemaLocation";
33  
34          // TODO maybe use reference pattern Reference<SchemaModel> getModelReference()
35          // issue is Reference.get() cannot throw CatalogModelException, but that fall
36          // into the pattern Reference.isBroken(). 
37          // Maybe the pattern need Reference.getProblemDescription.
38          
39          /**
40       * obtain the model for the referenced schema. 
41       * 
42       * @throws CatalogModelException if the referenced model cannot
43       * be created.
44       */
45      SchemaModel resolveReferencedModel() throws CatalogModelException;
46  
47      
48      String   getSchemaLocation();
49      void setSchemaLocation(String   uri);
50  }
51
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags