csbase.logic.algorithms.parsers

Class EnumerationItemFactory

java.lang.Object

csbase.logic.algorithms.parsers.EnumerationItemFactory

All Implemented Interfaces:

Serializable

public final class EnumerationItemFactory
extends Object
implements Serializable

O analisador de DefaultEnumerationItem.

Author:

Tecgraf/PUC-Rio

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DESCRIPTION_ATTRIBUTE_NAME O atributo "dica" do elemento ELEMENT_NAME.
static String	ELEMENT_NAME O elemento "item_de_enumeracao": descreve um item de enumeração da enumeração, EnumerationListParameter ou coluna de enumeração que é descrita pelo elemento que é pai deste elemento.
protected static String	ID_ATTRIBUTE_NAME O atributo "id" do elemento ELEMENT_NAME.
protected static String	LABEL_ATTRIBUTE_NAME O atributo "rotulo" do elemento ELEMENT_NAME .
protected static String	VALUE_ATTRIBUTE_NAME O atributo "valor" do elemento ELEMENT_NAME .

Constructor Summary

Constructors

Constructor and Description
EnumerationItemFactory()

Method Summary

Modifier and Type	Method and Description
EnumerationItem	getEnumerationItem(String enumerationName, List<EnumerationItem> items, String itemId) Obtém um item de enumeração na relação de itens fornecida.
EnumerationItem	loadEnumerationItem(XmlParser parser, String parameterName) Carrega um DefaultEnumerationItem.
List<EnumerationItem>	loadEnumerationItems(XmlParser parser, String parameterName) Carrega os DefaultEnumerationItem.

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

O elemento "item_de_enumeracao": descreve um item de enumeração da enumeração, EnumerationListParameter ou coluna de enumeração que é descrita pelo elemento que é pai deste elemento.

É elemento-filho de: EnumerationListParameter, EnumerationParameter ou EnumerationColumn de um TableParameter.

See Also:

Constant Field Values

DESCRIPTION_ATTRIBUTE_NAME

protected static final String DESCRIPTION_ATTRIBUTE_NAME

O atributo "dica" do elemento ELEMENT_NAME. Indica a descrição do item, é opcional e é do tipo string.

See Also:

Constant Field Values

ID_ATTRIBUTE_NAME

protected static final String ID_ATTRIBUTE_NAME

O atributo "id" do elemento ELEMENT_NAME. Indica o identificador do item, é obrigatório e é do tipo string.

See Also:

Constant Field Values

LABEL_ATTRIBUTE_NAME

protected static final String LABEL_ATTRIBUTE_NAME

O atributo "rotulo" do elemento ELEMENT_NAME . Indica o rótulo do item, é obrigatório e é do tipo string.

See Also:

Constant Field Values

VALUE_ATTRIBUTE_NAME

protected static final String VALUE_ATTRIBUTE_NAME

O atributo "valor" do elemento ELEMENT_NAME . Indica o valor do item, é obrigatório e é do tipo string.

See Also:

Constant Field Values

Constructor Detail

EnumerationItemFactory

public EnumerationItemFactory()

Method Detail

loadEnumerationItems

public List<EnumerationItem> loadEnumerationItems(XmlParser parser,
                                                  String parameterName)
                                           throws ParseException

Carrega os DefaultEnumerationItem.

Parameters:

parser - O analisador (Não aceita null).

parameterName - O nome da enumeração (Não aceita null).

Returns:

Os items (Se não houver itens a lista estará vazia).

Throws:

ParseException - Em caso de erro no XML.

loadEnumerationItem

public EnumerationItem loadEnumerationItem(XmlParser parser,
                                           String parameterName)
                                    throws ParseException

Carrega um DefaultEnumerationItem.

O elemento corrente tem que ser ELEMENT_NAME.

Parameters:

parser - O analisador (Não aceita null).

parameterName - O nome do parâmetro (Não aceita null).

Returns:

O item de enumeração.

Throws:

ParseException - Em caso de erro no XML.

getEnumerationItem

public EnumerationItem getEnumerationItem(String enumerationName,
                                          List<EnumerationItem> items,
                                          String itemId)
                                   throws ParseException

Obtém um item de enumeração na relação de itens fornecida.

Parameters:

enumerationName - O nome da enumeração (Não aceita null).

items - Os itens disponíveis (Não aceita null).

itemId - O identificador do item (Não aceita null).

Returns:

O item de enumeração.

Throws:

ParseException - Se o item não existir.