org.eclipse.smila.search.api.helper
Class ParameterAnnotation

java.lang.Object
  org.eclipse.smila.search.api.helper.ParameterAnnotation

public class ParameterAnnotation
extends java.lang.Object

wrapper for access to the service runtime parameters annotation of an record.

Author:

jschumacher

Constructor Summary

ParameterAnnotation(Record record)
create wrapper for record.

Method Summary

void	addParameter(java.lang.String name, java.lang.String value) add a value to a multi valued parameter.
Annotation	getAnnotation() ensure that the record has a parameters annotation and return it.
java.lang.Boolean	getBooleanParameter(java.lang.String name) get a single valued parameter value as a boolean value.
java.lang.Double	getFloatParameter(java.lang.String name) get a single valued parameter value as an floating point value.
java.lang.Integer	getIntParameter(java.lang.String name) get a single valued parameter value as an integer value.
java.lang.String	getParameter(java.lang.String name) get a single valued parameter value.
java.util.List<java.lang.String>	getParameters(java.lang.String name) get a multi valued parameter's value list.
java.util.List<Annotation>	getSubAnnotations(java.lang.String name) get unmodifiable list of subannotations.
void	setBooleanParameter(java.lang.String name, boolean value) set a single valued parameter to an boolean value.
void	setFloatParameter(java.lang.String name, double value) set a single valued parameter to an floating point value.
void	setIntParameter(java.lang.String name, int value) set a single valued parameter to an int value.
void	setParameter(java.lang.String name, java.lang.String value) set a single valued parameter.
void	setParameters(java.lang.String name, java.util.Collection<java.lang.String> values) set a multi valued parameter to a collection of string.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterAnnotation

public ParameterAnnotation(Record record)

create wrapper for record.

Parameters:

record - usually a query record.

Method Detail

getAnnotation

public Annotation getAnnotation()

ensure that the record has a parameters annotation and return it.

Returns:

parameter annotation

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)

set a single valued parameter.

Parameters:

name - parameter name

value - parameter value

setIntParameter

public void setIntParameter(java.lang.String name,
                            int value)

set a single valued parameter to an int value.

Parameters:

name - parameter name

value - parameter value

setFloatParameter

public void setFloatParameter(java.lang.String name,
                              double value)

set a single valued parameter to an floating point value.

Parameters:

name - parameter name

value - parameter value

setBooleanParameter

public void setBooleanParameter(java.lang.String name,
                                boolean value)

set a single valued parameter to an boolean value.

Parameters:

name - parameter name

value - parameter value

getParameter

public java.lang.String getParameter(java.lang.String name)

get a single valued parameter value.

Parameters:

name - parameter name

Returns:

parameter value

getIntParameter

public java.lang.Integer getIntParameter(java.lang.String name)

get a single valued parameter value as an integer value.

Parameters:

name - parameter name

Returns:

parameter value. Null, if the value does not exists or cannot be parsed as an Integer.

getFloatParameter

public java.lang.Double getFloatParameter(java.lang.String name)

get a single valued parameter value as an floating point value.

Parameters:

name - parameter name

Returns:

parameter value. Null, if the value does not exists or cannot be parsed as a Double.

getBooleanParameter

public java.lang.Boolean getBooleanParameter(java.lang.String name)

get a single valued parameter value as a boolean value.

Parameters:

name - parameter name

Returns:

parameter value. Null, if the value does not exists.

setParameters

public void setParameters(java.lang.String name,
                          java.util.Collection<java.lang.String> values)

set a multi valued parameter to a collection of string. Existing values are overwritten.

Parameters:

name - parameter name.

values - parameter values.

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)

add a value to a multi valued parameter.

Parameters:

name - parameter name

value - additional parameter value.

getParameters

public java.util.List<java.lang.String> getParameters(java.lang.String name)

get a multi valued parameter's value list. The returned list is not modifiiable, use addParameter(String, String) and setParameters(String, Collection) to change the value.

Parameters:

name - parameter name

Returns:

list of values. empty list, if parameter is not set.

getSubAnnotations

public java.util.List<Annotation> getSubAnnotations(java.lang.String name)

get unmodifiable list of subannotations.

Parameters:

name - annotation name

Returns:

unmodifiable list of subannotations