net.sf.xisemele.api
Interface Element

All Superinterfaces:

java.io.Serializable

public interface Element
extends java.io.Serializable

Definição de interface para um elemento XML.

Um elemento na API Xisemele pode conter valor, filhos e atributos. O conceito de valor é a abstração do texto de determinado nó em um documento XML (Node.getTextContent()). Um determinado elemento que contém valor não poder ter elementos filhos e vice-versa. Veja o seguinte exemplo:

 <root>
   <elementA>123</elementA>
   <elementB>text value</elementB>
 </root>
 

Observe que o elemento elementA contém o valor "123" e o elemento elementB o valor "text value".

O conceito de filhos e atributos é equivalente ao da API W3C DOM.

Author:

Carlos Eduardo Coral.

Method Summary

Value	attribute(java.lang.String name) Retorna o valor de determinado atributo.
java.util.List<Attribute>	attributes() Retorna uma lista contendo instâncias de Attribute correspondentes aos atributos do elemento XML.
Element	child(int index) Retorna o elemento filho localizado na posição index especificada por parâmetro.
Element	child(java.lang.String name) Retorna o primeiro elemento filho localizado com o nome especificado por parâmetro.
java.util.List<Element>	children() Retorna uma lista contendo os filhos do elemento XML.
java.util.List<Element>	children(java.lang.String name) Retorna uma lista contendo os filhos do elemento XML com o nome especificado por parâmetro.
ValueList	childrenValue() Retorna instância de ValueList correspondente o valor dos filhos do elemento XML.
ValueList	childrenValue(java.lang.String name) Retorna instância de ValueList correspondente ao valor dos filhos do elemento XML com o nome especificado por parâmetro.
boolean	containsAttribute(java.lang.String name) Verifica se o elemento contém determinado atributo.
boolean	containsAttributes() Verifica se o elemento contém atributos.
boolean	containsChild(java.lang.String name) Verifica se o elemento contém algum filho com o nome especificado por parâmetro.
boolean	containsChildren() Verifica se o elemento contém elementos filhos.
java.lang.String	name() Retorna o nome do elemento.
org.w3c.dom.Node	node() Retorna a instância de org.w3c.dom.Node correspondente à instância de Element.
int	numberOfChildren() Retorna a quantidade de elementos filhos do elemento XML.
int	numberOfChildren(java.lang.String name) Retorna a quantidade de elementos filhos do elemento XML com o nome especificado por parâmetro.
java.lang.String	path() Retorna o path que representa a localização do elemento no documento XML.
Value	value() Retorna instância de Value correspondente ao valor do elemento XML.

Method Detail

name

java.lang.String name()

Retorna o nome do elemento.

Returns:

java.lang.String contendo o nome do elemento.

value

Value value()

Retorna instância de Value correspondente ao valor do elemento XML.

Se o elemento contiver filhos, a instância de Value retornada será uma implementação de objeto nulo, ou seja, todas as chamadas aos métodos do tipo asX() da instância de Value irão retornar o valor null.

Returns:

instância de Value correspondente ao valor do elemento ou um objeto nulo. O valor null nunca será retornado.

path

java.lang.String path()

Retorna o path que representa a localização do elemento no documento XML.

O formato do atalho retornado é correspondente ao que pode ser especificado como parâmetro para o método Reader.element(path).

Returns:

java.lang.String contendo o atalho correspondente à localizado do elemento no documento XML.

containsAttributes

boolean containsAttributes()

Verifica se o elemento contém atributos.

Returns:

true se o elemento tiver atributos.

containsAttribute

boolean containsAttribute(java.lang.String name)

Verifica se o elemento contém determinado atributo.

Parameters:

name - java.lang.String contendo o nome do atributo que será verificado.

Returns:

true se o elemento contiver o atributo especificado por parâmetro.

attribute

Value attribute(java.lang.String name)

Retorna o valor de determinado atributo.

