net.sf.xisemele.api
Interface Reader

All Superinterfaces:

java.io.Serializable

public interface Reader
extends java.io.Serializable

Definição de interface de leitura de XML.

Author:

Carlos Eduardo Coral.

Method Summary

boolean	containsElement(java.lang.String path) Verifica se há um elemento correspondente ao path especificado por parâmetro.
java.lang.String	encoding() Retorna o encoding do XML.
Element	find(java.lang.String path) Retorna o elemento correspondente ao path especificado por parâmetro.
Element	root() Retorna o elemento raiz do XML.
java.lang.String	version() Retorna a versão do XML.

Method Detail

version

java.lang.String version()

Retorna a versão do XML.

Returns:

java.lang.String contendo a versão do XML.

encoding

java.lang.String encoding()

Retorna o encoding do XML.

Returns:

java.lang.String contendo o encoding do XML.

root

Element root()

Retorna o elemento raiz do XML.

Returns:

instância de Element correspondente ao elemento raiz do XML.

containsElement

boolean containsElement(java.lang.String path)

Verifica se há um elemento correspondente ao path especificado por parâmetro.

Veja a sintaxe para path no método find(String).

Parameters:

path - java.lang.String correspondente ao elemento que será verificado.

Returns:

true se existir um elemento para o path especificado.

find

Element find(java.lang.String path)
             throws ElementNotFoundException

Retorna o elemento correspondente ao path especificado por parâmetro.

O valor de path indica o caminho para se chegar até o elemento desejado a partir do elemento raiz do documento XML. Cada elemento do caminho deve ser separado pelo caractere '/'.

Exemplo:
XML:

 <?xml version="1.0" encoding="UTF-8"?>
 <root>
   <level1>
     <level2 />
   </level1>
 </root>
 

Tabela contendo o elemento e o path correspondente.

Elemento	path
root	root
level1	root/level1
level2	root/level1/level2

A exceção ElementNotFoundException será disparada se o método não localizar um elemento para o path especificado. Portando, para evitar uma possível exceção, verifique se o elemento existe para o path consultando o método containsElement(String).

Parameters:

path - java.lang.String contendo o path para o elemento que deverá ser retornado.

Returns:

instância de Element correspondente ao path especificado ou o valor null caso não encontre.

Throws:

ElementNotFoundException - exceção disparada se não for localizado um elemento para o path especificado. Para previnir isso, verifique antes se a instância de Reader contém o elemento desejado.