Класс XMLFilterImpl

public class XMLFilterImpl
extends Object
implements XMLFilter, EntityResolver, DTDHandler, ContentHandler, ErrorHandler

Базовый класс для получения XML-фильтра.

Этот модуль, как исходный код, так и документация, находится в общественном достоянии и не имеет ГАРАНТИЙ. См. http://www.saxproject.org для получения дополнительной информации.

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

Конструкторы

XMLFilterImpl

public XMLFilterImpl()

См. также:

XMLReader.setFeature(java.lang.String, boolean), XMLReader.setProperty(java.lang.String, java.lang.Object), setParent(org.xml.sax.XMLReader)

XMLFilterImpl

public XMLFilterImpl(XMLReader parent)

Создать XML-фильтр с указанным родительским элементом.

См. также:

setParent(org.xml.sax.XMLReader), getParent()

Методы

setParent

public void setParent(XMLReader parent)

Указано в:

setParent в интерфейсе XMLFilter

Параметры:

parent - Родительский XML reader.

См. также:

getParent()

getParent

public XMLReader getParent()

Получить родительский reader.

Указано в:

getParent в интерфейсе XMLFilter

Возвращает:

Родительский XML reader или null, если он не установлен.

См. также:

setParent(org.xml.sax.XMLReader)

setFeature

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

Указано в:

setFeature в интерфейсе XMLReader

Параметры:

name - Имя функции.

value - Запрошенное значение функции.

Исключения:

SAXNotRecognizedException - Если значение функции не может быть назначено или получено от родителя.

SAXNotSupportedException - Когда родитель распознает имя функции, но не может установить запрошенное значение.

См. также:

XMLReader.getFeature(java.lang.String)

getFeature

public boolean getFeature(String name)
                   throws SAXNotRecognizedException,
                          SAXNotSupportedException

Указано в:

getFeature в интерфейсе XMLReader

Параметры:

name - Имя функции.

Возвращает:

Текущее значение функции.

Исключения:

SAXNotRecognizedException - Если значение функции не может быть назначено или получено от родителя.

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

См. также:

XMLReader.setFeature(java.lang.String, boolean)

setProperty

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

Указано в:

setProperty в интерфейсе XMLReader

Параметры:

name - Имя свойства.

value - Запрошенное значение свойства.

Исключения:

SAXNotRecognizedException - Если значение свойства не может быть назначено или получено от родителя.

SAXNotSupportedException - Когда родитель распознает имя свойства, но не может установить запрошенное значение.

getProperty

public Object getProperty(String name)
                   throws SAXNotRecognizedException,
                          SAXNotSupportedException

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

Указано в:

getProperty в интерфейсе XMLReader

Параметры:

name - Имя свойства.

Возвращает:

Текущее значение свойства.

Исключения:

SAXNotRecognizedException - Если значение свойства не может быть назначено или получено от родителя.

SAXNotSupportedException - Когда родитель распознает имя свойства, но не может определить его значение в данный момент.

См. также:

XMLReader.setProperty(java.lang.String, java.lang.Object)

setEntityResolver

public void setEntityResolver(EntityResolver resolver)

Установить обработчик сущностей.

Указано в:

setEntityResolver в интерфейсе XMLReader

Параметры:

resolver - Новый обработчик сущностей.

См. также:

XMLReader.getEntityResolver()

getEntityResolver

public EntityResolver getEntityResolver()

Получить текущий обработчик сущностей.

Указано в:

getEntityResolver в интерфейсе XMLReader

Возвращает:

Текущий обработчик сущностей или null, если он не был установлен.

См. также:

XMLReader.setEntityResolver(org.xml.sax.EntityResolver)

setDTDHandler

public void setDTDHandler(DTDHandler handler)

Установить обработчик событий DTD.

Указано в:

setDTDHandler в интерфейсе XMLReader

Параметры:

handler - новый обработчик DTD

См. также:

XMLReader.getDTDHandler()

getDTDHandler

public DTDHandler getDTDHandler()

