tecgraf.javautils.xml
Interface XMLHandlerInterface

All Known Implementing Classes:

XMLBasicHandler

public interface XMLHandlerInterface

Interface para os handlers de eventos usados pelo parser. Define o conjunto de operações que devem ser implementadas pelo handler definido pela aplicação.

Author:

Andre Oliveira da Costa

Method Summary

void	characters(char[] ch, int start, int length) Evento de leitura de caracteres (CDATA).
void	endDocument() Callback executada ao final do processamento do documento.
void	endDocument(XMLElementInterface rootElement) Callback executada ao final do processamento do documento.
void	endElement(String uri, String localName, String qName) Evento de tag de fechamento de um elemento.
void	error(XMLException e) Evento associado a um erro.
void	fatalError(XMLException e) Evento associado a um erro fatal.
String	getDTD() Retorna o DTD associado ao documento.
InputSource	getInputSource() Retorna o inputSource associado ao handler.
XMLElementInterface	getRootElement() Retorna o elemento-raiz do documento
org.xml.sax.helpers.DefaultHandler	getSAXInternalHandler() Retorna o handler interno (SAX) usado por este handler.
XMLElementFactoryInterface	getXMLFactory() Retorna a fábrica de elementos XML associada ao handler.
InputSource	resolveEntity(String publicId, String systemId) Callback que permite à aplicação resolver "entidades externas".
void	setDTD(String dtd) Define o DTD associado ao elemento.
void	setInputSource(Reader input) Define o inputSource do handler a partir de um InputStream, usando um determinado encoding.
void	startElement(String uri, String localName, String qName, List<XMLAttribute> attributes) Evento de nova tag.
void	warning(XMLException e) Evento associado a um warning.

Method Detail

getRootElement

XMLElementInterface getRootElement()

Retorna o elemento-raiz do documento

Returns:

raiz

characters

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

Evento de leitura de caracteres (CDATA). Deve anexar os caracteres lidos ao valor do objeto atualmente no topo da pilha.

Parameters:

ch - array de caracteres contendo os caracteres lidos

start - início dos caracteres lidos no array

length - número de caracteres lidos

Throws:

XMLException - se houver algum problema no processamento

startElement

void startElement(String uri,
                  String localName,
                  String qName,
                  List<XMLAttribute> attributes)
                  throws XMLException

Evento de nova tag. Delega à factory a responsabilidade de criar o objeto correto. Coleta os atributos do elemento e os armazena em um mapa no próprio elemento. Se for o primeiro elemento a ser criado, identifica-o como raiz da árvore. FIXME comentar parâmetros

Parameters:

uri - .

localName - .

qName - .

attributes - lista de objetos do tipo XMLAttribute.

Throws:

XMLException - caso tenha havido algum problema no processamento

endElement

void endElement(String uri,
                String localName,
                String qName)
                throws XMLException

Evento de tag de fechamento de um elemento. Neste momento, temos que desempilhar quaisquer elementos que existam na pilha e defini-los como filhos do elemento em questão. É nesta hora também que o objeto da aplicação correspondente será criado (se for o caso). FIXME comentar parâmetros

Parameters:

uri - .

localName - .

qName - .

Throws:

XMLException - caso tenha havido algum problema no processamento

setInputSource

void setInputSource(Reader input)

Define o inputSource do handler a partir de um InputStream, usando um determinado encoding.

Parameters:

input - stream de entrada

getInputSource

InputSource getInputSource()

Retorna o inputSource associado ao handler.

Returns:

inputSource associado ao handler.

getDTD

String getDTD()

Retorna o DTD associado ao documento.

Returns:

DTD associado ao documento.

setDTD

void setDTD(String dtd)

Define o DTD associado ao elemento. Usado na escrita do XML.

Parameters:

dtd - o DTD

resolveEntity

InputSource resolveEntity(String publicId,
                          String systemId)
                          throws XMLException

Callback que permite à aplicação resolver "entidades externas". O uso mais comum para este método é interceptar a definição do DTD no documento (a URL do DTD é passada como parâmetro systemId)

Parameters:

publicId - - o "identificador público", ou null se nenhum tiver sido definido (normalmente, é null).

systemId - - o system identifier como definido no documento XML (p.ex. a URL do DTD)

Returns:

um novo InputSource para a entidade externa, ou null indicando que o tratamento default deve ser aplicado.

Throws:

XMLException

See Also:

EntityResolver.resolveEntity(java.lang.String, java.lang.String), InputSource

getXMLFactory

XMLElementFactoryInterface getXMLFactory()

Retorna a fábrica de elementos XML associada ao handler.

Returns:

um objeto que implemente XMLElementFactoryInterface

endDocument

void endDocument()
                 throws XMLException

Callback executada ao final do processamento do documento.

Throws:

XMLException

endDocument

void endDocument(XMLElementInterface rootElement)

Callback executada ao final do processamento do documento. Recebe como parâmetro o elemento-raiz do XML. Aplicações que precisem ser notificadas quando a leitura do documento for concluída devem redefinir este método.

Parameters:

rootElement - raiz do XML

warning

void warning(XMLException e)
             throws XMLException

Evento associado a um warning. Deve ser redefinido pelas subclasses.

Parameters:

e - - exceção

Throws:

XMLException - se a exceção precisar ser relançada

fatalError

void fatalError(XMLException e)
                throws XMLException

Evento associado a um erro fatal. Deve ser redefinido pelas subclasses.

Parameters:

e - - exceção

Throws:

XMLException - se a exceção precisar ser relançada

error

void error(XMLException e)
           throws XMLException

Evento associado a um erro. Deve ser redefinido pelas subclasses.

Parameters:

e - - exceção

Throws:

XMLException - se a exceção precisar ser relançada

getSAXInternalHandler

org.xml.sax.helpers.DefaultHandler getSAXInternalHandler()

Retorna o handler interno (SAX) usado por este handler.

Returns:

handler interno (SAX) usado por este handler