Se o atributo não for localizado, a instância de Value retornada será uma implementação de objeto nulo, ou seja, todas as chamadas aos métodos do tipo asX() da instância de Value irá retornar o valor null.

Parameters:

name - java.lang.String contendo o nome do atributo do qual o valor será retornado.

Returns:

instância de Value contendo o valor do atributo especificado por parâmetro ou um objeto nulo. O valor null nunca será retornado.

attributes

java.util.List<Attribute> attributes()

Retorna uma lista contendo instâncias de Attribute correspondentes aos atributos do elemento XML.

Returns:

lista de Attribute contendo os atributos do elemento XML.

containsChildren

boolean containsChildren()

Verifica se o elemento contém elementos filhos.

Returns:

true se o elemento tiver elementos filhos.

numberOfChildren

int numberOfChildren()

Retorna a quantidade de elementos filhos do elemento XML.

Returns:

int contendo a quantidade de elementos filhos.

numberOfChildren

int numberOfChildren(java.lang.String name)

Retorna a quantidade de elementos filhos do elemento XML com o nome especificado por parâmetro.

Parameters:

name - java.lang.String contendo o nome dos elementos filhos que serão verificados.

Returns:

int contendo a quantidade de elementos filhos com o nome especificado por parâmetro.

child

Element child(int index)
              throws ElementIndexOutOfBoundsException

Retorna o elemento filho localizado na posição index especificada por parâmetro.

Parameters:

index - int contendo a posição do elemento filho que deverá ser retornado. Deve ser especificado um valor entre 0 e numberOfChildren() - 1. O valor 0 correspondente à primeira posição.

Returns:

instância de Element correspondente à posição especificada por parâmetro.

Throws:

ElementIndexOutOfBoundsException - exceção disparada caso a posição index especificada seja inválida.

containsChild

boolean containsChild(java.lang.String name)

Verifica se o elemento contém algum filho com o nome especificado por parâmetro.

Parameters:

name - java.lang.String contendo o nome que será verificado.

Returns:

true se o elemento contiver um filho com o nome especificado.

child

Element child(java.lang.String name)
              throws ChildNotFoundException

Retorna o primeiro elemento filho localizado com o nome especificado por parâmetro.

Parameters:

name - java.lang.String contendo o nome do elemento filho que deverá ser retornado.

Returns:

instância de Element que contém o nome especificado ou o valor null, caso não encontre nenhum elemento com esse nome.

Throws:

ChildNotFoundException - exceção disparada caso não seja encontrado elemento filho com o nome especificado por parâmetro.

children

java.util.List<Element> children()

Retorna uma lista contendo os filhos do elemento XML.

Returns:

lista de Element correspondente aos filhos do elemento XML do qual o método foi chamado. O valor null nunca será retornado.

children

java.util.List<Element> children(java.lang.String name)

Retorna uma lista contendo os filhos do elemento XML com o nome especificado por parâmetro.

Parameters:

name - java.lang.String contendo o nome dos elementos filhos que deverão ser retornados.

Returns:

lista de Element correspondente aos filhos do elemento XML com o nome correspondente ao especificado por parâmetro. O valor null nunca será retornado.

childrenValue

ValueList childrenValue()

Retorna instância de ValueList correspondente o valor dos filhos do elemento XML.

Returns:

instância de ValueList correspondente ao valor dos filhos do elemento XML do qual o método foi chamado. O valor null nunca será retornado.

childrenValue

ValueList childrenValue(java.lang.String name)

Retorna instância de ValueList correspondente ao valor dos filhos do elemento XML com o nome especificado por parâmetro.

Parameters:

name - java.lang.String contendo o nome dos elementos filhos dos quais os seus valores deverão ser retornados.

Returns:

instância de ValueList correspondente ao valor dos filhos do elemento XML com o nome especificado por parâmetro. O valor null nunca será retornado.

node

org.w3c.dom.Node node()

Retorna a instância de org.w3c.dom.Node correspondente à instância de Element.

Returns:

instância de org.w3c.dom.Node correspondente.