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

Class ProtocolParameterReader

java.lang.Object

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

es.uam.eps.ir.relison.grid.diffusion.protocol.ProtocolParameterReader

public class ProtocolParameterReader
extends ParametersReader

Reads the parameters for diffusion protocols.

Field Summary

Fields

Modifier and Type	Field	Description
private ExpirationParameterReader	expiration	In case the protocol is custom, the expiration mechanism
private static java.lang.String	EXPIRATION	Identifier for the expiration mechanism
private java.lang.String	name	Protocol name
private static java.lang.String	NAME	Identifier for the name of the protocol
private Parameters	params	In case the protocol is preconfigured, its parameters
private static java.lang.String	PARAMS	Identifier for the parameters of the protocol
private boolean	preconfigured	Indicates if the protocol is custom or preconfigured
private PropagationParameterReader	propagation	In case the protocol is custom, the propagation mechanism
private static java.lang.String	PROPAGATION	Identifier for the propagation mechanism
private SelectionParameterReader	selection	In case the protocol is custom, the protocol mechanism
private static java.lang.String	SELECTION	Identifier for the protocol mechanism
private SightParameterReader	sight	In case the protocol is custom, the sight mechanism
private static java.lang.String	SIGHT	Identifier for the sight mechanism
private static java.lang.String	TYPE	Identifier for the type of the protocol
private UpdateParameterReader	update	In case the protocol is custom, the update mechanism
private static java.lang.String	UPDATE	Identifier for the update mechanism

Constructor Summary

Constructors

Constructor	Description
ProtocolParameterReader()

Method Summary

Modifier and Type	Method	Description
ExpirationParameterReader	getExpiration()	Obtains the parameters for the expiration mechanism.
java.lang.String	getName()	Obtains the name of the protocol.
Parameters	getParams()	Obtains the parameters for the preconfigured protocol.
PropagationParameterReader	getPropagation()	Obtains the parameters for the propagation mechanism.
SelectionParameterReader	getSelection()	Obtains the parameters for the protocol mechanism.
SightParameterReader	getSight()	Obtains the parameters for the sight mechanism.
UpdateParameterReader	getUpdate()	Obtains the parameters for the update mechanism.
boolean	isPreconfigured()	Indicates if the protocol is preconfigured or custom.
java.lang.String	printProtocol()	Shows the configuration of a protocol.
void	readProtocol(java.util.Map<java.lang.String,java.lang.Object> protocol)	Reads a protocol from an XML.

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

Protocol name

params

private Parameters params

In case the protocol is preconfigured, its parameters

selection

private SelectionParameterReader selection

In case the protocol is custom, the protocol mechanism

expiration

private ExpirationParameterReader expiration

In case the protocol is custom, the expiration mechanism

update

private UpdateParameterReader update

In case the protocol is custom, the update mechanism

propagation

private PropagationParameterReader propagation

In case the protocol is custom, the propagation mechanism

sight

private SightParameterReader sight

In case the protocol is custom, the sight mechanism

preconfigured

private boolean preconfigured

Indicates if the protocol is custom or preconfigured

NAME

private static final java.lang.String NAME

Identifier for the name of the protocol

See Also:

Constant Field Values

TYPE

private static final java.lang.String TYPE

Identifier for the type of the protocol

See Also:

Constant Field Values

PARAMS

private static final java.lang.String PARAMS

Identifier for the parameters of the protocol

See Also:

Constant Field Values

SELECTION

private static final java.lang.String SELECTION

Identifier for the protocol mechanism

See Also:

Constant Field Values

EXPIRATION

private static final java.lang.String EXPIRATION

Identifier for the expiration mechanism

See Also:

Constant Field Values

UPDATE

private static final java.lang.String UPDATE

Identifier for the update mechanism

See Also:

Constant Field Values

PROPAGATION

private static final java.lang.String PROPAGATION

Identifier for the propagation mechanism

See Also:

Constant Field Values

SIGHT

private static final java.lang.String SIGHT

Identifier for the sight mechanism

See Also:

Constant Field Values

Constructor Details

ProtocolParameterReader

public ProtocolParameterReader()

Method Details

readProtocol

public void readProtocol(java.util.Map<java.lang.String,java.lang.Object> protocol)

Reads a protocol from an XML.

Parameters:

protocol - the element containing the protocol information.

getName

public java.lang.String getName()

Obtains the name of the protocol.

Returns:

the name of the protocol.

getParams

public Parameters getParams()

Obtains the parameters for the preconfigured protocol.

Returns:

the parameters if it is preconfigured, null if not.

getSelection

public SelectionParameterReader getSelection()

Obtains the parameters for the protocol mechanism.

Returns:

the parameters if it is not preconfigured, null if not.

getExpiration

public ExpirationParameterReader getExpiration()

Obtains the parameters for the expiration mechanism.

Returns:

the parameters if it is not preconfigured, null if not.

getUpdate

public UpdateParameterReader getUpdate()

Obtains the parameters for the update mechanism.

Returns:

the parameters if it is not preconfigured, null if not.

getPropagation

public PropagationParameterReader getPropagation()

Obtains the parameters for the propagation mechanism.

Returns:

the parameters if it is not preconfigured, null if not.

getSight

public SightParameterReader getSight()

Obtains the parameters for the sight mechanism.

Returns:

the parameters if it is not preconfigured, null if not.

isPreconfigured

public boolean isPreconfigured()

Indicates if the protocol is preconfigured or custom.

Returns:

true if the protocol is preconfigured, false if it is custom.

printProtocol

public java.lang.String printProtocol()

Shows the configuration of a protocol.

Returns:

a string containing the configuration of the protocol.