libjava/javax/xml/validation/SchemaFactory.java

   1 /* SchemaFactory.java --
   2    Copyright (C) 2004, 2005  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package javax.xml.validation;
  39
  40 import java.io.File;
  41 import java.net.URL;
  42 import javax.xml.transform.Source;
  43 import javax.xml.transform.stream.StreamSource;
  44 import org.w3c.dom.ls.LSResourceResolver;
  45 import org.xml.sax.ErrorHandler;
  46 import org.xml.sax.SAXException;
  47 import org.xml.sax.SAXNotRecognizedException;
  48 import org.xml.sax.SAXNotSupportedException;
  49
  50 /**
  51  * Factory for obtaining schemata.
  52  *
  53  * @author (a href='mailto:dog@gnu.org'>Chris Burdess</a)
  54  * @since 1.3
  55  */
  56 public abstract class SchemaFactory
  57 {
  58
  59   ErrorHandler errorHandler;
  60
  61   protected SchemaFactory()
  62   {
  63   }
  64
  65   /**
  66    * Returns an implementation of <code>SchemaFactory</code> that supports
  67    * the specified schema language.
  68    * @param schemaLanguage the URI of a schema language (see
  69    * <code>XMLConstants</code>)
  70    */
  71   public static final SchemaFactory newInstance(String schemaLanguage)
  72   {
  73     // TODO
  74     throw new IllegalArgumentException(schemaLanguage);
  75   }
  76
  77   /**
  78    * Indicates whether the specified schema language is supported.
  79    * @param schemaLanguage the URI of a schema language (see
  80    * <code>XMLConstants</code>)
  81    */
  82   public abstract boolean isSchemaLanguageSupported(String schemaLanguage);
  83
  84   public boolean getFeature(String name)
  85     throws SAXNotRecognizedException, SAXNotSupportedException
  86   {
  87     throw new SAXNotRecognizedException(name);
  88   }
  89
  90   public void setFeature(String name, boolean value)
  91     throws SAXNotRecognizedException, SAXNotSupportedException
  92   {
  93     throw new SAXNotRecognizedException(name);
  94   }
  95
  96   public Object getProperty(String name)
  97     throws SAXNotRecognizedException, SAXNotSupportedException
  98   {
  99     throw new SAXNotRecognizedException(name);
 100   }
 101
 102   public void setProperty(String name, Object value)
 103     throws SAXNotRecognizedException, SAXNotSupportedException
 104   {
 105     throw new SAXNotRecognizedException(name);
 106   }
 107
 108   public ErrorHandler getErrorHandler()
 109   {
 110     return errorHandler;
 111   }
 112
 113   public void setErrorHandler(ErrorHandler errorHandler)
 114   {
 115     this.errorHandler = errorHandler;
 116   }
 117
 118   public abstract LSResourceResolver getResourceResolver();
 119
 120   public abstract void setResourceResolver(LSResourceResolver resourceResolver);
 121
 122   /**
 123    * Returns a schema based on the specified source resource.
 124    * @param schema the source resource
 125    */
 126   public Schema newSchema(Source schema)
 127     throws SAXException
 128   {
 129     return newSchema(new Source[] { schema });
 130   }
 131
 132   /**
 133    * Returns a schema based on the specified source file.
 134    * @param schema the source resource
 135    */
 136   public Schema newSchema(File schema)
 137     throws SAXException
 138   {
 139     return newSchema(new StreamSource(schema));
 140   }
 141
 142   /**
 143    * Returns a schema based on the specified URL.
 144    * @param schema the source resource
 145    */
 146   public Schema newSchema(URL schema)
 147     throws SAXException
 148   {
 149     return newSchema(new StreamSource(schema.toString()));
 150   }
 151
 152   /**
 153    * Parses the specified sources, and combine them into a single schema.
 154    * The exact procedure and semantics of this depends on the schema
 155    * language.
 156    * @param schemata the schema resources to load
 157    */
 158   public abstract Schema newSchema(Source[] schemata)
 159     throws SAXException;
 160
 161   /**
 162    * Creates a special schema.
 163    * The exact semantics of this depends on the schema language.
 164    */
 165   public abstract Schema newSchema()
 166     throws SAXException;
 167
 168 }