csbase.logic.algorithms.parsers

Class XmlParser

java.lang.Object

csbase.logic.algorithms.parsers.XmlParser

public final class XmlParser
extends Object

Parser de XML para criação de configuradores de algortimos.

Author:

Tecgraf/PUC-Rio

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	FALSE_VALUES Strings aceitas para booleanos falsos
static String[]	TRUE_VALUES Strings aceitas para booleanos verdadeiros

Constructor Summary

Constructors

Constructor and Description
XmlParser(Map<String,String> replacements) Construtor

Method Summary

Modifier and Type	Method and Description
void	checkAttributes() Checagem de atributos restantes,.
void	checkChildElements() Checagem de elementos filhos.
void	ensureElementName(String expectedElementName) Checagem de nome de elemento.
String	extractAttributeValue(String attributeName) Extração de valor
String	extractAttributeValue(String attributeName, String defaultValue) Extração de valor
String[]	extractAttributeValueAsArray(String attributeName, String[] defaultValue) Extração de valor em forma de lista
boolean	extractAttributeValueAsBoolean(String attributeName) Extração de valor
boolean	extractAttributeValueAsBoolean(String attributeName, boolean defaultValue) Extração de valor
Double	extractAttributeValueAsDouble(String attributeName, Double defaultValue) Extração de valor
Double	extractAttributeValueAsDouble(String attributeName, Double defaultValue, Double maximumValue, Double minimumValue) Extração de valor
<E extends Enum<E>> E	extractAttributeValueAsEnumeration(String attributeName, E defaultValue, StringToEnumConverter<E> converter) Extração de valor
<E extends Enum<E>> E	extractAttributeValueAsEnumeration(String attributeName, StringToEnumConverter<E> converter) Extração de valor
Integer	extractAttributeValueAsInteger(String attributeName, Integer defaultValue) Extração de valor
Integer	extractAttributeValueAsInteger(String attributeName, Integer maximum, Integer minimum) Extração de valor
Integer	extractAttributeValueAsInteger(String attributeName, Integer defaultValue, Integer maximumValue, Integer minimumValue) Extração de valor
int	getAttributeCount() Contagem do número de atributos.
String	getAttributeValue(String attributeName) Busca de valor
String	getAttributeValue(String attributeName, String defaultValue) Busca de valor
String[]	getAttributeValueAsArray(String attributeName, String[] defaultValue) Busca de valor como lista
boolean	getAttributeValueAsBoolean(String attributeName) Busca de valor
boolean	getAttributeValueAsBoolean(String attributeName, boolean defaultValue) Busca de valor
Double	getAttributeValueAsDouble(String attributeName) Busca de valor
Double	getAttributeValueAsDouble(String attributeName, Double defaultValue) Busca de valor
Double	getAttributeValueAsDouble(String attributeName, Double maximumValue, Double minimumValue) Busca de valor
Double	getAttributeValueAsDouble(String attributeName, Double defaultValue, Double maximumValue, Double minimumValue) Busca de valor
<E extends Enum<E>> E	getAttributeValueAsEnumeration(String attributeName, E defaultValue, StringToEnumConverter<E> converter) Busca de valor
<E extends Enum<E>> E	getAttributeValueAsEnumeration(String attributeName, StringToEnumConverter<E> converter) Busca de valor
Integer	getAttributeValueAsInteger(String attributeName) Busca de valor
Integer	getAttributeValueAsInteger(String attributeName, Integer defaultValue) Busca de valor
Integer	getAttributeValueAsInteger(String attributeName, Integer maximumValue, Integer minimumValue) Busca de valor
Integer	getAttributeValueAsInteger(String attributeName, Integer defaultValue, Integer maximumValue, Integer minimumValue) Busca de valor
String	getElementName() Busca do nome o elemento corrente.
String	getElementValue(String defaultValue) Busca do valor corrente.
boolean	goToFirstChild() Ida para primeiro filho de elemento.
boolean	goToFirstChild(String elementName) Ida para primeiro filho de elemento com nome
boolean	goToNextSibling() Ajuste de corrente para próximo.
boolean	goToNextSibling(String elementName) Ajuste de corrente para próximo.
boolean	goToParent() Ajuste de corrente para pai.
void	goToRoot() Ajuste de corrente para raiz.
boolean	hasAttributeValue(String attributeName) Indica a exitência de um atributo.
void	parseDocument(Reader reader) Método de parser.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FALSE_VALUES

