com.browseengine.bobo.api

Class BrowseHit

java.lang.Object

com.browseengine.bobo.api.BrowseHit

All Implemented Interfaces:

Serializable

public class BrowseHit
extends Object
implements Serializable

A hit from a browse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BrowseHit.TermFrequencyVector

Constructor Summary

Constructors

Constructor and Description
BrowseHit()

Method Summary

Methods

Modifier and Type	Method and Description
Comparable<?>	getComparable()
int	getDocid() Gets the internal document id
org.apache.lucene.search.Explanation	getExplanation()
String	getField(String field) Get the field value
String[]	getFields(String field) Get the field values
Map<String,String[]>	getFieldValues() Gets the field values
String	getGroupField()
BrowseHit[]	getGroupHits()
int	getGroupHitsCount()
int	getGroupPosition()
String	getGroupValue()
Object	getRawField(String field) Get the raw field value
Object[]	getRawFields(String field) Get the raw field values
Map<String,Object[]>	getRawFieldValues() Gets the raw field values
Object	getRawGroupValue()
float	getScore() Get the score
org.apache.lucene.document.Document	getStoredFields()
Map<String,BrowseHit.TermFrequencyVector>	getTermFreqMap()
BrowseHit	setComparable(Comparable<?> comparable)
BrowseHit	setDocid(int docid) Sets the internal document id
BrowseHit	setExplanation(org.apache.lucene.search.Explanation explanation)
BrowseHit	setFieldValues(Map<String,String[]> fieldValues) Sets the field value map
BrowseHit	setGroupField(String field)
BrowseHit	setGroupHits(BrowseHit[] hits)
BrowseHit	setGroupHitsCount(int count)
BrowseHit	setGroupPosition(int pos)
BrowseHit	setGroupValue(String group)
BrowseHit	setRawFieldValues(Map<String,Object[]> rawFieldValues) Sets the raw field value map
BrowseHit	setRawGroupValue(Object group)
BrowseHit	setScore(float score) Sets the score
BrowseHit	setStoredFields(org.apache.lucene.document.Document doc)
BrowseHit	setTermFreqMap(Map<String,BrowseHit.TermFrequencyVector> termFreqMap)
String	toString()
String	toString(Map<String,String[]> map)

Methods inherited from class java.lang.Object

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

Constructor Detail

BrowseHit

public BrowseHit()

Method Detail

getScore

public float getScore()

Get the score

Returns:

score

See Also:

setScore(float)

getFields

public String[] getFields(String field)

Get the field values

Parameters:

field - field name

Returns:

field value array

See Also:

getField(String)

getRawFields

public Object[] getRawFields(String field)

Get the raw field values

Parameters:

field - field name

Returns:

field value array

See Also:

getRawField(String)

getField

public String getField(String field)

Get the field value

Parameters:

field - field name

Returns:

field value

See Also:

getFields(String)

getRawField

public Object getRawField(String field)

Get the raw field value

Parameters:

field - field name

Returns:

raw field value

See Also:

getRawFields(String)

getTermFreqMap

public Map<String,BrowseHit.TermFrequencyVector> getTermFreqMap()

setTermFreqMap

public BrowseHit setTermFreqMap(Map<String,BrowseHit.TermFrequencyVector> termFreqMap)

getGroupPosition

public int getGroupPosition()

setGroupPosition

public BrowseHit setGroupPosition(int pos)

getGroupField

public String getGroupField()

setGroupField

public BrowseHit setGroupField(String field)

getGroupValue

public String getGroupValue()

setGroupValue

public BrowseHit setGroupValue(String group)

getRawGroupValue

public Object getRawGroupValue()

setRawGroupValue

public BrowseHit setRawGroupValue(Object group)

getGroupHitsCount

public int getGroupHitsCount()

setGroupHitsCount

public BrowseHit setGroupHitsCount(int count)

getGroupHits

public BrowseHit[] getGroupHits()

setGroupHits

public BrowseHit setGroupHits(BrowseHit[] hits)

getExplanation

public org.apache.lucene.search.Explanation getExplanation()

setExplanation

public BrowseHit setExplanation(org.apache.lucene.search.Explanation explanation)

setComparable

public BrowseHit setComparable(Comparable<?> comparable)

getComparable

public Comparable<?> getComparable()

getDocid

public int getDocid()

Gets the internal document id

Returns:

document id

See Also:

setDocid(int)

setDocid

public BrowseHit setDocid(int docid)

Sets the internal document id

Parameters:

docid - document id

See Also:

getDocid()

getFieldValues

public Map<String,String[]> getFieldValues()

Gets the field values

Returns:

field value map

See Also:

setFieldValues(Map)

setRawFieldValues

public BrowseHit setRawFieldValues(Map<String,Object[]> rawFieldValues)

Sets the raw field value map

Parameters:

rawFieldValues - raw field value map

See Also:

getRawFieldValues()

getRawFieldValues

public Map<String,Object[]> getRawFieldValues()

Gets the raw field values

Returns:

raw field value map

See Also:

setRawFieldValues(Map)

setFieldValues

public BrowseHit setFieldValues(Map<String,String[]> fieldValues)

Sets the field value map

Parameters:

fieldValues - field value map

See Also:

getFieldValues()

setScore

public BrowseHit setScore(float score)

Sets the score

Parameters:

score - score

See Also:

getScore()

setStoredFields

public BrowseHit setStoredFields(org.apache.lucene.document.Document doc)

getStoredFields

public org.apache.lucene.document.Document getStoredFields()

toString

public String toString(Map<String,String[]> map)

toString

public String toString()

Overrides:

toString in class Object