csbase.logic.algorithms.parsers

Class AbstractFileParameterParser<T extends SimpleParameter<?>>

java.lang.Object

csbase.logic.algorithms.parsers.ParameterParser

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

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

Type Parameters:

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

All Implemented Interfaces:

ParameterFactory, Serializable

Direct Known Subclasses:

InputFileParameterParser, OutputFileParameterParser

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

Classe abstrata que serve de base para analisadores de parâmetros com valores que representam arquivos como InputFileParameter e OutputFileParameter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractFileParameterParser.FileParameterPipeAcceptanceConverter Converte strings para valores da enumeração FileParameterPipeAcceptance.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FILE_PARAMETER_ELEMENT_CAN_USE_PIPE_ATTRIBUTE O atributo "permitir_pipe" dos elementos: InputFileParameter OutputFileParameter Indica o se o parâmetro do tipo arquivo aceita trabalhar com pipes, é opcional, o seu valor-padrão é FILE_PARAMETER_ELEMENT_CAN_USE_PIPE_DEFAULT_VALUE e é do tipo string e os valores válidos para ele são: FileParameterPipeAcceptance.TRUE FileParameterPipeAcceptance.FALSE FileParameterPipeAcceptance.ALWAYS
protected static FileParameterPipeAcceptance	FILE_PARAMETER_ELEMENT_CAN_USE_PIPE_DEFAULT_VALUE O valor-padrão para o atributo FILE_PARAMETER_ELEMENT_CAN_USE_PIPE_ATTRIBUTE dos elementos: InputFileParameter OutputFileParameter O seu valor é FILE_PARAMETER_ELEMENT_CAN_USE_PIPE_DEFAULT_VALUE.
protected static String	FILE_PARAMETER_ELEMENT_CATEGORY_ATTRIBUTE O atributo "categoria" dos elementos: InputFileParameter OutputFileParameter Indica o modo de funcionamento do parâmetros do tipo arquivo}, é opcional, o seu valor-padrão é FILE_PARAMETER_ELEMENT_CATEGORY_VALUE_REGULAR_FILE, é do tipo string e o valores válidos para ele são: FILE_PARAMETER_ELEMENT_CATEGORY_VALUE_REGULAR_FILE FILE_PARAMETER_ELEMENT_CATEGORY_VALUE_DIRECTORY FILE_PARAMETER_ELEMENT_CATEGORY_BOTH .
protected static String	FILE_PARAMETER_ELEMENT_CATEGORY_BOTH O valor que indica o modo diretório e/ou arquivos para o atributo FILE_PARAMETER_ELEMENT_CATEGORY_ATTRIBUTE dos elementos: InputFileParameter OutputFileParameter O seu valor é "ambos".
protected static String	FILE_PARAMETER_ELEMENT_CATEGORY_VALUE_DIRECTORY O valor que indica o modo apenas diretório para o atributo FILE_PARAMETER_ELEMENT_CATEGORY_ATTRIBUTE dos elementos: InputFileParameter OutputFileParameter O seu valor é "diretorio".
protected static String	FILE_PARAMETER_ELEMENT_CATEGORY_VALUE_REGULAR_FILE O valor que indica o modo apenas arquivos para o atributo FILE_PARAMETER_ELEMENT_CATEGORY_ATTRIBUTE dos elementos: InputFileParameter OutputFileParameter O seu valor é "arquivo".
protected static String	FILE_PARAMETER_ELEMENT_MUST_SORT_ATTRIBUTE O atributo "ordenar" do elemento InputFileListParameter.
protected static boolean	FILE_PARAMETER_ELEMENT_MUST_SORT_DEFAULT_VALUE O valor-padrão para o atributo FILE_PARAMETER_ELEMENT_MUST_SORT_ATTRIBUTE do elemento InputFileListParameter O seu valor é true.
protected static String	FILE_PARAMETER_ELEMENT_TYPE_ATTRIBUTE O atributo "tipo" dos elementos: InputFileParameter OutputFileParameter Indica tipo de arquivo aceito pelo parâmetro do tipo arquivo, é opcional e o seu tipo é string.
protected static String	FILE_PARAMETER_ELEMENT_USE_FILTER_ATTRIBUTE O atributo "usar_filtro" do elemento InputFileParameter.
protected static boolean	FILE_PARAMETER_ELEMENT_USE_FILTER_DEFAULT_VALUE O valor-padrão para o atributo FILE_PARAMETER_ELEMENT_USE_FILTER_ATTRIBUTE do elemento OutputFileParameter O seu valor é false.
protected static String	FILE_PARAMETER_ELEMENT_USE_ROOT_AS_DEFAULT_DIRECTORY_ATTRIBUTE O atributo "usar_diretorio_raiz_como_padrao" do elemento InputFileParameter.
protected static boolean	FILE_PARAMETER_ELEMENT_USE_ROOT_AS_DEFAULT_DIRECTORY_DEFAULT_VALUE O valor-padrão para o atributo FILE_PARAMETER_ELEMENT_USE_ROOT_AS_DEFAULT_DIRECTORY_ATTRIBUTE do elemento InputFileParameter O seu valor é false .