public static final String[] FALSE_VALUES

Strings aceitas para booleanos falsos

TRUE_VALUES

public static final String[] TRUE_VALUES

Strings aceitas para booleanos verdadeiros

Constructor Detail

XmlParser

public XmlParser(Map<String,String> replacements)
          throws ParseException

Construtor

Parameters:

replacements - mapa

Throws:

ParseException - em caso de falha de parser

Method Detail

checkAttributes

public void checkAttributes()
                     throws ParseException

Checagem de atributos restantes,.

Throws:

ParseException - em caso de falha de parser

checkChildElements

public void checkChildElements()
                        throws ParseException

Checagem de elementos filhos.

Throws:

ParseException - em caso de falha

ensureElementName

public void ensureElementName(String expectedElementName)
                       throws ParseException

Checagem de nome de elemento.

Parameters:

expectedElementName - nome esperado

Throws:

ParseException - em caso de falha.

extractAttributeValue

public String extractAttributeValue(String attributeName)
                             throws ParseException

Extração de valor

Parameters:

attributeName - nome do atributo

Returns:

valor

Throws:

ParseException - em caso de falha de parser

extractAttributeValue

public String extractAttributeValue(String attributeName,
                                    String defaultValue)

Extração de valor

Parameters:

attributeName - nome do atributo

defaultValue - valor default

Returns:

valor

extractAttributeValueAsArray

public String[] extractAttributeValueAsArray(String attributeName,
                                             String[] defaultValue)

Extração de valor em forma de lista

Parameters:

attributeName - nome do atributo

defaultValue - valor default

Returns:

valor

extractAttributeValueAsBoolean

public boolean extractAttributeValueAsBoolean(String attributeName)
                                       throws ParseException

Extração de valor

Parameters:

attributeName - nome do atributo

Returns:

valor

Throws:

ParseException - em caso de falha de parser

extractAttributeValueAsBoolean

public boolean extractAttributeValueAsBoolean(String attributeName,
                                              boolean defaultValue)
                                       throws ParseException

Extração de valor

Parameters:

attributeName - nome do atributo

defaultValue - valor default

Returns:

valor

Throws:

ParseException - em caso de falha de parser

extractAttributeValueAsDouble

public Double extractAttributeValueAsDouble(String attributeName,
                                            Double defaultValue)
                                     throws ParseException

Extração de valor

Parameters:

attributeName - nome do atributo

defaultValue - valor default

Returns:

valor

Throws:

ParseException - em caso de falha de parser

extractAttributeValueAsDouble

public Double extractAttributeValueAsDouble(String attributeName,
                                            Double defaultValue,
                                            Double maximumValue,
                                            Double minimumValue)
                                     throws ParseException

Extração de valor

Parameters:

attributeName - nome do atributo

defaultValue - valor default

minimumValue - valor mínimo

maximumValue - valor máximo

Returns:

valor

Throws:

ParseException - em caso de falha de parser

extractAttributeValueAsEnumeration

public <E extends Enum<E>> E extractAttributeValueAsEnumeration(String attributeName,
                                                                E defaultValue,
                                                                StringToEnumConverter<E> converter)
                                                         throws ParseException

Extração de valor

Type Parameters:

E - enumeração.

Parameters:

attributeName - nome do atributo

defaultValue - valor default

converter - conversor.

Returns:

valor

Throws:

ParseException - em caso de falha de parser

extractAttributeValueAsEnumeration

