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

Constructor Summary

BrowseHit()

Method Summary

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
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
float	getScore() Get the score
org.apache.lucene.document.Document	getStoredFields()
void	setComparable(Comparable<?> comparable)
void	setDocid(int docid) Sets the internal document id
void	setExplanation(org.apache.lucene.search.Explanation explanation)
void	setFieldValues(Map<String,String[]> fieldValues) Sets the field value map
void	setRawFieldValues(Map<String,Object[]> rawFieldValues) Sets the raw field value map
void	setScore(float score) Sets the score
void	setStoredFields(org.apache.lucene.document.Document doc)
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)

getExplanation

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

setExplanation

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

setComparable

public void 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 void 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 void 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 void setFieldValues(Map<String,String[]> fieldValues)

Sets the field value map

Parameters:

fieldValues - field value map

See Also:

getFieldValues()

setScore

public void setScore(float score)

Sets the score

Parameters:

score - score

See Also:

getScore()

setStoredFields

public void 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