tecgraf.javautils.xml
Interface XMLElementInterface

All Known Implementing Classes:

XMLBasicElement, XMLComment, XMLDataElement, XMLElement, XMLEmptyElement, XMLNullDataElement, XMLRootElement

public interface XMLElementInterface

Elemento básico XML.

Author:

Andre Oliveira da Costa

Method Summary

XMLElementInterface	appendValue(String value, boolean newLine) Adiciona um valor textual (append) ao elemento XML.
String	convertTextToXML(String text) Deprecated.
void	convertValueFromXML() Converte o valor armazenado, trocando &lt; por < etc.
void	endTag(List<XMLElementInterface> childrenList) Método executado quando a tag de fim do elemento XML é encontrada.
Object	getAppContextObject() Retorna o contexto da aplicação.
Object	getAppObject() Retorna o objeto da aplicação associado a este elemento.
boolean	getAttributeBooleanValue(String name) Retorna true se o valor do atributo é igual a "true" (case-insensitive), false caso contrário.
double	getAttributeDoubleValue(String name) Retorna o valor real associado a um atributo.
int	getAttributeIntValue(String name) Retorna o valor inteiro associado a um atributo.
List<? extends XMLAttribute>	getAttributes() Retorna a lista de atributos do elemento.
String	getAttributeStrValue(String name) Recupera o valor associado a um atributo.
double	getDoubleValue() Retona o valor associado ao elemento como um float.
float	getFloatValue() Retorna o valor associado ao elemento como um float.
int	getIntValue() Retorna o valor associado ao elemento como um int.
long	getLongValue() Retorna o valor associado ao elemento como um long.
String	getStrValue() Retorna o valor do elemento como string.
String	getTag() Retorna a tag associada ao elemento.
boolean	hasAttribute(String name) Indica se o elemento possui o atributo dado.
boolean	hasValue() Indica se o valor associado ao elemento é diferente da string vazia.
boolean	isEmpty() Indica se o valor do elemento é uma string vazia ou é constituído apenas por espaços ou terminadores de linha.
XMLElementInterface	newAttribute(String name, boolean value) Instancia um novo atributo que tem como valor um booleano.
XMLElementInterface	newAttribute(String name, double value) Instancia um novo atributo que tem como valor um double.
XMLElementInterface	newAttribute(String name, Enum<?> value) Instancia um novo atributo que tem como valor uma constante de um Enum.
XMLElementInterface	newAttribute(String name, int value) Instancia um novo atributo que tem como valor um número inteiro.
XMLElementInterface	newAttribute(String name, long value) Instancia um novo atributo que tem como valor um número inteiro (long).
XMLElementInterface	newAttribute(String name, String value) Instancia um novo atributo XML para o objeto.
XMLElementInterface	newAttributeList(List<XMLAttribute> newAttrs) Redefine os atributos do elemento baseado em um novo mapa.
void	newCharsEvent(char[] charArray, int start, int length) Callback associada ao evento characters(), gerado quando um elemento CDATA é capturado.
void	resetAttributeList() Limpa a lista de atributos.
XMLElementInterface	resetValue() Define valor nulo para o elemento.
XMLElementInterface	setAppContextObject(Object contextObject) Define o contexto da aplicação.
XMLElementInterface	setAppObject(Object appObject) Define o objeto da aplicação associado a este elemento.
XMLElementInterface	setTag(String tag) Ajusta a tag associada ao elemento.
XMLElementInterface	setValue(double value) Define o valor do elemento XML a partir de um double.
XMLElementInterface	setValue(String value) Define o valor do elemento XML a partir de uma String.
void	startTag() Sinaliza para o elemento que ele acaba de ser criado.
void	write(Writer writer, String ident) Escreve o elemento em um stream.
void	writeAttributes(Writer stream) Escreve os atributos do elemento, na mesma ordem em que foram coletados.
void	writeEndTag(Writer stream) Escreve a tag de fechamento do elemento, sem identação.
void	writeEndTag(Writer stream, String ident) Escreve a tag de fechamento do elemento, usando identação.
void	writeStartTag(Writer stream, String ident) Escreve a tag de abertura do elemento.
void	writeStartTagln(Writer stream, String ident) Escreve a tag de abertura do elemento, com fim-de-linha.
void	writeValue(Writer stream) Escreve o valor do elemento.

Method Detail

newCharsEvent

void newCharsEvent(char[] charArray,
                   int start,
                   int length)

Callback associada ao evento characters(), gerado quando um elemento CDATA é capturado.

Parameters:

charArray - os caracteres

start - posição inicial no array de caracteres