public <E extends Enum<E>> E extractAttributeValueAsEnumeration(String attributeName,
                                                                StringToEnumConverter<E> converter)
                                                         throws ParseException

Extração de valor

Type Parameters:

E - enumeração.

Parameters:

attributeName - nome do atributo

converter - conversor.

Returns:

valor

Throws:

ParseException - em caso de falha de parser

extractAttributeValueAsInteger

public Integer extractAttributeValueAsInteger(String attributeName,
                                              Integer defaultValue)
                                       throws ParseException

Extração de valor

Parameters:

attributeName - nome do atributo

defaultValue - valor default

Returns:

valor

Throws:

ParseException - em caso de falha de parser

extractAttributeValueAsInteger

public Integer extractAttributeValueAsInteger(String attributeName,
                                              Integer maximum,
                                              Integer minimum)
                                       throws ParseException

Extração de valor

Parameters:

attributeName - nome do atributo

minimum - valor mínimo

maximum - valor máximo

Returns:

valor

Throws:

ParseException - em caso de falha de parser

extractAttributeValueAsInteger

public Integer extractAttributeValueAsInteger(String attributeName,
                                              Integer defaultValue,
                                              Integer maximumValue,
                                              Integer minimumValue)
                                       throws ParseException

Extração de valor

Parameters:

attributeName - nome do atributo

defaultValue - valor default

minimumValue - valor mínimo

maximumValue - valor máximo

Returns:

valor

Throws:

ParseException - em caso de falha de parser

getAttributeCount

public int getAttributeCount()

Contagem do número de atributos.

Returns:

número de atributos.

getAttributeValue

public String getAttributeValue(String attributeName)
                         throws ParseException

Busca de valor

Parameters:

attributeName - nome do atributo

Returns:

valor

Throws:

ParseException - em caso de falha de parser

getAttributeValue

public String getAttributeValue(String attributeName,
                                String defaultValue)

Busca de valor

Parameters:

attributeName - nome do atributo

defaultValue - valor default

Returns:

valor

getAttributeValueAsArray

public String[] getAttributeValueAsArray(String attributeName,
                                         String[] defaultValue)

Busca de valor como lista

Parameters:

attributeName - nome do atributo

defaultValue - valor default

Returns:

valor

getAttributeValueAsBoolean

public boolean getAttributeValueAsBoolean(String attributeName)
                                   throws ParseException

Busca de valor

Parameters:

attributeName - nome do atributo

Returns:

valor

Throws:

ParseException - em caso de falha de parser

getAttributeValueAsBoolean

public boolean getAttributeValueAsBoolean(String attributeName,
                                          boolean defaultValue)
                                   throws ParseException

Busca de valor

Parameters:

attributeName - nome do atributo

defaultValue - valor default

Returns:

valor

Throws:

ParseException - em caso de falha de parser

getAttributeValueAsDouble

public Double getAttributeValueAsDouble(String attributeName)
                                 throws ParseException

Busca de valor

Parameters:

attributeName - nome do atributo

Returns:

valor

Throws:

ParseException - em caso de falha de parser

getAttributeValueAsDouble

public Double getAttributeValueAsDouble(String attributeName,
                                        Double defaultValue)
                                 throws ParseException

Busca de valor

Parameters:

attributeName - nome do atributo

defaultValue - valor default

Returns:

valor

Throws:

ParseException - em caso de falha de parser

getAttributeValueAsDouble

public Double getAttributeValueAsDouble(String attributeName,
                                        Double maximumValue,
                                        Double minimumValue)
                                 throws ParseException

Busca de valor

Parameters:

attributeName - nome do atributo

minimumValue - valor mínimo

maximumValue - valor máximo

Returns:

valor

Throws:

ParseException - em caso de falha de parser

getAttributeValueAsDouble

public Double getAttributeValueAsDouble(String attributeName,
                                        Double defaultValue,
                                        Double maximumValue,
                                        Double minimumValue)
                                 throws ParseException

