Класс SchemaFactory

protected SchemaFactory()

Конструктор для производных классов.

Конструктор ничего не делает.

Производные классы должны создавать объекты SchemaFactory, у которых есть null ErrorHandler и null LSResourceResolver.

public static SchemaFactory newDefaultInstance()

Создает новый экземпляр встроенной реализации SchemaFactory, используемой по умолчанию в системе.

public static SchemaFactory newInstance(String schemaLanguage)

Получает новый экземпляр SchemaFactory, поддерживающий указанный язык схем. Этот метод использует механизм поиска JAXP, чтобы определить и загрузить реализацию SchemaFactory, поддерживающую указанный язык схем.

Совет по устранению неполадок:

См. Properties.load(java.io.InputStream), чтобы узнать, как именно анализируется файл свойств. В частности, двоеточия «:» в файле свойств необходимо экранировать, поэтому убедитесь, что URI языков схем в нем правильно экранированы. Например:

http\://www.w3.org/2001/XMLSchema=org.acme.foo.XSSchemaFactory

public static SchemaFactory newInstance(String schemaLanguage, String factoryClassName, ClassLoader classLoader)

Получает новый экземпляр SchemaFactory по имени класса. SchemaFactory возвращается, если указанное имя класса фабрики соответствует указанному языку схем. Эта функция полезна, когда в пути к классам имеется несколько поставщиков. Она дает приложению больше контроля, поскольку позволяет указать, какой поставщик следует загрузить.

Совет по устранению неполадок

Установка системного свойства jaxp.debug приведет к тому, что этот метод будет выводить много отладочных сообщений в System.err о выполняемых действиях и местах поиска.

Если возникли проблемы, попробуйте выполнить следующее:

java -Djaxp.debug=1 YourProgram ....

public abstract boolean isSchemaLanguageSupported(String schemaLanguage)

Поддерживается ли указанная схема этой SchemaFactory?

public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException

Получает значение флага функции.

Имя функции — это любой URI с полным именем. Может случиться так, что SchemaFactory распознает имя функции, но временно не сможет вернуть ее значение.

Разработчики могут свободно (и даже поощряются) создавать собственные функции, используя имена на основе собственных URI.

