net.sf.xisemele.api
Interface Editor

All Superinterfaces:

java.io.Serializable

public interface Editor
extends java.io.Serializable

Definição de interface de edição de documentos XML.

Author:

Carlos Eduardo Coral.

Method Summary

Editor	attribute(java.lang.String name, java.util.Date value, java.lang.String pattern) Especifica um novo atributo para o elemento corrente do documento XML.
Editor	attribute(java.lang.String name, java.lang.Object value) Especifica um novo atributo para o elemento corrente do documento XML.
boolean	containsElement(java.lang.String path) Verifica se há um elemento correspondente ao path especificado por parâmetro.
Editor	defineAsCurrent(java.lang.String path) Define o elemento correspondente ao path especificado por parâmetro como o elemento corrente.
org.w3c.dom.Document	document() Retorna instância de org.w3c.dom.Document correspondente ao documento XML criado.
Editor	element(Element element) Adiciona um novo Element no nível corrente do documento XML.
Editor	element(java.lang.String name) Adiciona um novo elemento com o nome especificado por parâmetro no nível corrente do documento XML.
Editor	element(java.lang.String name, java.util.Date value, java.lang.String pattern) Adiciona um novo elemento com o nome especificado por parâmetro no nível corrente do documento XML.
Editor	element(java.lang.String name, java.lang.Object value) Adiciona um novo elemento com o nome especificado por parâmetro no nível corrente do documento XML.
Editor	endWithin() Finaliza um nível da última chamada do método within().
Editor	remove() Remove o elemento corrente do documento XML.
Editor	removeAttribute(java.lang.String name) Remove o atributo do elemento corrente com o nome especificado por parâmetro.
Editor	removeAttributes() Remove todos os atributos do elemento corrente.
Editor	removeChild(java.lang.String name) Remove o primeiro filho do elemento corrente com o nome especificado por parâmetro.
Editor	removeChildren() Remove todos os filhos do elemento corrente.
Editor	removeChildren(java.lang.String name) Remove todos os filhos do elemento corrente com o nome especificado por parâmetro.
Editor	rename(java.lang.String newName) Renomeia o elemento corrente.
Result	result() Retorna instância de Result correspondente ao documento XML editado.
Editor	value(java.util.Date value, java.lang.String pattern) Atribui a data especificada como valor do elemento corrente.
Editor	value(java.lang.Object value) Atribui um valor para o elemento corrente.
Editor	within() Inicia um contexto para inserção de elementos filhos para o último elemento adicionado.

Method Detail

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 Reader.find(String).

Parameters:

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

Returns:

true se existir um elemento para o path especificado.

defineAsCurrent

Editor defineAsCurrent(java.lang.String path)
                       throws ElementNotFoundException

Define o elemento correspondente ao path especificado por parâmetro como o elemento corrente.

Parameters:

path - java.lang.String contendo o path do elemento que deverá ser definido como elemento corrente. Veja a sintaxe correta para o path na documentação do método Reader.find(String).

Returns:

instância corrente de Editor para permitir interface fluente.

Throws:

ElementNotFoundException - exceção disparada caso o elemento especificado em path não seja localizado.

remove

Editor remove()
              throws RemoveRootNotPermittedException

Remove o elemento corrente do documento XML. A partir desse momento, o elemento pai torna-se o elemento corrente.

Returns:

instância corrente de Editor para permitir interface fluente.

Throws:

RemoveRootNotPermittedException

removeChild

Editor removeChild(java.lang.String name)

Remove o primeiro filho do elemento corrente com o nome especificado por parâmetro.

Parameters:

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

Returns:

instância corrente de Editor para permitir interface fluente.

removeChildren

Editor removeChildren(java.lang.String name)

Remove todos os filhos do elemento corrente com o nome especificado por parâmetro.

Parameters:

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

Returns:

instância corrente de Editor para permitir interface fluente.

removeChildren

Editor removeChildren()

Remove todos os filhos do elemento corrente.

Returns:

instância corrente de Editor para permitir interface fluente.

removeAttribute

Editor removeAttribute(java.lang.String name)

Remove o atributo do elemento corrente com o nome especificado por parâmetro.

Parameters:

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

Returns:

instância corrente de Editor para permitir interface fluente.

removeAttributes

Editor removeAttributes()

Remove todos os atributos do elemento corrente.

Returns:

instância corrente de Editor para permitir interface fluente.

rename

Editor rename(java.lang.String newName)
              throws InvalidNameException

Renomeia o elemento corrente.

Parameters:

newName - java.lang.String contendo o novo nome que será atribuído ao elemento.

Returns:

instância corrente de Editor para permitir interface fluente.

Throws:

InvalidNameException - exceção disparada se for especificado um nome inválido.

value

Editor value(java.lang.Object value)
             throws ValueNotPermittedException

Atribui um valor para o elemento corrente.

Parameters:

value - instância de java.lang.Object correspondente ao valor que será atribuído ao elemento corrente.

Returns:

instância corrente de Editor para permitir interface fluente.

Throws:

ValueNotPermittedException - exceção disparada caso não seja permitido atribuir um valor para o elemento corrente.

value

Editor value(java.util.Date value,
             java.lang.String pattern)
             throws ValueNotPermittedException

