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

Interface SearchResultDocument

All Known Implementing Classes:

BaseSearchResultDocument

public interface SearchResultDocument

The concrete representation of a document in the search index. Obtained in response to a query.

Method Summary

Modifier and Type	Method and Description
Collection<String>	getFieldNames() May return an empty collection, but never null.
Collection<Object>	getFieldValues(String name) Get the values for the named field.
Map<String,Collection<Object>>	getFieldValuesMap() May return an empty map, but never null.
Object	getFirstValue(String name) May return null.
String	getStringValue(String name) Gets the first value for the named field, and converts it to a String.
String	getUniqueId() A document identifier that can be used in SearchEngine.deleteById(); Never null.

Method Detail

getUniqueId

String getUniqueId()

A document identifier that can be used in SearchEngine.deleteById(); Never null.

getFieldNames

Collection<String> getFieldNames()

May return an empty collection, but never null.

getFirstValue

Object getFirstValue(String name)

May return null.

getStringValue

String getStringValue(String name)

Gets the first value for the named field, and converts it to a String. May return null.

getFieldValues

Collection<Object> getFieldValues(String name)

Get the values for the named field. May return an empty collection, but never null.

getFieldValuesMap

Map<String,Collection<Object>> getFieldValuesMap()

May return an empty map, but never null. The values collection for any key may be empty, but never null.