csbase.logic.algorithms.parsers

Class AbstractURLParameterParser<T extends SimpleParameter<?>>

java.lang.Object

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

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

Type Parameters:

T - Tipo do parâmetro.

All Implemented Interfaces:

ParameterFactory, Serializable

Direct Known Subclasses:

InputURLListParameterParser, InputURLParameterParser, OutputURLListParameterParser, OutputURLParameterParser

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

Analisador base para parâmetros de URL.

Author:

Tecgraf

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CAN_USE_PIPE_ATTRIBUTE O atributo "permitir_pipe" dos elementos:
protected static FileParameterPipeAcceptance	CAN_USE_PIPE_DEFAULT_VALUE O valor-padrão para o atributo CAN_USE_PIPE_ATTRIBUTE dos elementos:
protected static String	CATEGORY_ATTRIBUTE Atributo que define o modo de funcionamento do parâmetro do tipo URL.
protected static String	CATEGORY_VALUE_DIRECTORY Valor que indica o modo apenas diretório para o atributo CATEGORY_ATTRIBUTE dodo elemento URLParameter.
protected static String	CATEGORY_VALUE_REGULAR_FILE Valor que indica o modo apenas arquivos para o atributo CATEGORY_ATTRIBUTE do elemento URLParameter.
protected static String	DEFAULT_DIRECTORY_ATTRIBUTE Atributo que indica se o url de entrada deve exibir como valor default o diretório raíz do projeto.
protected static boolean	DEFAULT_DIRECTORY_DEFAULT_VALUE Valor-padrão para o atributo DEFAULT_DIRECTORY_ATTRIBUTE do elemento URLParameter.
protected static String	LOCALIZATION_ATTRIBUTE Atributo que define a localização.
protected static String	MUST_SORT_ATTRIBUTE O atributo "ordenar" do elemento InputURLListParameter.
protected static boolean	MUST_SORT_DEFAULT_VALUE O valor-padrão para o atributo MUST_SORT_ATTRIBUTE do elemento InputURLListParameter
protected static String	PROTOCOLS_ATTRIBUTE Atributo que define os protocolos permitidos no parâmetro.
protected static String	TYPE_ATTRIBUTE Atributo que indica o tipo do arquivo aceito pelo parâmetro.

Constructor Summary

Constructors

Constructor and Description
AbstractURLParameterParser()

Method Summary

Modifier and Type	Method and Description
T	createSimpleParameter(XmlParser parser, ParsedSimpleParameter definition, ParameterGroup group, SimpleAlgorithmConfigurator configurator) Cria uma instância do parâmetro de tipo <T>, a partir dos atributos básicos do parâmetro.
protected abstract T	createURLParameter(ParsedSimpleParameter parsedData, String name, String label, String description, boolean isOptional, boolean isVisible, String commandLinePattern, String[] types, String localization, FileParameterMode mode, FileURLValue defaultValue, FileParameterPipeAcceptance usesPipe, EnumSet<URLProtocol> allowedProtocols) Cria parâmetro URL.
protected ParameterStructure<T>	getURLStructure(String tag, Class<T> parameterClass) Cria a estrutura base de parâmetros de URL.

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

createParameter, getParameterStructure, getParameterStructures

Methods inherited from class java.lang.Object

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

Field Detail

MUST_SORT_ATTRIBUTE

protected static final String MUST_SORT_ATTRIBUTE

O atributo "ordenar" do elemento InputURLListParameter.

Indica se o arquivo de entrada se a relação de arquivos será ordenada, é opcional, o seu valor-padrão é MUST_SORT_DEFAULT_VALUE e é do tipo booleano.

See Also:

Constant Field Values

MUST_SORT_DEFAULT_VALUE

protected static final boolean MUST_SORT_DEFAULT_VALUE

O valor-padrão para o atributo MUST_SORT_ATTRIBUTE do elemento InputURLListParameter

O seu valor é true.

See Also:

Constant Field Values

CAN_USE_PIPE_ATTRIBUTE

protected static final String CAN_USE_PIPE_ATTRIBUTE

O atributo "permitir_pipe" dos elementos:

• InputURLParameter
• OutputURLParameter

Indica o se o parâmetro do tipo URL aceita trabalhar com pipes, é opcional, o seu valor-padrão é CAN_USE_PIPE_DEFAULT_VALUE e é do tipo string e os valores válidos para ele são:

• FileParameterPipeAcceptance.TRUE
• FileParameterPipeAcceptance.FALSE
• FileParameterPipeAcceptance.ALWAYS

See Also:

