Package org.aksw.faraday_cage.parameter

Interface ParameterMap

All Known Implementing Classes:

ParameterMapImpl

public interface ParameterMap

A ParameterMap serves as registry of Parameters that can be used to configure a ParametrizedPlugin.

A ParameterMap holds a list of Parameter instances upon its initialization, therefore acting as a registry of allowed Parameters.
Furthermore, a ParameterMap supports setting values of its parameters either directly or automatically via ParameterConversion of a supplied RDF subgraph.
Calling init(Resource) on a given ParameterMap will change its state to initialized and prevent further modification of its values, effectively making it immutable. It is mandatory to call init(Resource) before getting values from a ParameterMap.

Field Summary

Fields

Modifier and Type	Field	Description
static ParameterMap	EMPTY_INSTANCE	An empty, unmodifiable instance

Method Summary

Modifier and Type	Method	Description
java.util.Set<Parameter>	getAllParameters()
<T> T	getValue(Parameter p)	Get the value for the given parameter.
<T> T	getValue(Parameter p, T defaultValue)	Get the value for the given parameter, or the defaultValue, if it has not been set.
ParameterMap	init(org.apache.jena.rdf.model.Resource r)	Initialize this ParameterMap, making it immutable and enabling the getters.
ParameterMap	setValue(Parameter p, java.lang.Object node)	Directly set a value for a parameter.

Field Detail

EMPTY_INSTANCE

static final ParameterMap EMPTY_INSTANCE

An empty, unmodifiable instance

Method Detail

getAllParameters

java.util.Set<Parameter> getAllParameters()

Returns:

a list of this ParameterMaps supported parameters

setValue

ParameterMap setValue(Parameter p,
                      java.lang.Object node)
               throws java.lang.IllegalStateException

Directly set a value for a parameter.

Parameters:

p - the parameter which should be set

node - the value to set for the given parameter

Returns:

this ParameterMap, for method chaining

Throws:

java.lang.IllegalStateException - if this ParameterMap has already been initialized

getValue

<T> T getValue(Parameter p)
        throws java.lang.IllegalStateException

Get the value for the given parameter. Makes use of return type inference to avoid manual casting.

Type Parameters:

T - this methods generic return type

Parameters:

p - the parameter to get

Returns:

the value for the given parameter

Throws:

java.lang.IllegalStateException - if this ParameterMap has not been initialized yet

getValue

<T> T getValue(Parameter p,
               T defaultValue)
        throws java.lang.IllegalStateException

Get the value for the given parameter, or the defaultValue, if it has not been set. Makes use of return type inference to avoid manual casting.

Type Parameters:

T - this methods generic return type

Parameters:

p - the parameter to get

defaultValue - a defaultValue as fallback

Returns:

defaultVaue if the value has not been set or has been set to null; otherwise, the value of parameter p

Throws:

java.lang.IllegalStateException - if this ParameterMap has not been initialized yet

init

ParameterMap init(org.apache.jena.rdf.model.Resource r)

Initialize this ParameterMap, making it immutable and enabling the getters.

Parameters:

r - if not null, this Resource and its corresponding subgraph will be used for automatic parameter value assignment

Returns:

this ParameterMap, for method chaining