edu.cornell.mannlib.vitro.webapp.searchengine.base

Class BaseSearchInputDocument

java.lang.Object

edu.cornell.mannlib.vitro.webapp.searchengine.base.BaseSearchInputDocument

All Implemented Interfaces:

SearchInputDocument

public class BaseSearchInputDocument
extends Object
implements SearchInputDocument

A foundation class for implementing SearchInputDocument.

Constructor Summary

Constructors

Constructor and Description
BaseSearchInputDocument() Default constructor.
BaseSearchInputDocument(BaseSearchInputDocument doc) Create a deep copy, down to the value objects.

Method Summary

Modifier and Type	Method and Description
void	addField(SearchInputField field) Put the field into the document.
void	addField(String name, Collection<Object> values) Create a field with this name 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, float boost, 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.
SearchInputField	createField(String name) Sub-classes should override this if the field requires special functionality.
boolean	equals(Object obj)
float	getDocumentBoost()
SearchInputField	getField(String name) May return null.
Map<String,SearchInputField>	getFieldMap() May return an empty map, but never null.
int	hashCode()
void	setDocumentBoost(float searchBoost) Set a boost level for the document as a whole.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseSearchInputDocument

public BaseSearchInputDocument()

Default constructor.

BaseSearchInputDocument

public BaseSearchInputDocument(BaseSearchInputDocument doc)

Create a deep copy, down to the value objects.

Method Detail

addField

public void addField(SearchInputField field)

Description copied from interface: SearchInputDocument

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

Specified by:

addField in interface SearchInputDocument

addField

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

Description copied from interface: SearchInputDocument

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.

Specified by:

addField in interface SearchInputDocument

addField

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

Description copied from interface: SearchInputDocument

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.

Specified by:

addField in interface SearchInputDocument

addField

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

Description copied from interface: SearchInputDocument

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.

Specified by:

addField in interface SearchInputDocument

addField

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

Description copied from interface: SearchInputDocument

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.

Specified by:

addField in interface SearchInputDocument

setDocumentBoost

public void setDocumentBoost(float searchBoost)

Description copied from interface: SearchInputDocument

Set a boost level for the document as a whole.

Specified by:

setDocumentBoost in interface SearchInputDocument

getDocumentBoost

public float getDocumentBoost()

Specified by:

getDocumentBoost in interface SearchInputDocument

getField

public SearchInputField getField(String name)

Description copied from interface: SearchInputDocument

May return null.

Specified by:

getField in interface SearchInputDocument

getFieldMap

public Map<String,SearchInputField> getFieldMap()

Description copied from interface: SearchInputDocument

May return an empty map, but never null.

Specified by:

getFieldMap in interface SearchInputDocument

createField

public SearchInputField createField(String name)

Sub-classes should override this if the field requires special functionality.

Specified by:

createField in interface SearchInputDocument

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object