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

java.lang.Object
  org.eclipse.smila.search.api.helper.ResultAccessor
      org.eclipse.smila.search.api.helper.ResultBuilder

Direct Known Subclasses:

SolrResultBuilder

public class ResultBuilder
extends ResultAccessor

wrapper helper class to build the result record. This is intentionally a subclass of the ResultAccessor as to also provide read access to the props that are set here.

Field Summary

Fields inherited from class org.eclipse.smila.search.api.helper.ResultAccessor

_result

Constructor Summary

ResultBuilder(java.lang.String workflowName, Record result)
Creates a new builder and adds an AnySeq for the SearchResultConstants.RECORDS.

Method Summary

AnySeq	addGroup(java.lang.String groupName) Adds group Seq with the given name and returns it.
AnyMap	addGroupValue(AnySeq group, Any value, java.lang.Long count) Adds the map containing the count and value for the group value.
AnyMap	addGroupValue(AnySeq group, java.lang.Object value, java.lang.Long count) Adds the map containing the count and value for the group value.
AnyMap	addResultItem(java.lang.String id, java.lang.Double score) Adds a new result item to the list.
void	setCount(java.lang.Long count) sets value for SearchResultConstants.COUNT.
void	setRuntime(java.lang.Long millis) sets value for SearchResultConstants.RUNTIME.

Methods inherited from class org.eclipse.smila.search.api.helper.ResultAccessor

getCount, getGroups, getIndexSize, getNumberOfRecords, getQuery, getResult, getResultRecord, getResultRecords, getRuntime, getWorkflowName, hasQuery, hasRecords

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultBuilder

public ResultBuilder(java.lang.String workflowName,
                     Record result)

Creates a new builder and adds an AnySeq for the SearchResultConstants.RECORDS.

Parameters:

workflowName -

result -

Method Detail

addResultItem

public AnyMap addResultItem(java.lang.String id,
                            java.lang.Double score)

Adds a new result item to the list. the given args are mandatory and will be set at the item.

Returns:

the map containing the id and score/weight under their proper names.

setCount

public void setCount(java.lang.Long count)

sets value for SearchResultConstants.COUNT.

setRuntime

public void setRuntime(java.lang.Long millis)

sets value for SearchResultConstants.RUNTIME.

addGroup

public AnySeq addGroup(java.lang.String groupName)

Adds group Seq with the given name and returns it. The groups map is created on the fly if needs be.

addGroupValue

public AnyMap addGroupValue(AnySeq group,
                            Any value,
                            java.lang.Long count)

Adds the map containing the count and value for the group value.

Parameters:

group - NullArgumentException if null

value - NullArgumentException if null

count - if null the count property is not set

Returns:

the map of the added group

addGroupValue

public AnyMap addGroupValue(AnySeq group,
                            java.lang.Object value,
                            java.lang.Long count)

Adds the map containing the count and value for the group value.

Parameters:

group - any valid literal object that can be passed into DataFactory.autoConvertValue(Object)

Returns:

the map for added value containing the value and count