csbase.logic.algorithms.parameters

Class HiddenParameter

java.lang.Object

csbase.logic.algorithms.parameters.Parameter<java.lang.String>

csbase.logic.algorithms.parameters.HiddenParameter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Parameter<java.lang.String>>

public final class HiddenParameter
extends Parameter<java.lang.String>

Parâmetro oculto.

Um parâmetro oculto não aparece na interface gráfica do configurador de algoritmos, mas aparece na linha de comando. Ele é utilizado para passar ao comando parâmetros que não variam.

Este parâmetro é somente-leitura. Todos os métodos de parâmetros que modificam o valor do comando não têm efeito.

Author:

lmoreira

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HiddenParameter(java.lang.String name, java.lang.String value, java.lang.String commandLinePattern) Cria um parâmetro oculto.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	exportValue() Exporta o valor do parâmetro como um mapa "nome->valor".
java.lang.String	getCommandLine() Obtém a linha de comando.
java.lang.String	getCommandLine(CommandLineContext context) Monta a linha de comando referente a este parâmetro.
java.lang.String	getCommandLinePattern() Obtém o padrão para a linha de comando.
java.lang.String	getValue() Obtém o valor do parâmetro.
void	importValue(java.util.Map<java.lang.String,java.lang.Object> values) Importa o valor do parâmetro a partir de um mapa "nome->valor".
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.
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

HiddenParameter

public HiddenParameter(java.lang.String name,
               java.lang.String value,
               java.lang.String commandLinePattern)

Cria um parâmetro oculto.

Parameters:

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

value - O valor do parâmetro (Não aceita null).

commandLinePattern - O padrão para a linha de comando (Não aceita null).

Method Detail

exportValue

public java.util.Map<java.lang.String,java.lang.Object> exportValue()

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

Specified by:

exportValue in class Parameter<java.lang.String>

Returns:

O valor do parâmetro como um mapa.

getCommandLine

public java.lang.String getCommandLine()

Obtém a linha de comando.

A linha de comando tem o formato Nome_do_parametro=Valor_do_parametro.

Returns:

A linha de comando.

getCommandLine

public java.lang.String getCommandLine(CommandLineContext context)

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

Specified by:

getCommandLine in class Parameter<java.lang.String>

Parameters:

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

Returns:

a linha de comando.

getCommandLinePattern

public java.lang.String getCommandLinePattern()

Obtém o padrão para a linha de comando.

Returns:

.

getValue

public java.lang.String getValue()

Obtém o valor do parâmetro.

Returns:

O valor do parâmetro.

importValue

public void importValue(java.util.Map<java.lang.String,java.lang.Object> values)

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

Specified by:

importValue in class Parameter<java.lang.String>

Parameters:

values - 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<java.lang.String>

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<java.lang.String>

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. Não faz nada, pois o parâmetro é do tipo hidden que não é alterável.

Specified by:

resetValue in class Parameter<java.lang.String>

validate

public Validation validate(ValidationContext context)

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

Specified by:

validate in class Parameter<java.lang.String>

Parameters:

context - contexto usado na validação.

Returns:

O resultado da validação.

setVisible

public boolean setVisible(boolean isVisible)

Exibe/oculta este parâmetro.

Specified by:

setVisible in class Parameter<java.lang.String>

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