org.eclipse.smila.processing.parameters
Class ParameterAccessor

java.lang.Object
  org.eclipse.smila.processing.parameters.ParameterAccessor

public class ParameterAccessor
extends java.lang.Object

read service runtime parameters from current processing record, query record and pipelet configurations.

Author:

jschumacher

Constructor Summary

ParameterAccessor(Blackboard blackboard)
create accessor for given blackboard.

ParameterAccessor(Blackboard blackboard, Id query)
for search pipelets/services: create accessor for given blackboard and ID effective query record for fallback.

Method Summary

Annotation	getAnnotation(java.lang.String name) access to first subannotation, according to precedence rules (no fallback to PipeletConfig possible, of course).
java.util.List<Annotation>	getAnnotations(java.lang.String name) access to a multiple sub annotations, according to precedence rules (no fallback to PipeletConfig possible, of course).
java.lang.Boolean	getBooleanParameter(java.lang.String name, java.lang.Boolean defaultValue) type-aware convenience method: convert result of getParameter() to Boolean.
java.lang.Double	getFloatParameter(java.lang.String name, java.lang.Double defaultValue) type-aware convenience method: convert result of getParameter() to Double.
java.lang.String	getIndexName() get the value of indexName parameter.
java.lang.Integer	getIntParameter(java.lang.String name, java.lang.Integer defaultValue) type-aware convenience method: convert result of getParameter() to Integer.
java.lang.String	getLanguage() get the value of language parameter.
java.util.Iterator<java.lang.String>	getOrderByAttributeNames() get iterator on names of attributes that have an order-by parameter set.
SearchParameters.OrderMode	getOrderMode(java.lang.String attributeName) get order mode for an attribute.
java.lang.String	getParameter(java.lang.String name, java.lang.String defaultValue) get named value of parameter annotation, according to precedence rules.
java.util.List<java.lang.String>	getParameters(java.lang.String name) get anonymous values of first (according to precendence rules) subannotation.
java.lang.String	getQuery() access to predefined parameters as supported in the search API.
java.lang.Boolean	getRequiredBooleanParameter(java.lang.String name) type-aware convenience method: convert result of getRequiredParameter() to Boolean.
java.lang.Double	getRequiredFloatParameter(java.lang.String name) type-aware convenience method: convert result of getRequiredParameter() to Double.
java.lang.Integer	getRequiredIntParameter(java.lang.String name) type-aware convenience method: convert result of getRequiredParameter() to Integer.
java.lang.String	getRequiredParameter(java.lang.String name) get named value of parameter annotation, according to precedence rules.
java.util.List<java.lang.String>	getRequiredParameters(java.lang.String name) get anonymous values of first (according to precendence rules) subannotation.
java.util.List<java.lang.String>	getResultAttributes() Get the values (names of attributes) of resultAttributes parameter.
int	getResultOffset() get the value of result offset parameter.
int	getResultSize() get the value of result size parameter.
double	getThreshold() get the value of threshold parameter.
ParameterAccessor	setCurrentRecord(Id currentRecord) set the ID of the record to read parameters from.
ParameterAccessor	setPipeletConfiguration(PipeletConfiguration config) set the configuration of the current pipelet, to read fallback values for missing parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterAccessor

public ParameterAccessor(Blackboard blackboard)

create accessor for given blackboard.

Parameters:

blackboard - blackboard instance.

ParameterAccessor

public ParameterAccessor(Blackboard blackboard,
                         Id query)

for search pipelets/services: create accessor for given blackboard and ID effective query record for fallback.

Parameters:

blackboard - blackboard instance.

query - current query record.

Method Detail

setCurrentRecord

public ParameterAccessor setCurrentRecord(Id currentRecord)

set the ID of the record to read parameters from.

Parameters:

currentRecord - current record to proces.

Returns:

"this", make it easier to use this method immediately after constructor.

setPipeletConfiguration

public ParameterAccessor setPipeletConfiguration(PipeletConfiguration config)

set the configuration of the current pipelet, to read fallback values for missing parameters.

Parameters:

config - pipelet configuration.

Returns:

"this", make it easier to use this method immediately after constructor

getQuery

public java.lang.String getQuery()

access to predefined parameters as supported in the search API.

Returns:

textual query string. null, if none is set.

getResultSize

public int getResultSize()

get the value of result size parameter. Default value is 10.

Returns:

