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

Class BaseSearchResultDocument

java.lang.Object

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

All Implemented Interfaces:

SearchResultDocument

public class BaseSearchResultDocument
extends Object
implements SearchResultDocument

A foundation class for implementing SearchResultDocument.

Constructor Summary

Constructors

Constructor and Description
BaseSearchResultDocument(String uniqueId, Map<String,Collection<Object>> fieldValuesMap)

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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseSearchResultDocument

public BaseSearchResultDocument(String uniqueId,
                                Map<String,Collection<Object>> fieldValuesMap)

Method Detail

getUniqueId

public String getUniqueId()

Description copied from interface: SearchResultDocument

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

Specified by:

getUniqueId in interface SearchResultDocument

getFieldNames

public Collection<String> getFieldNames()

Description copied from interface: SearchResultDocument

May return an empty collection, but never null.

Specified by:

getFieldNames in interface SearchResultDocument

getFirstValue

public Object getFirstValue(String name)

Description copied from interface: SearchResultDocument

May return null.

Specified by:

getFirstValue in interface SearchResultDocument

getStringValue

public String getStringValue(String name)

Description copied from interface: SearchResultDocument

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

Specified by:

getStringValue in interface SearchResultDocument

getFieldValues

public Collection<Object> getFieldValues(String name)

Description copied from interface: SearchResultDocument

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

Specified by:

getFieldValues in interface SearchResultDocument

getFieldValuesMap

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

Description copied from interface: SearchResultDocument

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

Specified by:

getFieldValuesMap in interface SearchResultDocument

toString

public String toString()

Overrides:

toString in class Object