csbase.logic.algorithms.parsers

Class AbstractEnumerationParameterParser<T extends SimpleParameter<?>>

java.lang.Object

csbase.logic.algorithms.parsers.ParameterParser

csbase.logic.algorithms.parsers.SimpleParameterParser<T>

csbase.logic.algorithms.parsers.AbstractEnumerationParameterParser<T>

Type Parameters:

T - Tipo do parâmetro do qual essa classe faz parsing

All Implemented Interfaces:

ParameterFactory, java.io.Serializable

Direct Known Subclasses:

EnumerationListParameterParser, EnumerationParameterParser

public abstract class AbstractEnumerationParameterParser<T extends SimpleParameter<?>>
extends SimpleParameterParser<T>

Classe abstrata que serve de base para analisadores de parâmetros com valores do tipo enumeração como EnumerationParameter e EnumerationListParameter.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractEnumerationParameterParser()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract T	createEnumerationParameter(XmlParser parser, java.lang.String name, java.lang.String label, java.lang.String description, boolean isOptional, boolean isVisible, java.lang.String commandLinePattern, boolean mustSort, java.util.List<EnumerationItem> items, java.lang.String defaultItemId) Cria uma instância do parâmetro de tipo , a partir dos atributos básicos de um parâmetro do tipo enumeração.
T	createSimpleParameter(XmlParser parser, java.lang.String name, java.lang.String label, java.lang.String description, boolean isOptional, boolean isVisible, java.lang.String commandLinePattern, ParameterGroup group) Cria uma instância do parâmetro de tipo , a partir dos atributos básicos do parâmetro.
protected EnumerationItem	getEnumerationItem(java.lang.String enumerationName, java.util.List<EnumerationItem> items, java.lang.String itemId) Obtém um item de enumeração na relação de itens fornecida.
protected EnumerationItem	loadEnumerationItem(XmlParser parser) Carrega um EnumerationItem.
protected java.util.List<EnumerationItem>	loadEnumerationItems(XmlParser parser, java.lang.String parameterName) Carrega os EnumerationItem.

Methods inherited from class csbase.logic.algorithms.parsers.SimpleParameterParser

createParameter

Methods inherited from class csbase.logic.algorithms.parsers.ParameterParser

loadCommandLinePattern

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEnumerationParameterParser

public AbstractEnumerationParameterParser()

Method Detail

createSimpleParameter

public T createSimpleParameter(XmlParser parser,
                      java.lang.String name,
                      java.lang.String label,
                      java.lang.String description,
                      boolean isOptional,
                      boolean isVisible,
                      java.lang.String commandLinePattern,
                      ParameterGroup group)
                                                   throws ParseException

Cria uma instância do parâmetro de tipo , a partir dos atributos básicos do parâmetro. As subclasses devem implementar esse método, fazendo a extração dos demais atributos do parâmetro.

Specified by:

createSimpleParameter in class SimpleParameterParser<T extends SimpleParameter<?>>

Parameters:

parser - Parser xml do configurador.

name - Nome do parâmetro.

label - Rótulo do parâmetro.

description - Dica do parâmetro.

isOptional - Indica se o parâmetro é opcional.

isVisible - Indica se o parâmetro deve ficar visível.

commandLinePattern - Padrão da linha de comando do parâmetro.

group - grupo do parâmetro.

Returns:

Uma instância do parâmetro com os atributos básicos e específicos preenchidos.

Throws:

ParseException - Caso não seja possível criar a instância do parâmetro com os atributos especificados.

createEnumerationParameter

protected abstract T createEnumerationParameter(XmlParser parser,
                           java.lang.String name,
                           java.lang.String label,
                           java.lang.String description,
                           boolean isOptional,
                           boolean isVisible,
                           java.lang.String commandLinePattern,
                           boolean mustSort,
                           java.util.List<EnumerationItem> items,
                           java.lang.String defaultItemId)
                                                                    throws ParseException

Cria uma instância do parâmetro de tipo , a partir dos atributos básicos de um parâmetro do tipo enumeração. As subclasses devem implementar esse método, fazendo a extração dos demais atributos do parâmetro.

Parameters:

parser - Parser xml do configurador.

name - Nome do parâmetro.

label - Rótulo do parâmetro.

description - Dica do parâmetro.

isOptional - Indica se o parâmetro é opcional.

isVisible - Indica se o parâmetro deve ficar visível.

commandLinePattern - Padrão da linha de comando do parâmetro.

mustSort - Indica se a enumeração deve ser ordenada.

items - Os itens da enumeração, o valor-padrão deve ser um dos itens.

defaultItemId - O valor-padrão do parâmetro.

Returns:

Uma instância do parâmetro com os atributos básicos e específicos preenchidos.

Throws:

ParseException - Caso não seja possível criar a instância do parâmetro com os atributos especificados.

loadEnumerationItems

protected java.util.List<EnumerationItem> loadEnumerationItems(XmlParser parser,
                                                   java.lang.String parameterName)
                                                        throws ParseException

Carrega os EnumerationItem.

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

protected EnumerationItem loadEnumerationItem(XmlParser parser)
                                       throws ParseException

Carrega um EnumerationItem.

O elemento corrente tem que ser ENUMERATION_ITEM_ELEMENT.

Parameters:

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

Returns:

O item de enumeração.

Throws:

ParseException - Em caso de erro no XML.

getEnumerationItem

protected EnumerationItem getEnumerationItem(java.lang.String enumerationName,
                                 java.util.List<EnumerationItem> items,
                                 java.lang.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.