Constructor Summary

Constructors

Constructor and Description
AbstractFileParameterParser()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract boolean	acceptBothCategory() Indica se a categoria FILE_PARAMETER_ELEMENT_CATEGORY_BOTH é aceita.
protected abstract T	createFileParameter(XmlParser parser, String name, String label, String description, boolean isOptional, boolean isVisible, String commandLinePattern, String[] types, FileParameterMode mode) Cria uma instância do parâmetro de tipo , a partir dos atributos básicos do parâmetro.
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 , a partir dos atributos básicos do parâmetro.

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

Field Detail

FILE_PARAMETER_ELEMENT_MUST_SORT_ATTRIBUTE

protected static final String FILE_PARAMETER_ELEMENT_MUST_SORT_ATTRIBUTE

O atributo "ordenar" do elemento InputFileListParameter.

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

See Also:

Constant Field Values

FILE_PARAMETER_ELEMENT_MUST_SORT_DEFAULT_VALUE

protected static final boolean FILE_PARAMETER_ELEMENT_MUST_SORT_DEFAULT_VALUE

O valor-padrão para o atributo FILE_PARAMETER_ELEMENT_MUST_SORT_ATTRIBUTE do elemento InputFileListParameter

O seu valor é true.

See Also:

Constant Field Values

FILE_PARAMETER_ELEMENT_CAN_USE_PIPE_ATTRIBUTE

protected static final String FILE_PARAMETER_ELEMENT_CAN_USE_PIPE_ATTRIBUTE

O atributo "permitir_pipe" dos elementos:

• InputFileParameter
• OutputFileParameter

Indica o se o parâmetro do tipo arquivo aceita trabalhar com pipes, é opcional, o seu valor-padrão é FILE_PARAMETER_ELEMENT_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

FILE_PARAMETER_ELEMENT_CAN_USE_PIPE_DEFAULT_VALUE

protected static final FileParameterPipeAcceptance FILE_PARAMETER_ELEMENT_CAN_USE_PIPE_DEFAULT_VALUE

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

• InputFileParameter
• OutputFileParameter

O seu valor é FILE_PARAMETER_ELEMENT_CAN_USE_PIPE_DEFAULT_VALUE.

FILE_PARAMETER_ELEMENT_CATEGORY_ATTRIBUTE

protected static final String FILE_PARAMETER_ELEMENT_CATEGORY_ATTRIBUTE

O atributo "categoria" dos elementos:

• InputFileParameter
• OutputFileParameter

Indica o modo de funcionamento do parâmetros do tipo arquivo}, é opcional, o seu valor-padrão é FILE_PARAMETER_ELEMENT_CATEGORY_VALUE_REGULAR_FILE, é do tipo string e o valores válidos para ele são:

• FILE_PARAMETER_ELEMENT_CATEGORY_VALUE_REGULAR_FILE
• FILE_PARAMETER_ELEMENT_CATEGORY_VALUE_DIRECTORY
• FILE_PARAMETER_ELEMENT_CATEGORY_BOTH

.

See Also:

Constant Field Values

FILE_PARAMETER_ELEMENT_CATEGORY_VALUE_DIRECTORY

protected static final String FILE_PARAMETER_ELEMENT_CATEGORY_VALUE_DIRECTORY

O valor que indica o modo apenas diretório para o atributo FILE_PARAMETER_ELEMENT_CATEGORY_ATTRIBUTE dos elementos:

• InputFileParameter
• OutputFileParameter