Busca de valor

Parameters:

attributeName - nome do atributo

defaultValue - valor default

minimumValue - valor mínimo

maximumValue - valor máximo

Returns:

valor

Throws:

ParseException - em caso de falha de parser

getAttributeValueAsEnumeration

public <E extends Enum<E>> E getAttributeValueAsEnumeration(String attributeName,
                                                            E defaultValue,
                                                            StringToEnumConverter<E> converter)
                                                     throws ParseException

Busca de valor

Type Parameters:

E - enumeração.

Parameters:

attributeName - nome do atributo

defaultValue - valor default

converter - conversor.

Returns:

valor

Throws:

ParseException - em caso de erro.

getAttributeValueAsEnumeration

public <E extends Enum<E>> E getAttributeValueAsEnumeration(String attributeName,
                                                            StringToEnumConverter<E> converter)
                                                     throws ParseException

Busca de valor

Type Parameters:

E - enumeração.

Parameters:

attributeName - nome do atributo

converter - conversor.

Returns:

valor

Throws:

ParseException - em caso de erro.

getAttributeValueAsInteger

public Integer getAttributeValueAsInteger(String attributeName)
                                   throws ParseException

Busca de valor

Parameters:

attributeName - nome do atributo

Returns:

valor

Throws:

ParseException - em caso de falha de parser

getAttributeValueAsInteger

public Integer getAttributeValueAsInteger(String attributeName,
                                          Integer defaultValue)
                                   throws ParseException

Busca de valor

Parameters:

attributeName - nome do atributo

defaultValue - valor default

Returns:

valor

Throws:

ParseException - em caso de falha de parser

getAttributeValueAsInteger

public Integer getAttributeValueAsInteger(String attributeName,
                                          Integer maximumValue,
                                          Integer minimumValue)
                                   throws ParseException

Busca de valor

Parameters:

attributeName - nome do atributo

minimumValue - valor mínimo

maximumValue - valor máximo

Returns:

valor

Throws:

ParseException - em caso de falha de parser

getAttributeValueAsInteger

public Integer getAttributeValueAsInteger(String attributeName,
                                          Integer defaultValue,
                                          Integer maximumValue,
                                          Integer minimumValue)
                                   throws ParseException

Busca de valor

Parameters:

attributeName - nome do atributo

defaultValue - valor default

minimumValue - valor mínimo

maximumValue - valor máximo

Returns:

valor

Throws:

ParseException - em caso de falha de parser

getElementName

public String getElementName()

Busca do nome o elemento corrente.

Returns:

o nome

getElementValue

public String getElementValue(String defaultValue)

Busca do valor corrente.

Parameters:

defaultValue - valor default

Returns:

o valor

goToFirstChild

public boolean goToFirstChild()

Ida para primeiro filho de elemento.

Returns:

indicativo de sucesso.

goToFirstChild

public boolean goToFirstChild(String elementName)

Ida para primeiro filho de elemento com nome

Parameters:

elementName - o nome.

Returns:

indicativo de sucesso.

goToNextSibling

public boolean goToNextSibling()

Ajuste de corrente para próximo.

Returns:

indicativo de sucesso.

goToNextSibling

public boolean goToNextSibling(String elementName)

Ajuste de corrente para próximo.

Parameters:

elementName - nome do elemento.

Returns:

indicativo de sucesso.

goToParent

public boolean goToParent()

Ajuste de corrente para pai.

Returns:

indicativo de sucesso.

goToRoot

public void goToRoot()

Ajuste de corrente para raiz.

hasAttributeValue

public boolean hasAttributeValue(String attributeName)

Indica a exitência de um atributo.

Parameters:

attributeName - nome do atributo

Returns:

indicativo

parseDocument

public void parseDocument(Reader reader)
                   throws ParseException

Método de parser.

Parameters:

reader - leitor

Throws:

ParseException - em caso de erro.