csbase.logic.algorithms.parsers

Class EnumerationParameterParser

java.lang.Object

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

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

csbase.logic.algorithms.parsers.EnumerationParameterParser

All Implemented Interfaces:

ParameterFactory, Serializable

public final class EnumerationParameterParser
extends AbstractEnumerationParameterParser<EnumerationParameter>

Analisador de EnumerationParameter.

Este parser lê os atributos de parâmetros do tipo enumeração simples. O elemento corrente do analisador de XML precisa ser um elemento EnumerationParameter.

See Also:

Serialized Form

Field Summary

Fields inherited from class csbase.logic.algorithms.parsers.AbstractEnumerationParameterParser

ENUMERATION_ELEMENT_MUST_SORT_ATTRIBUTE, ENUMERATION_ELEMENT_MUST_SORT_DEFAULT_VALUE, ENUMERATION_PARAMETER_ELEMENT

Constructor Summary

Constructors

Constructor and Description
EnumerationParameterParser()

Method Summary

Modifier and Type	Method and Description
protected EnumerationParameter	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.
ParameterStructure<EnumerationParameter>	getParameterStructure() Obtém a estrutura do parâmetro.

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

createSimpleParameter, getEnumerationItemFactory, getEnumerationStructure, loadEnumerationItems

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

createParameter, getParameterStructures

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumerationParameterParser

public EnumerationParameterParser()

Method Detail

createEnumerationParameter

protected EnumerationParameter 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.

Specified by:

createEnumerationParameter in class AbstractEnumerationParameterParser<EnumerationParameter>

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.

getParameterStructure

public ParameterStructure<EnumerationParameter> getParameterStructure()

Obtém a estrutura do parâmetro.

Specified by:

getParameterStructure in class SimpleParameterParser<EnumerationParameter>

Returns:

a estrutura.