value of result size parameter.

getResultOffset

public int getResultOffset()

get the value of result offset parameter. Default value is 0.

Returns:

value of result offset parameter

getThreshold

public double getThreshold()

get the value of threshold parameter. Default value is 0.0.

Returns:

value of threshold parameter

getLanguage

public java.lang.String getLanguage()

get the value of language parameter. Default value is null

Returns:

value of language parameter

getIndexName

public java.lang.String getIndexName()

get the value of indexName parameter. Default value is null

Returns:

value of indexName parameter

getResultAttributes

public java.util.List<java.lang.String> getResultAttributes()

Get the values (names of attributes) of resultAttributes parameter. Default value is an empty list.

Returns:

values of resultAttributes parameter

getOrderByAttributeNames

public java.util.Iterator<java.lang.String> getOrderByAttributeNames()

get iterator on names of attributes that have an order-by parameter set. Order of iteration is order of precedence in ordering.

Returns:

names of attributes to be ordered.

getOrderMode

public SearchParameters.OrderMode getOrderMode(java.lang.String attributeName)

get order mode for an attribute.

Parameters:

attributeName - attribute name

Returns:

mode for attribute, if specified, or null else.

getParameter

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

get named value of parameter annotation, according to precedence rules.

Parameters:

name - parameter name

defaultValue - default value.

Returns:

return default value if no matching parameter value can be found

getRequiredParameter

public java.lang.String getRequiredParameter(java.lang.String name)
                                      throws MissingParameterException

get named value of parameter annotation, according to precedence rules.

Parameters:

name - parameter name.

Returns:

parameter value.

Throws:

MissingParameterException - if no matching parameter value can be found.

getParameters

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

get anonymous values of first (according to precendence rules) subannotation.

Parameters:

name - parameter name

Returns:

anonymous values of named subannotation, or empty list if no matching parameter value can be found

getRequiredParameters

public java.util.List<java.lang.String> getRequiredParameters(java.lang.String name)
                                                       throws MissingParameterException

get anonymous values of first (according to precendence rules) subannotation.

Parameters:

name - parameter name

Returns:

anonymous values of named subannotation,

Throws:

MissingParameterException - if no matching parameter value can be found.

getIntParameter

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

type-aware convenience method: convert result of getParameter() to Integer. Throws NumberFormatException, if parameter value is not in valid integer format.

Parameters:

name - parameter name

defaultValue - default value

Returns:

integer value

getFloatParameter

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

type-aware convenience method: convert result of getParameter() to Double. Throws NumberFormatException if parameter value is not in valid double format.

Parameters:

name - parameter name

defaultValue - default value

Returns:

double value

getBooleanParameter

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

type-aware convenience method: convert result of getParameter() to Boolean.

Parameters:

name - parameter name

defaultValue - default value

Returns:

double value

getRequiredIntParameter

public java.lang.Integer getRequiredIntParameter(java.lang.String name)
                                          throws MissingParameterException

type-aware convenience method: convert result of getRequiredParameter() to Integer. Throws NumberFormatException, if parameter value is not in valid integer format.

Parameters:

name - parameter name

Returns:

integer value *

Throws:

MissingParameterException - if no matching parameter value can be found.

getRequiredFloatParameter

public java.lang.Double getRequiredFloatParameter(java.lang.String name)
                                           throws MissingParameterException

type-aware convenience method: convert result of getRequiredParameter() to Double. Throws NumberFormatException, if parameter value is not in valid double format.

Parameters:

name - parameter name

Returns:

floating point value *

Throws:

MissingParameterException - if no matching parameter value can be found.

getRequiredBooleanParameter

public java.lang.Boolean getRequiredBooleanParameter(java.lang.String name)
                                              throws MissingParameterException

type-aware convenience method: convert result of getRequiredParameter() to Boolean.

Parameters:

name - parameter name

Returns:

boolean value *

Throws:

MissingParameterException - if no matching parameter value can be found.

getAnnotation

public Annotation getAnnotation(java.lang.String name)

access to first subannotation, according to precedence rules (no fallback to PipeletConfig possible, of course).

Parameters:

name - annotation name.

Returns:

annotation object.

getAnnotations

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

access to a multiple sub annotations, according to precedence rules (no fallback to PipeletConfig possible, of course). The annotations are not merged from multiple sources

Parameters:

name - annotation name.

Returns:

list of annotations.