csbase.logic.algorithms.parameters

Class ParameterGroup

java.lang.Object

csbase.logic.algorithms.parameters.Parameter<Object>

csbase.logic.algorithms.parameters.ParameterGroup

All Implemented Interfaces:

Serializable, Comparable<Parameter<Object>>

public final class ParameterGroup
extends Parameter<Object>

Grupo de parâmetros.

Author:

lmoreira

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterGroup(String id) Cria um grupo com rótulo idêntico ao nome.
ParameterGroup(String id, String label, boolean isCollapsible) Cria um grupo.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addParameter(Parameter<?> parameter) Adiciona um parâmetro filho.
Map<String,Object>	exportValue() Exporta o valor do parâmetro como um mapa "nome->valor".
String	getCommandLine(CommandLineContext context) Monta a linha de comando referente a este parâmetro.
Set<ParameterGroup>	getGroups() Obtém os grupos-filhos deste grupo.
List<InputFileListParameter>	getInputFileListParameters() Obtém os parâmetros do tipo lista de arquivo de entrada que são filhos deste grupo.
List<InputFileParameter>	getInputFileParameters() Obtém os parâmetros do tipo arquivo de entrada que são filhos deste grupo.
List<InputURLListParameter>	getInputURLListParameters() Obtém os parâmetros do tipo lista de URL de entrada que são filhos deste grupo.
List<InputURLParameter>	getInputURLParameters() Obtém os parâmetros do tipo URL de entrada que são filhos deste grupo.
String	getLabel() Obtém o rótulo.
List<OutputFileListParameter>	getOutputFileListParameters() Obtém os parâmetros do tipo lista de arquivo de saída que são filhos deste grupo.
List<OutputFileParameter>	getOutputFileParameters() Obtém os parâmetros do tipo arquivo de saída que são filhos deste grupo.
List<OutputURLListParameter>	getOutputURLListParameters() Obtém os parâmetros do tipo lista de URLs de saída que são filhos deste grupo.
List<OutputURLParameter>	getOutputURLParameters() Obtém os parâmetros do tipo URL de saída que são filhos deste grupo.
ParameterLoader	getParameterLoader() Obtém o carregador de parêmtros.
List<Parameter<?>>	getParameters() Obtém os parâmetros que são filhos deste grupo.
SimpleParameter<?>	getSimpleParameter(String parameterName) Obtém um parâmetro simples que é filho deste grupo através de seu nome.
Set<SimpleParameter<?>>	getSimpleParameters() Obtém os parâmetros simples que são filhos deste grupo.
void	importValue(Map parameterValue) Importa o valor do parâmetro a partir de um mapa "nome->valor".
boolean	isCollapsible() Indica se o grupo é minimizável.
boolean	isSetDefaultValue() Determina se o parâmetro está com o valor padrão.
boolean	isVisible() Determina se o parâmetro está visível no configurador.
void	resetValue() Atribui o valor padrão ao parâmetro.
void	setCollapsible(boolean isCollapsible) Determina se o grupo deve ser minimizável.
boolean	setLabel(String label) Modifica o rótulo de um grupo.
boolean	setParameterLoader(ParameterLoader parameterLoader) Atualiza o carregador de parêmtros.
boolean	setVisible(boolean isVisible) Exibe/oculta este parâmetro.
Validation	validate(ValidationContext context) Verifica se os valores armazenados no parâmetro são válidos.

Methods inherited from class csbase.logic.algorithms.parameters.Parameter

compareTo, equals, getName, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterGroup

public ParameterGroup(String id,
              String label,
              boolean isCollapsible)

Cria um grupo.

Parameters:

id - O identificador do grupo (Não aceita null).

label - rótulo do grupo.

isCollapsible - determina se o grupo é minimizável.

ParameterGroup

public ParameterGroup(String id)

Cria um grupo com rótulo idêntico ao nome.

Parameters:

id - O identificador do grupo (Não aceita null).

Method Detail

addParameter

public boolean addParameter(Parameter<?> parameter)

Adiciona um parâmetro filho.

Parameters:

parameter - O parâmetro (Não aceita null).

Returns:

true em caso de sucesso ou false se já houver um filho com o mesmo nome do parâmetro informado.

exportValue

public Map<String,Object> exportValue()

Exporta o valor do parâmetro como um mapa "nome->valor".

Specified by:

exportValue in class Parameter<Object>

Returns:

O valor do parâmetro como um mapa.

getCommandLine

public String getCommandLine(CommandLineContext context)

Monta a linha de comando referente a este parâmetro.

Specified by:

getCommandLine in class Parameter<Object>

Parameters:

context - Contexto para geração da linha de comando.

Returns:

a linha de comando.

getGroups

public Set<ParameterGroup> getGroups()

Obtém os grupos-filhos deste grupo.

O conjunto retornado é imutável (veja Collections.unmodifiableSet(Set)).

Returns:

Os grupos-filhos (Se não houver grupos-filhos, o conjunto estará vazio).

getInputFileListParameters

public List<InputFileListParameter> getInputFileListParameters()

Obtém os parâmetros do tipo lista de arquivo de entrada que são filhos deste grupo.

A lista retornada é imutável (veja Collections.unmodifiableList(List)).

Returns:

Os parâmetros-filhos (Se não houver grupos-filhos, a lista estará vazia).

getOutputFileListParameters

public List<OutputFileListParameter> getOutputFileListParameters()

Obtém os parâmetros do tipo lista de arquivo de saída que são filhos deste grupo.

A lista retornada é imutável (veja Collections.unmodifiableList(List)).

Returns:

Os parâmetros-filhos (Se não houver grupos-filhos, a lista estará vazia).

