SMILA 1.0 API documentation

org.eclipse.smila.solr.search
Class SolrQueryParameterAccessor

java.lang.Object
  extended by org.eclipse.smila.processing.parameters.ParameterAccessor
      extended by org.eclipse.smila.search.api.helper.QueryParameterAccessor
          extended by org.eclipse.smila.solr.search.SolrQueryParameterAccessor

public class SolrQueryParameterAccessor
extends QueryParameterAccessor

The SolrQueryParameterAccessor.

Author:
pwissel

Field Summary
 
Fields inherited from class org.eclipse.smila.processing.parameters.ParameterAccessor
_blackboard, _config, _parametersAttribute, _recordId, DEFAULT_PARAMETERS_ATTRIBUTE
 
Constructor Summary
SolrQueryParameterAccessor(Blackboard blackboard, AnyMap configuration, java.lang.String queryRecordId)
          Constructor.
SolrQueryParameterAccessor(Blackboard blackboard, java.lang.String queryRecordId)
          Constructor.
 
Method Summary
 AnyMap getFilterGroups()
          returns the map containing the configs for the filter groups or null.
 AnyMap getFilterLocalParams()
          returns the localParams map from SolrConstants.QUERY_MAP for the requested filter group or null.
 AnyMap getFilterLocalParams(java.lang.String filterGroup, boolean create)
          returns the localParams map from SolrConstants.QUERY_MAP for the requested filter group or null.
 AnySeq getFilterQuery()
          Get filter query.
 AnyMap getMoreLikeThis()
          Get request handler.
 java.lang.String getRequestHandler()
          Get request handler.
 AnySeq getShards()
          Get shards.
 AnyMap getSolrQueryParams()
           
 AnyMap getSpellcheck()
          Get spellcheck.
 AnyMap getTerms()
          Get terms.
 
Methods inherited from class org.eclipse.smila.search.api.helper.QueryParameterAccessor
getFacetByConfig, getFilter, getFilterAttributeNames, getFilters, getGroupbyConfig, getHighlightConfig, getIndexName, getLanguage, getMaxCount, getOffset, getQuery, getQueryAttributeValues, getQueryRequired, getRankingConfig, getResultAttributes, getSortByAttributeNames, getSortByConfig, getSortOrder, getThreshold, hasFilters, hasGroupbyConfig, hasHighlightConfig, hasQueryAttribute, hasQueryAttributes, setCurrentRecord, setPipeletConfiguration
 
Methods inherited from class org.eclipse.smila.processing.parameters.ParameterAccessor
getBooleanParameter, getFloatParameter, getIntParameter, getParameter, getParameterAny, getParameterAttribute, getParameters, getRequiredBooleanParameter, getRequiredFloatParameter, getRequiredIntParameter, getRequiredParameter, getRequiredParameters, getSubParameter, getSubParameters, setParameterAttribute
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SolrQueryParameterAccessor

public SolrQueryParameterAccessor(Blackboard blackboard,
                                  java.lang.String queryRecordId)
                           throws BlackboardAccessException
Constructor.

Parameters:
blackboard - the blackboard.
queryRecordId - the query record id.
Throws:
BlackboardAccessException

SolrQueryParameterAccessor

public SolrQueryParameterAccessor(Blackboard blackboard,
                                  AnyMap configuration,
                                  java.lang.String queryRecordId)
                           throws BlackboardAccessException
Constructor.

Parameters:
blackboard - the blackboard.
configuration - the configuration.
queryRecordId - the query record id.
Throws:
BlackboardAccessException
Method Detail

getRequestHandler

public java.lang.String getRequestHandler()
Get request handler.

Returns:
the request handler or null.

getTerms

public AnyMap getTerms()
Get terms.

Returns:
the term map or null.

getFilterQuery

public AnySeq getFilterQuery()
Get filter query.

Returns:
the filter query sequence or null.

getShards

public AnySeq getShards()
Get shards.

Returns:
the shards seq or null.

getSpellcheck

public AnyMap getSpellcheck()
Get spellcheck.

Returns:
the spellcheck map or null.

getSolrQueryParams

public AnyMap getSolrQueryParams()

getMoreLikeThis

public AnyMap getMoreLikeThis()
Get request handler.

Returns:
the request handler or null.

getFilterGroups

public AnyMap getFilterGroups()
returns the map containing the configs for the filter groups or null.


getFilterLocalParams

public AnyMap getFilterLocalParams()
returns the localParams map from SolrConstants.QUERY_MAP for the requested filter group or null.


getFilterLocalParams

public AnyMap getFilterLocalParams(java.lang.String filterGroup,
                                   boolean create)
returns the localParams map from SolrConstants.QUERY_MAP for the requested filter group or null.

Parameters:
filterGroup - the filter group
create - if true, then the intermediate maps are creared if missing.
Returns:
the filter local params

SMILA 1.0 API documentation