public void setFeature(String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException

Задает функцию для этой SchemaFactory, объектов Schema, созданных этой фабрикой, и, как следствие, объектов Validator и ValidatorHandler, созданных этими объектами Schema.

Разработчикам и пользователям следует уделять особое внимание обработке специального объекта Schema, возвращаемого методом newSchema(). В некоторых случаях, например, когда SchemaFactory и класс, фактически загружающий схему, относятся к разным реализациям, функции SchemaFactory могут не наследоваться автоматически. Разработчикам следует убедиться, что такие функции, как безопасная обработка, явно заданы в обоих местах.

Имя функции — это любой URI с полным именем. Может случиться так, что SchemaFactory предоставляет значение функции, но не может изменить текущее значение.

Все реализации обязаны поддерживать функцию XMLConstants.FEATURE_SECURE_PROCESSING. Если для функции задано значение:

• true: реализация ограничит обработку XML в соответствии с установленными для нее ограничениями. Например, это могут быть ограничения на раскрытие сущностей и конструкции XML Schema, потребляющие большой объем ресурсов. Если обработка XML ограничена по соображениям безопасности, об этом будет сообщено вызовом зарегистрированного обработчика ErrorHandler.fatalError(SAXParseException exception). См. setErrorHandler(ErrorHandler errorHandler).
• false: реализация будет обрабатывать XML в соответствии со спецификациями XML, не учитывая возможные ограничения реализации.

public void setProperty(String name, Object object) throws SAXNotRecognizedException, SAXNotSupportedException

Задает значение свойства.

Имя свойства — это любой URI с полным именем. Может случиться так, что SchemaFactory распознает имя свойства, но не сможет изменить текущее значение.

Все реализации, поддерживающие JAXP 1.5 или более позднюю версию, обязаны поддерживать свойства XMLConstants.ACCESS_EXTERNAL_DTD и XMLConstants.ACCESS_EXTERNAL_SCHEMA.

• Доступ к внешним DTD в файлах схем ограничивается протоколами, указанными в свойстве XMLConstants.ACCESS_EXTERNAL_DTD. Если доступ запрещен из-за ограничений этого свойства при создании новой схемы, метод newSchema(Source), newSchema(File), newSchema(URL) или newSchema(Source[]) выбросит SAXException.

  Доступ к внешним DTD в исходных XML-файлах ограничивается протоколами, указанными в свойстве XMLConstants.ACCESS_EXTERNAL_DTD. Если доступ запрещен из-за ограничений этого свойства во время проверки, метод Validator.validate(Source) или Validator.validate(Source, Result) выбросит SAXException.

  Доступ к внешним ссылкам, указанным атрибутом schemaLocation, ограничивается протоколами, указанными в свойстве XMLConstants.ACCESS_EXTERNAL_SCHEMA. Если доступ запрещен из-за ограничений этого свойства во время проверки, метод Validator.validate(Source) или Validator.validate(Source, Result) выбросит SAXException.

  Доступ к внешним ссылкам, указанным элементами Import и Include, ограничивается протоколами, указанными в свойстве XMLConstants.ACCESS_EXTERNAL_SCHEMA. Если доступ запрещен из-за ограничений этого свойства при создании новой схемы, метод newSchema(Source), newSchema(File), newSchema(URL) или newSchema(Source[]) выбросит SAXException.

public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException

Получает значение свойства.

Имя свойства — это любой URI с полным именем. Может случиться так, что SchemaFactory распознает имя свойства, но временно не сможет вернуть его значение.

SchemaFactory не обязаны распознавать какие-либо конкретные имена свойств.

Разработчики могут свободно (и даже поощряются) создавать собственные свойства, используя имена на основе собственных URI.

public abstract void setErrorHandler(ErrorHandler errorHandler)

Задает ErrorHandler, которому будут передаваться ошибки, возникающие при вызове метода newSchema.

Обработчик ошибок можно использовать для настройки процесса обработки ошибок при разборе схемы. Если задан ErrorHandler, ошибки, обнаруженные при разборе схем, сначала будут передаваться в ErrorHandler.

Обработчик ошибок может немедленно прервать разбор схемы, выбросив из обработчика SAXException. Например, он может вывести ошибку на экран и попытаться продолжить обработку, нормально вернув управление из ErrorHandler.

Если из ErrorHandler выбрасывается любой Throwable (или экземпляр его производного класса), вызывающий метод newSchema получит тот же объект Throwable.

SchemaFactory не разрешается выбрасывать SAXException, предварительно не сообщив о ней обработчику ErrorHandler.

Приложения могут вызывать этот метод даже во время разбора Schema.

Если ErrorHandler равен null, реализация будет вести себя так, как если бы был задан следующий ErrorHandler:

class DraconianErrorHandler implements ErrorHandler {
    public void fatalError( SAXParseException e ) throws SAXException {
        throw e;
    }
    public void error( SAXParseException e ) throws SAXException {
        throw e;
    }
    public void warning( SAXParseException e ) throws SAXException {
        // noop
    }
}

При создании нового объекта SchemaFactory это поле изначально имеет значение null. Это поле НЕ будет наследоваться объектами Schema, Validator или ValidatorHandler, создаваемыми этой SchemaFactory.

public abstract ErrorHandler getErrorHandler()

Возвращает текущий ErrorHandler, заданный для этой SchemaFactory.

public abstract void setResourceResolver(LSResourceResolver resourceResolver)

Задает LSResourceResolver для настройки разрешения ресурсов при разборе схем.

SchemaFactory использует LSResourceResolver, когда необходимо найти внешние ресурсы при разборе схем; при этом конкретное определение «поиска внешних ресурсов» зависит от языка схем. Например, для W3C XML Schema к ним относятся файлы, которые <include>ируются или <import>ируются, а также DTD, на которые ссылаются файлы схем, и т. д.

Приложения могут вызывать этот метод даже во время разбора Schema.

Если LSResourceResolver равен null, реализация будет вести себя так, как если бы был задан следующий LSResourceResolver:

class DumbDOMResourceResolver implements LSResourceResolver {
    public LSInput resolveResource(
        String publicId, String systemId, String baseURI) {

        return null; // always return null
    }
}

Если LSResourceResolver выбрасывает RuntimeException (или экземпляр его производного класса), SchemaFactory прервет разбор, а вызывающий метод newSchema получит тот же объект RuntimeException.

При создании нового объекта SchemaFactory это поле изначально имеет значение null. Это поле НЕ будет наследоваться объектами Schema, Validator или ValidatorHandler, создаваемыми этой SchemaFactory.

public abstract LSResourceResolver getResourceResolver()

Возвращает текущий LSResourceResolver, заданный для этой SchemaFactory.

public Schema newSchema(Source schema) throws SAXException

Разбирает указанный источник как схему и возвращает его в виде схемы.

Это вспомогательный метод для newSchema(Source[] schemas).

public Schema newSchema(File schema) throws SAXException

Разбирает указанный File как схему и возвращает его в виде Schema.

Это вспомогательный метод для newSchema(Source schema).

public Schema newSchema(URL schema) throws SAXException

Разбирает указанный URL как схему и возвращает его в виде Schema.

Это вспомогательный метод для newSchema(Source schema).

public abstract Schema newSchema(Source[] schemas) throws SAXException

Разбирает указанные источники как схему и возвращает их в виде схемы.

Вызываемый метод прочитает все Source и объединит их в одну схему. Точная семантика объединения зависит от языка схем, для которого создан этот объект SchemaFactory.

Если задан ErrorHandler, вызываемый метод сообщит обработчику обо всех ошибках, обнаруженных в источниках. Если обработчик выбросит исключение, компиляция схемы будет прервана, а из этого метода будет выброшено то же исключение. Кроме того, после сообщения об ошибке обработчику вызываемый метод вправе прервать дальнейшую обработку, выбросив ее. Если обработчик ошибок не задан, вызываемый метод выбросит первую обнаруженную в источниках ошибку.

W3C XML Schema 1.0

Полученная схема содержит компоненты из указанных источников. Тот же результат можно было бы получить, если бы все эти источники были импортированы с соответствующими значениями schemaLocation и namespace в один документ схемы с другим targetNamespace и без собственных компонентов, при условии, что элементы import были бы указаны в том же порядке, что и источники. В разделе 4.2.3 рекомендации XML Schema описаны варианты, доступные процессорам в этом отношении. Хотя процессор должен одинаково обрабатывать источники схем JAXP и импорты XML Schema, поведение разных JAXP-совместимых анализаторов может различаться; в частности, анализаторы могут игнорировать все <import> для заданного пространства имен, кроме первого, независимо от сведений, указанных в schemaLocation.

Если в разобранном наборе схем имеются ошибки, описанные в разделе 5.1 спецификации XML Schema, об этих ошибках необходимо сообщить обработчику ErrorHandler.

RELAX NG

Для RELAX NG этот метод должен выбрасывать UnsupportedOperationException, если schemas.length!=1.

public abstract Schema newSchema() throws SAXException

Создает специальный объект Schema.

Точная семантика возвращаемого объекта Schema зависит от языка схем, для которого создан этот SchemaFactory.

Кроме того, реализации могут использовать свойства или функции, специфичные для реализации, чтобы изменить семантику этого метода.

Разработчикам реализаций и пользователям следует уделить особое внимание тому, как функции, заданные для этого SchemaFactory, обрабатываются этим специальным объектом Schema. В некоторых случаях, например, когда SchemaFactory и класс, фактически загружающий схему, относятся к разным реализациям, функции SchemaFactory могут не наследоваться автоматически. Разработчикам следует убедиться, что такие функции, как безопасная обработка, явно заданы в обоих местах.

W3C XML Schema 1.0

Для XML Schema этот метод создает объект Schema, который выполняет проверку с использованием указаний о расположении, заданных в документах.

Возвращаемый объект Schema предполагает, что документы, ссылающиеся на один и тот же URL в указаниях о расположении схемы, всегда будут разрешаться в один и тот же документ схемы. Это предположение позволяет реализациям повторно использовать результаты разбора документов схем, благодаря чему выполнение нескольких проверок с использованием одной и той же схемы ускоряется.

Обратите внимание, что использование указаний о расположении схемы создает уязвимость к атакам типа «отказ в обслуживании».

RELAX NG

RELAX NG не поддерживает эту операцию.