getInputFileParameters

public List<InputFileParameter> getInputFileParameters()

Obtém os parâmetros do tipo arquivo de entrada que são filhos deste grupo.

A lista retornada é imutável (veja Collections.unmodifiableList(List)).

Returns:

Os parâmetros-filhos (Se não houver grupos-filhos, a lista estará vazia).

getOutputFileParameters

public List<OutputFileParameter> getOutputFileParameters()

Obtém os parâmetros do tipo arquivo de saída que são filhos deste grupo.

A lista retornada é imutável (veja Collections.unmodifiableList(List)).

Returns:

Os parâmetros-filhos (Se não houver grupos-filhos, a lista estará vazia).

getInputURLListParameters

public List<InputURLListParameter> getInputURLListParameters()

Obtém os parâmetros do tipo lista de URL de entrada que são filhos deste grupo.

A lista retornada é imutável (veja Collections.unmodifiableList(List)).

Returns:

Os parâmetros-filhos (Se não houver grupos-filhos, a lista estará vazia).

getOutputURLListParameters

public List<OutputURLListParameter> getOutputURLListParameters()

Obtém os parâmetros do tipo lista de URLs de saída que são filhos deste grupo.

A lista retornada é imutável (veja Collections.unmodifiableList(List)).

Returns:

Os parâmetros-filhos (Se não houver grupos-filhos, a lista estará vazia).

getInputURLParameters

public List<InputURLParameter> getInputURLParameters()

Obtém os parâmetros do tipo URL de entrada que são filhos deste grupo.

A lista retornada é imutável (veja Collections.unmodifiableList(List)).

Returns:

Os parâmetros-filhos (Se não houver grupos-filhos, a lista estará vazia).

getOutputURLParameters

public List<OutputURLParameter> getOutputURLParameters()

Obtém os parâmetros do tipo URL de saída que são filhos deste grupo.

A lista retornada é imutável (veja Collections.unmodifiableList(List)).

Returns:

Os parâmetros-filhos (Se não houver grupos-filhos, a lista estará vazia).

getParameterLoader

public ParameterLoader getParameterLoader()

Obtém o carregador de parêmtros.

Returns:

o carregador de parêmtros, ou null caso não exista.

getParameters

public List<Parameter<?>> getParameters()

Obtém os parâmetros que são filhos deste grupo.

A lista retornada é imutável (veja Collections.unmodifiableList(List)).

Returns:

Os parâmetros-filhos (Se não houver grupos-filhos, a lista estará vazia).

getSimpleParameter

public SimpleParameter<?> getSimpleParameter(String parameterName)

Obtém um parâmetro simples que é filho deste grupo através de seu nome.

Parameters:

parameterName - O nome do parâmetro (Não aceita null).

Returns:

O parâmetro-filho ou null se ele não existir.

getSimpleParameters

public Set<SimpleParameter<?>> getSimpleParameters()

Obtém os parâmetros simples que são filhos deste grupo.

O conjunto retornado é imutável (veja Collections.unmodifiableSet(Set)).

Returns:

Os parâmetros-filhos (Se não houver grupos-filhos, a lista estará vazia).

importValue

public void importValue(Map parameterValue)

Importa o valor do parâmetro a partir de um mapa "nome->valor".

Specified by:

importValue in class Parameter<Object>

Parameters:

parameterValue - O mapa com o valor do parâmetro.

isSetDefaultValue

public boolean isSetDefaultValue()

Determina se o parâmetro está com o valor padrão.

Specified by:

isSetDefaultValue in class Parameter<Object>

Returns:

verdadeiro se o parâmetro está com o valor padrão ou falso, caso contrário.

isVisible

public boolean isVisible()

Determina se o parâmetro está visível no configurador.

Specified by:

isVisible in class Parameter<Object>

Returns:

verdadeiro se o parâmetro está visível ou falso, caso contrário.

resetValue

public void resetValue()

Atribui o valor padrão ao parâmetro.

Specified by:

resetValue in class Parameter<Object>

setParameterLoader

public boolean setParameterLoader(ParameterLoader parameterLoader)

Atualiza o carregador de parêmtros.

Parameters:

parameterLoader - carregador de parêmtros. Não aceita null.

Returns:

true se não havia sido definido anteriormente nenhum carregador de parâmetros.

validate

public Validation validate(ValidationContext context)
                    throws RemoteException

Verifica se os valores armazenados no parâmetro são válidos.

Specified by:

validate in class Parameter<Object>

Parameters:

context - contexto usado na validação.

Returns:

O resultado da validação.

Throws:

RemoteException - em caso de erro na comunicação com servidor.

setVisible

public boolean setVisible(boolean isVisible)

Exibe/oculta este parâmetro.

Specified by:

setVisible in class Parameter<Object>

Parameters:

isVisible - true para exibir ou false para ocultar.

Returns:

true se houver mudança de estado ou false se o estado atual foi igual ao estado esperado (exemplo: exibir um parâmetro já visível).

setLabel

public boolean setLabel(String label)

Modifica o rótulo de um grupo.

Parameters:

label - O rótulo (Não aceita null).

Returns:

true se ele for modificado ou false se o rótulo corrente for igual ao rótulo fornecido.

getLabel

public final String getLabel()

Obtém o rótulo.

Returns:

O rótulo.

isCollapsible

public boolean isCollapsible()

Indica se o grupo é minimizável.

Returns:

verdadeiro se o grupo é minimizável ou falso, caso cotrário.

setCollapsible

public void setCollapsible(boolean isCollapsible)

Determina se o grupo deve ser minimizável.

Parameters:

isCollapsible - verdadeiro se o grupo é minimizável ou falso, caso cotrário.