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, 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 <T> com valores do tipo enumeração como EnumerationParameter e EnumerationListParameter.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENUMERATION_ELEMENT_MUST_SORT_ATTRIBUTE O atributo "ordenar" dos elementos:
static boolean	ENUMERATION_ELEMENT_MUST_SORT_DEFAULT_VALUE O valor-padrão para o atributo ENUMERATION_ELEMENT_MUST_SORT_ATTRIBUTE dos elementos:

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEnumerationParameterParser() Cria o parser.

Method Summary

Modifier and Type	Method and Description
protected abstract T	createEnumerationParameter(XmlParser parser, String name, String label, String description, boolean isOptional, boolean isVisible, String commandLinePattern, boolean mustSort, List<EnumerationItem> items, String defaultItemId) Cria uma instância do parâmetro de tipo <T>, a partir dos atributos básicos de um parâmetro do tipo enumeração.
T	createSimpleParameter(XmlParser parser, String name, String label, String description, boolean isOptional, boolean isVisible, String commandLinePattern, ParameterGroup group, SimpleAlgorithmConfigurator configurator) Cria uma instância do parâmetro de tipo <T>, a partir dos atributos básicos do parâmetro.
protected EnumerationItemFactory	getEnumerationItemFactory() Obtém a fábrica de itens de enumeração.

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

Methods inherited from interface csbase.logic.algorithms.parsers.ParameterFactory

createParameterFactory, getParameterTypes

Field Detail

ENUMERATION_ELEMENT_MUST_SORT_ATTRIBUTE

public static final String ENUMERATION_ELEMENT_MUST_SORT_ATTRIBUTE

O atributo "ordenar" dos elementos:

• EnumerationColumn de um TableParameter
• EnumerationParameter

Indica se o itens de enumeração devem ser ordenados. É opcional, o seu valor-padrão é ENUMERATION_ELEMENT_MUST_SORT_DEFAULT_VALUE e o seu tipo é booleano.

See Also:

Constant Field Values

ENUMERATION_ELEMENT_MUST_SORT_DEFAULT_VALUE

public static final boolean ENUMERATION_ELEMENT_MUST_SORT_DEFAULT_VALUE

O valor-padrão para o atributo ENUMERATION_ELEMENT_MUST_SORT_ATTRIBUTE dos elementos:

• EnumerationColumn de um TableParameter
• EnumerationParameter

O seu valor é true.

See Also:

Constant Field Values

Constructor Detail

AbstractEnumerationParameterParser

protected AbstractEnumerationParameterParser()

Cria o parser.

Method Detail

createSimpleParameter

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

Cria uma instância do parâmetro de tipo <T>, 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.

configurator - Configurador de algoritmo.

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,
                                                String name,
                                                String label,
                                                String description,
                                                boolean isOptional,
                                                boolean isVisible,
                                                String commandLinePattern,
                                                boolean mustSort,
                                                List<EnumerationItem> items,
                                                String defaultItemId)
                                         throws ParseException

Cria uma instância do parâmetro de tipo <T>, 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.

getEnumerationItemFactory

protected final EnumerationItemFactory getEnumerationItemFactory()

Obtém a fábrica de itens de enumeração.

Returns:

.