length - número de caracteres a serem recuperados

setValue

XMLElementInterface setValue(String value)

Define o valor do elemento XML a partir de uma String.

Parameters:

value - valor

Returns:

o próprio objeto (para encadeamento de operações)

setValue

XMLElementInterface setValue(double value)

Define o valor do elemento XML a partir de um double.

Parameters:

value - valor

Returns:

o próprio objeto (para encadeamento de operações)

resetValue

XMLElementInterface resetValue()

Define valor nulo para o elemento.

Returns:

o próprio objeto (para encadeamento de operações)

appendValue

XMLElementInterface appendValue(String value,
                                boolean newLine)

Adiciona um valor textual (append) ao elemento XML.

Parameters:

value - - valor como texto (string).

newLine - - indica se deve ser anexado um fim-de-linha

Returns:

o próprio objeto (para encadeamento de operações)

hasValue

boolean hasValue()

Indica se o valor associado ao elemento é diferente da string vazia. Observar que qualquer caracter (incluindo espaços em branco e terminadores de linha) configura a existência de valor.

Returns:

true se o o valor do elemento é diferente da string vazia

isEmpty

boolean isEmpty()

Indica se o valor do elemento é uma string vazia ou é constituído apenas por espaços ou terminadores de linha.

Returns:

true se o valor do elemento é uma string vazia ou é constituído apenas por espaços ou terminadores de linha

getStrValue

String getStrValue()

Retorna o valor do elemento como string.

Returns:

valor associado ao elemento

getTag

String getTag()

Retorna a tag associada ao elemento.

Returns:

tag associada ao elemento

setTag

XMLElementInterface setTag(String tag)

Ajusta a tag associada ao elemento.

Parameters:

tag - tag associada ao elemento

Returns:

o próprio objeto (para encadeamento de operações)

newAttribute

XMLElementInterface newAttribute(String name,
                                 String value)

Instancia um novo atributo XML para o objeto.

Parameters:

name - nome do atributo

value - valor do atributo

Returns:

o próprio objeto (para encadeamento de operações)

newAttribute

XMLElementInterface newAttribute(String name,
                                 int value)

Instancia um novo atributo que tem como valor um número inteiro.

Parameters:

name - nome do atributo

value - valor

Returns:

o próprio objeto (para encadeamento de operações)

newAttribute

XMLElementInterface newAttribute(String name,
                                 long value)

Instancia um novo atributo que tem como valor um número inteiro (long).

Parameters:

name - nome do atributo

value - valor

Returns:

o próprio objeto (para encadeamento de operações)

newAttribute

XMLElementInterface newAttribute(String name,
                                 boolean value)

Instancia um novo atributo que tem como valor um booleano. O valor do atributo será uma dentre as strings TRUE ou FALSE .

Parameters:

name - nome do atributo

value - valor

Returns:

o próprio objeto (para encadeamento de operações)

newAttribute

XMLElementInterface newAttribute(String name,
                                 double value)

Instancia um novo atributo que tem como valor um double.

Parameters:

name - nome do atributo

value - valor

Returns:

o próprio objeto (para encadeamento de operações)

newAttribute

XMLElementInterface newAttribute(String name,
                                 Enum<?> value)

Instancia um novo atributo que tem como valor uma constante de um Enum. O método Enum.toString() é usado para obter o valor a ser associado ao atributo.

Parameters:

name - - nome do atributo

value - - valor de enumeração

Returns:

o próprio objeto (para encadeamento de operações)

newAttributeList

XMLElementInterface newAttributeList(List<XMLAttribute> newAttrs)

Redefine os atributos do elemento baseado em um novo mapa.

Parameters:

newAttrs - mapa com os novos atributos na forma {nome, valor}

Returns:

o próprio objeto (para encadeamento de operações)

resetAttributeList

void resetAttributeList()

Limpa a lista de atributos.

hasAttribute

boolean hasAttribute(String name)

Indica se o elemento possui o atributo dado.

Parameters:

name - Nome do atributo

Returns:

true caso o elemento possua o atributo. False caso contrário.

getAttributeStrValue

String getAttributeStrValue(String name)

Recupera o valor associado a um atributo.

Parameters:

name - nome do atributo

Returns:

valor (string) do atributo

getAttributeIntValue

int getAttributeIntValue(String name)

Retorna o valor inteiro associado a um atributo.

Parameters:

name - nome do atributo

Returns:

valor inteiro associado ao atributo

getAttributeDoubleValue

double getAttributeDoubleValue(String name)

Retorna o valor real associado a um atributo.

Parameters:

name - nome do atributo

