Класс 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, Schemas, созданных этой фабрикой, и, по расширению, Validators и ValidatorHandlers, созданными этими Schemas.

Реализаторы и разработчики должны уделить особое внимание тому, как обрабатывается специальный объект 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. Если доступ запрещён во время создания новой схемы из-за ограничения этого свойства, SAXException будет выброшен методом newSchema(Source) или newSchema(File) или newSchema(URL) или newSchema(Source[]).

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

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

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

public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException

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

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

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

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

public abstract void setErrorHandler(ErrorHandler errorHandler)

Устанавливает ErrorHandler для получения ошибок, возникших во время вызова метода newSchema.

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

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

Если любой Throwable (или экземпляры его производных классов) будет выброшен из ErrorHandler, вызывающий метод 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>d или <import>ed, и 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 не поддерживает эту операцию.