Package edu.cornell.mannlib.vitro.webapp.modules.searchEngine

Interface SearchInputDocument

All Known Implementing Classes:

BaseSearchInputDocument

public interface SearchInputDocument

A collection of fields and values that will be used to build a record in the search index.

Method Summary

Modifier and Type	Method	Description
void	addField(SearchInputField field)	Put the field into the document.
void	addField(String name, float boost, Object... values)	Create a field with this name, boost level and values, and put it into the document.
void	addField(String name, float boost, Collection<Object> values)	Create a field with this name, boost level and values, and put it into the document.
void	addField(String name, Object... values)	Create a field with this name and values, and put it into the document.
void	addField(String name, Collection<Object> values)	Create a field with this name and values, and put it into the document.
SearchInputField	createField(String name)	Create a field that can be populated and added to the document.
float	getDocumentBoost()
SearchInputField	getField(String name)	May return null.
Map<String,SearchInputField>	getFieldMap()	May return an empty map, but never null.
void	setDocumentBoost(float searchBoost)	Set a boost level for the document as a whole.

Method Detail

createField

SearchInputField createField(String name)

Create a field that can be populated and added to the document.

addField

void addField(SearchInputField field)

Put the field into the document. If a field with this name already exists in the document, it will be replaced.

addField

void addField(String name,
              Object... values)

Create a field with this name and values, and put it into the document. If a field with this name already exists in the document, these values will be added to the existing values on the field.

addField

void addField(String name,
              Collection<Object> values)

Create a field with this name and values, and put it into the document. If a field with this name already exists in the document, these values will be added to the existing values on the field.

addField

void addField(String name,
              float boost,
              Object... values)

Create a field with this name, boost level and values, and put it into the document. If a field with this name already exists in the document, these values will be added to the existing values on the field, and the existing boost will be multipled by this boost.

addField

void addField(String name,
              float boost,
              Collection<Object> values)

Create a field with this name, boost level and values, and put it into the document. If a field with this name already exists in the document, these values will be added to the existing values on the field, and the existing boost will be multipled by this boost.

setDocumentBoost

void setDocumentBoost(float searchBoost)

Set a boost level for the document as a whole.

getDocumentBoost

float getDocumentBoost()

getField

SearchInputField getField(String name)

May return null.

getFieldMap

Map<String,SearchInputField> getFieldMap()

May return an empty map, but never null.