Returns:

valor real associado ao atributo

getAttributeBooleanValue

boolean getAttributeBooleanValue(String name)

Retorna true se o valor do atributo é igual a "true" (case-insensitive), false caso contrário.

Parameters:

name - nome do atributo

Returns:

true se o valor do atributo é igual à string "true" (case-insensitive), false caso contrário.

endTag

void endTag(List<XMLElementInterface> childrenList)

Método executado quando a tag de fim do elemento XML é encontrada. Neste momento devemos criar o objeto correspondente na camada da aplicação. Observar que não necessariamente cada elemento XML filho do elemento em questão será mapeado para um objeto na aplicação (em muitos casos, serão gerados atributos).

Parameters:

childrenList - lista com os filhos do elemento em questão, ou uma lista vazia caso o elemento não possua filhos

convertValueFromXML

void convertValueFromXML()

Converte o valor armazenado, trocando &lt; por < etc.

convertTextToXML

@Deprecated
String convertTextToXML(String text)

Deprecated.

Método complementar a convertValueFromXML().

Parameters:

text - texto a ser convertido

Returns:

texto convertido para XML

getAttributes

List<? extends XMLAttribute> getAttributes()

Retorna a lista de atributos do elemento.

Returns:

a lista de atributos.

write

void write(Writer writer,
           String ident)
           throws IOException

Escreve o elemento em um stream.

Parameters:

writer - stream de saída

ident - identação

Throws:

IOException - erro de escrita no stream

writeStartTag

void writeStartTag(Writer stream,
                   String ident)
                   throws IOException

Escreve a tag de abertura do elemento. Não é anexado um fim-de-linha ao final da mesma.

Parameters:

stream - stream de saída

ident - identação

Throws:

IOException - erro de escrita no stream

writeStartTagln

void writeStartTagln(Writer stream,
                     String ident)
                     throws IOException

Escreve a tag de abertura do elemento, com fim-de-linha.

Parameters:

stream - stream de saída

ident - identação

Throws:

IOException - erro de escrita no stream

writeEndTag

void writeEndTag(Writer stream,
                 String ident)
                 throws IOException

Escreve a tag de fechamento do elemento, usando identação. É usada para fechar um elemento em uma linha diferente daquela que contém a tag de abertura.

Parameters:

stream - stream de saída

ident - identação

Throws:

IOException - erro de escrita no stream

writeEndTag

void writeEndTag(Writer stream)
                 throws IOException

Escreve a tag de fechamento do elemento, sem identação. Usado quando se quer fechar uma tag na mesma linha em que esta foi iniciada.

Parameters:

stream - stream de saída

Throws:

IOException - erro de escrita no stream

writeAttributes

void writeAttributes(Writer stream)
                     throws IOException

Escreve os atributos do elemento, na mesma ordem em que foram coletados.

Parameters:

stream - stream de saída

Throws:

IOException - erro de escrita no stream

writeValue

void writeValue(Writer stream)
                throws IOException

Escreve o valor do elemento.

Parameters:

stream - stream de saída

Throws:

IOException - erro de escrita no stream

startTag

void startTag()

Sinaliza para o elemento que ele acaba de ser criado. Neste momento seus atributos já foram coletados e se encontram disponíveis para manipulação. A implementação default deste método tipicamente não faz nada.

getFloatValue

float getFloatValue()

Retorna o valor associado ao elemento como um float.

Returns:

float associado ao elemento

getIntValue

int getIntValue()

Retorna o valor associado ao elemento como um int.

Returns:

int associado ao elemento

getLongValue

long getLongValue()

Retorna o valor associado ao elemento como um long.

Returns:

long associado ao elemento

getDoubleValue

double getDoubleValue()

Retona o valor associado ao elemento como um float.

Returns:

double associado ao elemento

setAppContextObject

XMLElementInterface setAppContextObject(Object contextObject)

Define o contexto da aplicação.

Parameters:

contextObject - objeto representativo de contexto da aplicacao.

Returns:

o próprio objeto (para encadeamento de operações)

getAppContextObject

Object getAppContextObject()

Retorna o contexto da aplicação.

Returns:

o objeto representativo de contexto da aplicacao.

setAppObject

XMLElementInterface setAppObject(Object appObject)

Define o objeto da aplicação associado a este elemento.

Parameters:

appObject - objeto analogo na aplicacao.

Returns:

o próprio objeto (para encadeamento de operações)

getAppObject

Object getAppObject()

Retorna o objeto da aplicação associado a este elemento.

Returns:

o objeto da aplicação associado ao elemento (pode ser null).