O seu valor é "diretorio".

See Also:

Constant Field Values

FILE_PARAMETER_ELEMENT_CATEGORY_BOTH

protected static final String FILE_PARAMETER_ELEMENT_CATEGORY_BOTH

O valor que indica o modo diretório e/ou arquivos para o atributo FILE_PARAMETER_ELEMENT_CATEGORY_ATTRIBUTE dos elementos:

• InputFileParameter
• OutputFileParameter

O seu valor é "ambos".

See Also:

Constant Field Values

FILE_PARAMETER_ELEMENT_CATEGORY_VALUE_REGULAR_FILE

protected static final String FILE_PARAMETER_ELEMENT_CATEGORY_VALUE_REGULAR_FILE

O valor que indica o modo apenas arquivos para o atributo FILE_PARAMETER_ELEMENT_CATEGORY_ATTRIBUTE dos elementos:

• InputFileParameter
• OutputFileParameter

O seu valor é "arquivo".

See Also:

Constant Field Values

FILE_PARAMETER_ELEMENT_USE_ROOT_AS_DEFAULT_DIRECTORY_ATTRIBUTE

protected static final String FILE_PARAMETER_ELEMENT_USE_ROOT_AS_DEFAULT_DIRECTORY_ATTRIBUTE

O atributo "usar_diretorio_raiz_como_padrao" do elemento InputFileParameter.

Indica se o arquivo de entrada deve exibir como valor default o diretório raíz do projeto. Se ela não for informada, é opcional, o seu valor-padrão é FILE_PARAMETER_ELEMENT_USE_FILTER_DEFAULT_VALUE e é do tipo booleano.

See Also:

Constant Field Values

FILE_PARAMETER_ELEMENT_USE_ROOT_AS_DEFAULT_DIRECTORY_DEFAULT_VALUE

protected static final boolean FILE_PARAMETER_ELEMENT_USE_ROOT_AS_DEFAULT_DIRECTORY_DEFAULT_VALUE

O valor-padrão para o atributo FILE_PARAMETER_ELEMENT_USE_ROOT_AS_DEFAULT_DIRECTORY_ATTRIBUTE do elemento InputFileParameter

O seu valor é false .

See Also:

Constant Field Values

FILE_PARAMETER_ELEMENT_TYPE_ATTRIBUTE

protected static final String FILE_PARAMETER_ELEMENT_TYPE_ATTRIBUTE

O atributo "tipo" dos elementos:

• InputFileParameter
• OutputFileParameter

Indica tipo de arquivo aceito pelo parâmetro do tipo arquivo, é opcional e o seu tipo é string.

See Also:

Constant Field Values

FILE_PARAMETER_ELEMENT_USE_FILTER_ATTRIBUTE

protected static final String FILE_PARAMETER_ELEMENT_USE_FILTER_ATTRIBUTE

O atributo "usar_filtro" do elemento InputFileParameter.

Indica se o arquivo de entrada deve exibir um filtro. Se ela não for informada, é opcional, o seu valor-padrão é FILE_PARAMETER_ELEMENT_USE_FILTER_DEFAULT_VALUE e é do tipo booleano.

See Also:

Constant Field Values

FILE_PARAMETER_ELEMENT_USE_FILTER_DEFAULT_VALUE

protected static final boolean FILE_PARAMETER_ELEMENT_USE_FILTER_DEFAULT_VALUE

O valor-padrão para o atributo FILE_PARAMETER_ELEMENT_USE_FILTER_ATTRIBUTE do elemento OutputFileParameter

O seu valor é false.

See Also:

Constant Field Values

Constructor Detail

AbstractFileParameterParser

public AbstractFileParameterParser()

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 , 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.

acceptBothCategory

protected abstract boolean acceptBothCategory()

Indica se a categoria FILE_PARAMETER_ELEMENT_CATEGORY_BOTH é aceita.

Returns:

true se for aceita ou false caso contrário.

createFileParameter

protected abstract T createFileParameter(XmlParser parser,
                    String name,
                    String label,
                    String description,
                    boolean isOptional,
                    boolean isVisible,
                    String commandLinePattern,
                    String[] types,
                    FileParameterMode mode)
                                                             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.

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.

types - Tipo do arquivo do parâmetro.

mode - O modo de funcionamento 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.