Получить текущий обработчик событий DTD.

Указано в:

getDTDHandler в интерфейсе XMLReader

Возвращает:

Текущий обработчик DTD или null, если он не был установлен.

См. также:

XMLReader.setDTDHandler(org.xml.sax.DTDHandler)

setContentHandler

public void setContentHandler(ContentHandler handler)

Установить обработчик событий содержимого.

Указано в:

setContentHandler в интерфейсе XMLReader

Параметры:

handler - новый обработчик содержимого

См. также:

XMLReader.getContentHandler()

getContentHandler

public ContentHandler getContentHandler()

Получить обработчик событий содержимого.

Указано в:

getContentHandler в интерфейсе XMLReader

Возвращает:

Текущий обработчик содержимого или null, если он не был установлен.

См. также:

XMLReader.setContentHandler(org.xml.sax.ContentHandler)

setErrorHandler

public void setErrorHandler(ErrorHandler handler)

Установить обработчик событий ошибок.

Указано в:

setErrorHandler в интерфейсе XMLReader

Параметры:

handler - новый обработчик ошибок

См. также:

XMLReader.getErrorHandler()

getErrorHandler

public ErrorHandler getErrorHandler()

Получить текущий обработчик событий ошибок.

Указано в:

getErrorHandler в интерфейсе XMLReader

Возвращает:

Текущий обработчик ошибок или null, если он не был установлен.

См. также:

XMLReader.setErrorHandler(org.xml.sax.ErrorHandler)

parse

public void parse(InputSource input)
           throws SAXException,
                  IOException

Разбор документа.

Указано в:

parse в интерфейсе XMLReader

Параметры:

input - Исходный входной поток для сущности документа.

Исключения:

SAXException - Любое исключение SAX, возможно, оборачивающее другое исключение.

IOException - Исключение ввода-вывода от парсера, возможно, из потока байтов или потока символов, предоставленного приложением.

См. также:

InputSource, XMLReader.parse(java.lang.String), XMLReader.setEntityResolver(org.xml.sax.EntityResolver), XMLReader.setDTDHandler(org.xml.sax.DTDHandler), XMLReader.setContentHandler(org.xml.sax.ContentHandler), XMLReader.setErrorHandler(org.xml.sax.ErrorHandler)

parse

public void parse(String systemId)
           throws SAXException,
                  IOException

Разбор документа.

Указано в:

parse в интерфейсе XMLReader

Параметры:

systemId - Системный идентификатор как полностью квалифицированный URI.

Исключения:

SAXException - Любое исключение SAX, возможно, оборачивающее другое исключение.

IOException - Исключение ввода-вывода от парсера, возможно, из потока байтов или потока символов, предоставленного приложением.

См. также:

XMLReader.parse(org.xml.sax.InputSource)

resolveEntity

public InputSource resolveEntity(String publicId,
                                 String systemId)
                          throws SAXException,
                                 IOException

Фильтрация разрешения внешней сущности.

Указано в:

resolveEntity в интерфейсе EntityResolver

Параметры:

publicId - Публичный идентификатор сущности или null.

systemId - Системный идентификатор сущности.

Возвращает:

Новый InputSource или null для значения по умолчанию.

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

IOException - Клиент может выбросить исключение, связанное с вводом-выводом, при получении нового InputSource.

См. также:

InputSource

notationDecl

public void notationDecl(String name,
                         String publicId,
                         String systemId)
                  throws SAXException

Фильтрация события объявления нотации.

Определено в:

notationDecl в интерфейсе DTDHandler

Параметры:

name - Имя обозначения.

publicId - Открытый идентификатор обозначения или null.

systemId - Системный идентификатор обозначения или null.

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

См. также:

DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String), Attributes

unparsedEntityDecl

public void unparsedEntityDecl(String name,
                               String publicId,
                               String systemId,
                               String notationName)
                        throws SAXException

Фильтрация события объявления неопределённой сущности.

Определено в:

unparsedEntityDecl в интерфейсе DTDHandler

Параметры:

name - Имя сущности.