Atribui a data especificada como valor do elemento corrente.

Parameters:

value - instância de java.util.Date que será atribuída como valor do elemento corrente.

pattern - java.lang.String contendo o padrâo que será aplicado na formatação da data especificada por parâmetro.

Returns:

instância corrente de Editor para permitir interface fluente.

Throws:

ValueNotPermittedException - exceção disparada caso não seja permitido atribuir um valor para o elemento corrente.

within

Editor within()
              throws WithinContextDuplicateException,
                     WithinContextNotPermittedException

Inicia um contexto para inserção de elementos filhos para o último elemento adicionado. Ou seja, os elementos adicionados a partir da chamada desse método serão filhos do último elemento adicionado.

Returns:

instância corrente de Editor para permitir interface fluente.

Throws:

WithinContextDuplicateException - exceção disparada caso esse método seja invocado duas vezes consecutivas.

WithinContextNotPermittedException - exceção disparada caso esse método seja invocado para um elemento corrente que já contenha valor.

endWithin

Editor endWithin()
                 throws NotWithinContextException

Finaliza um nível da última chamada do método within().

Returns:

instância corrente de Editor para permitir interface fluente.

Throws:

NotWithinContextException - exceção disparada caso o método seja chamado fora de um contexto within.

element

Editor element(java.lang.String name)
               throws RootDuplicateException,
                      InvalidNameException

Adiciona um novo elemento com o nome especificado por parâmetro no nível corrente do documento XML.

Parameters:

name - java.lang.String contendo o nome que será atribuído ao novo elemento.

Returns:

instância corrente de Editor para permitir interface fluente.

Throws:

RootDuplicateException - exceção disparada quando tentar adicionar mais de um elemento raiz no documento XML.

InvalidNameException - exceção disparada se for especificado um nome inválido.

element

Editor element(java.lang.String name,
               java.lang.Object value)
               throws RootDuplicateException,
                      InvalidNameException

Adiciona um novo elemento com o nome especificado por parâmetro no nível corrente do documento XML.

Parameters:

name - java.lang.String contendo o nome que será atribuído ao novo elemento.

value - objeto que será atribuído como valor do novo elemento.

Returns:

instância corrente de Editor para permitir interface fluente.

Throws:

RootDuplicateException - exceção disparada quando tentar adicionar mais de um elemento raiz no documento XML.

InvalidNameException - exceção disparada se for especificado um nome inválido.

element

Editor element(java.lang.String name,
               java.util.Date value,
               java.lang.String pattern)
               throws RootDuplicateException,
                      InvalidNameException

Adiciona um novo elemento com o nome especificado por parâmetro no nível corrente do documento XML.

Parameters:

name - java.lang.String contendo o nome que será atribuído ao novo elemento.

value - instância de java.util.Date que será atribuída como valor do novo elemento.

pattern - java.lang.String contendo o padrão que será aplicado na formatação da data especificada por parâmetro.

Returns:

instância corrente de Editor para permitir interface fluente.

Throws:

RootDuplicateException - exceção disparada quando tentar adicionar mais de um elemento raiz no documento XML.

InvalidNameException - exceção disparada se for especificado um nome inválido.

element

Editor element(Element element)
               throws RootDuplicateException

Adiciona um novo Element no nível corrente do documento XML.

Parameters:

element - instância de Element que será adicionada.

Returns:

instância corrente de Editor para permitir interface fluente.

Throws:

RootDuplicateException - exceção disparada quanto tentar adicionar mais de um elemento raiz no documento XML.

attribute

Editor attribute(java.lang.String name,
                 java.lang.Object value)
                 throws AttributeNotPermittedException,
                        InvalidNameException

Especifica um novo atributo para o elemento corrente do documento XML.

Parameters:

name - java.lang.String contendo o nome que será atribuído ao novo atributo.

value - objeto que será atribuído como valor do novo atributo.

Returns:

instância corrente de Editor para permitir interface fluente.

Throws:

AttributeNotPermittedException - exceção disparada caso não seja permitido especificar um atributo para o elemento corrente.

InvalidNameException - exceção disparada se for especificado um nome inválido.

attribute

Editor attribute(java.lang.String name,
                 java.util.Date value,
                 java.lang.String pattern)
                 throws AttributeNotPermittedException,
                        InvalidNameException

Especifica um novo atributo para o elemento corrente do documento XML.

Parameters:

name - java.lang.String contendo o nome que será atribuído ao novo atributo.

value - instância de java.util.Date que será atribuída como valor no novo atributo.

pattern - java.lang.String contendo o padrão que será aplicado na formatação da data especificada por parâmetro.

Returns:

instância corrente de Editor para permitir interface fluente.

Throws:

AttributeNotPermittedException - exceção disparada caso não seja permitido especificar um atributo para o elemento corrente.

InvalidNameException - exceção disparada se for especificado um nome inválido.

result

Result result()

Retorna instância de Result correspondente ao documento XML editado.

Returns:

instância de Result correspondente ao documento XML editado.

document

org.w3c.dom.Document document()

Retorna instância de org.w3c.dom.Document correspondente ao documento XML criado.

Returns:

instância de org.w3c.dom.Document correspondente ao documento XML criado.