Constant Field Values

CAN_USE_PIPE_DEFAULT_VALUE

protected static final FileParameterPipeAcceptance CAN_USE_PIPE_DEFAULT_VALUE

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

• InputURLParameter
• OutputURLParameter

O seu valor é CAN_USE_PIPE_DEFAULT_VALUE.

CATEGORY_ATTRIBUTE

protected static final String CATEGORY_ATTRIBUTE

Atributo que define o modo de funcionamento do parâmetro do tipo URL. Este atributo é opcional, o seu valor-padrão é CATEGORY_VALUE_REGULAR_FILE, Valores válidos: CATEGORY_VALUE_REGULAR_FILE e CATEGORY_VALUE_DIRECTORY

See Also:

Constant Field Values

CATEGORY_VALUE_DIRECTORY

protected static final String CATEGORY_VALUE_DIRECTORY

Valor que indica o modo apenas diretório para o atributo CATEGORY_ATTRIBUTE dodo elemento URLParameter.

See Also:

Constant Field Values

CATEGORY_VALUE_REGULAR_FILE

protected static final String CATEGORY_VALUE_REGULAR_FILE

Valor que indica o modo apenas arquivos para o atributo CATEGORY_ATTRIBUTE do elemento URLParameter.

See Also:

Constant Field Values

PROTOCOLS_ATTRIBUTE

protected static final String PROTOCOLS_ATTRIBUTE

Atributo que define os protocolos permitidos no parâmetro. Indica o protocolo aceito pelo parâmetro do tipo URL}, é opcional e é do tipo string e o valores válidos para ele são:

• URLProtocol.PROJECT
• URLProtocol.LOCAL
• URLProtocol.SGA

See Also:

Constant Field Values

DEFAULT_DIRECTORY_ATTRIBUTE

protected static final String DEFAULT_DIRECTORY_ATTRIBUTE

Atributo que indica se o url de entrada deve exibir como valor default o diretório raíz do projeto. Atributo opcional e o seu valor-padrão é DEFAULT_DIRECTORY_DEFAULT_VALUE e é do tipo booleano.

See Also:

Constant Field Values

DEFAULT_DIRECTORY_DEFAULT_VALUE

protected static final boolean DEFAULT_DIRECTORY_DEFAULT_VALUE

Valor-padrão para o atributo DEFAULT_DIRECTORY_ATTRIBUTE do elemento URLParameter.

See Also:

Constant Field Values

TYPE_ATTRIBUTE

protected static final String TYPE_ATTRIBUTE

Atributo que indica o tipo do arquivo aceito pelo parâmetro. É opcional e o seu tipo é String.

See Also:

Constant Field Values

LOCALIZATION_ATTRIBUTE

protected static final String LOCALIZATION_ATTRIBUTE

Atributo que define a localização. A localização é uma chave usada para indicar o protocolo da URL na linha de comando.

See Also:

Constant Field Values

Constructor Detail

AbstractURLParameterParser

public AbstractURLParameterParser()

Method Detail

getURLStructure

protected ParameterStructure<T> getURLStructure(String tag,
                                                Class<T> parameterClass)

Cria a estrutura base de parâmetros de URL.

Parameters:

tag - nome do parâmetro.

parameterClass - classe do parâmetro.

Returns:

a estrutura do parâmetro.

createSimpleParameter

public final T createSimpleParameter(XmlParser parser,
                                     ParsedSimpleParameter definition,
                                     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.

definition - definição 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.

createURLParameter

protected abstract T createURLParameter(ParsedSimpleParameter parsedData,
                                        String name,
                                        String label,
                                        String description,
                                        boolean isOptional,
                                        boolean isVisible,
                                        String commandLinePattern,
                                        String[] types,
                                        String localization,
                                        FileParameterMode mode,
                                        FileURLValue defaultValue,
                                        FileParameterPipeAcceptance usesPipe,
                                        EnumSet<URLProtocol> allowedProtocols)
                                 throws ParseException

Cria parâmetro URL.

Parameters:

parsedData - dados lidos.

name - nome do parâmetro.

label - rótulo do parâmetro.

description - descrição do parâmetro.

isOptional - indicativo de opcionalidade.

isVisible - indicativo de visibilidade.

commandLinePattern - formato na linha de comando.

types - tipos de arquivo.

localization - localização.

mode - modo do arquivo.

defaultValue - valor padrão.

usesPipe - indicativo de uso de pipe.

allowedProtocols - protocolos disponíveis.

Returns:

o parâmetro.

Throws:

ParseException - em caso de erro.