publicId - Открытый идентификатор сущности или null.

systemId - Системный идентификатор сущности или null.

notationName - Имя связанного обозначения.

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

См. также:

DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String), Attributes

setDocumentLocator

public void setDocumentLocator(Locator locator)

Фильтрация события нового локейтора документа.

Определено в:

setDocumentLocator в интерфейсе ContentHandler

Параметры:

locator - Локейтор документа.

См. также:

Locator

startDocument

public void startDocument()
                   throws SAXException

Фильтрация события начала документа.

Определено в:

startDocument в интерфейсе ContentHandler

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

См. также:

ContentHandler.endDocument()

endDocument

public void endDocument()
                 throws SAXException

Фильтрация события окончания документа.

Определено в:

endDocument в интерфейсе ContentHandler

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

См. также:

ContentHandler.startDocument()

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException

Фильтрация события начала сопоставления префикса пространства имён.

Определено в:

startPrefixMapping в интерфейсе ContentHandler

Параметры:

prefix - Префикс пространства имён.

uri - URI пространства имён.

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

См. также:

ContentHandler.endPrefixMapping(java.lang.String), ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Фильтрация события окончания сопоставления префикса пространства имён.

Определено в:

endPrefixMapping в интерфейсе ContentHandler

Параметры:

prefix - Префикс пространства имён.

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

См. также:

ContentHandler.startPrefixMapping(java.lang.String, java.lang.String), ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes atts)
                  throws SAXException

Фильтрация события начала элемента.

Определено в:

startElement в интерфейсе ContentHandler

Параметры:

uri - URI пространства имён элемента или пустая строка.

localName - Локальное имя элемента или пустая строка.

qName - Квалифицированное (с префиксом) имя элемента или пустая строка.

atts - Атрибуты элемента.

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

См. также:

ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String), Attributes, AttributesImpl

endElement

public void endElement(String uri,
                       String localName,
                       String qName)
                throws SAXException

Фильтрация события окончания элемента.

Определено в:

endElement в интерфейсе ContentHandler

Параметры:

uri - URI пространства имён элемента или пустая строка.

localName - Локальное имя элемента или пустая строка.

qName - Квалифицированное (с префиксом) имя элемента или пустая строка.

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws SAXException

Фильтрация события данных символов.

Определено в:

characters в интерфейсе ContentHandler

Параметры:

ch - Массив символов.

start - Начальная позиция в массиве.

length - Количество символов из массива.

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

См. также:

ContentHandler.ignorableWhitespace(char[], int, int), Locator

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws SAXException

Фильтрация события игнорируемого пробела.

Определено в:

ignorableWhitespace в интерфейсе ContentHandler

Параметры:

ch - Массив символов.

start - Начальная позиция в массиве.

length - Количество символов из массива.

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

См. также:

ContentHandler.characters(char[], int, int)

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException

Фильтрация события инструкции обработки.

Определено в:

processingInstruction в интерфейсе ContentHandler

Параметры:

target - Цель инструкции обработки.

data - Текст после цели.

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Фильтрация события пропущенной сущности.

Определено в:

skippedEntity в интерфейсе ContentHandler

Параметры:

name - Имя пропущенной сущности.

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

warning

public void warning(SAXParseException e)
             throws SAXException

Фильтрация события предупреждения.

Определено в:

warning в интерфейсе ErrorHandler

Параметры:

e - Предупреждение как исключение.

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

См. также:

SAXParseException

error

public void error(SAXParseException e)
           throws SAXException

Фильтрация события ошибки.

Определено в:

error в интерфейсе ErrorHandler

Параметры:

e - Ошибка как исключение.

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

См. также:

SAXParseException

fatalError

public void fatalError(SAXParseException e)
                throws SAXException

Фильтрация события критической ошибки.

Определено в:

fatalError в интерфейсе ErrorHandler

Параметры:

e - Ошибка как исключение.

Исключения:

SAXException - Клиент может выбросить исключение во время обработки.

См. также:

SAXParseException