Package es.uam.eps.ir.relison.grid.diffusion.stop

Class StopConditionParameterReader

java.lang.Object

es.uam.eps.ir.relison.grid.ParametersReader

es.uam.eps.ir.relison.grid.diffusion.stop.StopConditionParameterReader

public class StopConditionParameterReader
extends ParametersReader

Class for reading a filter for information diffusion. For each filter, a single set of parameters is read.
File format:
stop:
name: ...
params: ...
param1: ...

See Also:

ParametersReader

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	name	The name of the filter.
private static java.lang.String	NAME	Identifier for the name of the algorithm.
private Parameters	parameters	The set of parameters for the filter.
private static java.lang.String	PARAMS	Identifier for the set of parameters.

Constructor Summary

Constructors

Constructor	Description
StopConditionParameterReader()	Constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	Gets the name of the filter.
Parameters	getParameter()	Gets the parameters for the read filter.
java.lang.String	printStopCondition()	Shows the configuration of a stop condition.
void	readStopCondition(java.util.Map<java.lang.String,java.lang.Object> element)	Reads the parameters of a stop condition.

Methods inherited from class es.uam.eps.ir.relison.grid.ParametersReader

readBoolean, readDouble, readInteger, readLong, readOrientation, readParameters, readParameterValues, readString

Methods inherited from class java.lang.Object

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

Field Details

NAME

private static final java.lang.String NAME

Identifier for the name of the algorithm.

See Also:

Constant Field Values

PARAMS

private static final java.lang.String PARAMS

Identifier for the set of parameters.

See Also:

Constant Field Values

parameters

private Parameters parameters

The set of parameters for the filter.

name

private java.lang.String name

The name of the filter.

Constructor Details

StopConditionParameterReader

public StopConditionParameterReader()

Constructor.

Method Details

readStopCondition

public void readStopCondition(java.util.Map<java.lang.String,java.lang.Object> element)

Reads the parameters of a stop condition.

Parameters:

element - an entry containing the parameter information of the stop condition.

getName

public java.lang.String getName()

Gets the name of the filter.

Returns:

the name of the filter, if it exists, null otherwise.

getParameter

public Parameters getParameter()

Gets the parameters for the read filter.

Returns:

the parameters if they exist, an empty parameter object if not.

printStopCondition

public java.lang.String printStopCondition()

Shows the configuration of a stop condition.

Returns:

a string containing the configuration of the stop condition.