com.sssw.search.api
Interface EbiQueryResult

All Superinterfaces:

Serializable

All Known Subinterfaces:

EbiQueryResult

public interface EbiQueryResult

extends Serializable

Objects that implement this interface represent results returned by queries executed via the Search Service.

See Also:

EbiQueryEngine, EbiQuery

Field Summary

static String	PROP_DOC_QUICK_SUMMARY The Document Quick Summary property.
static String	PROP_DOC_WEIGHT The Document Weight (relevance ranking) property.
static String	PROP_ENGINE_DOC_ID The Query Engine Document ID property (the ID generated by the Query Engine).
static String	PROP_ENGINE_DOC_REF The Query Engine Document Reference property.

Method Summary

String[]	getArrayProperty(String propName, String delim) Gets a specific multi-valued property by its name.
Date[]	getDateArrayProperty(String propName, String delim) Gets a specific multi-valued Date property by its name.
Date	getDateProperty(String propName) Gets a specific Date property by its name.
String	getDebugSummary() Gets a debug summary for this object.
Integer[]	getIntegerArrayProperty(String propName, String delim) Gets a specific multi-valued Integer property by its name.
Integer	getIntegerProperty(String propName) Gets a specific Integer property by its name.
Long[]	getLongArrayProperty(String propName, String delim) Gets a specific multi-valued Long property by its name.
Long	getLongProperty(String propName) Gets a specific Long property by its name.
Map	getProperties() Gets the property values for this Query Result.
String	getProperty(String propName) Gets a specific property by its name.
Time[]	getTimeArrayProperty(String propName, String delim) Gets a specific multi-valued Time property by its name.
Time	getTimeProperty(String propName) Gets a specific Time property by its name.
Timestamp[]	getTimestampArrayProperty(String propName, String delim) Gets a specific multi-valued Timestamp property by its name.
Timestamp	getTimestampProperty(String propName) Gets a specific Timestamp property by its name.

Field Detail

PROP_DOC_WEIGHT

public static final String PROP_DOC_WEIGHT

The Document Weight (relevance ranking) property. Query results are returned ranked by their relevance.

PROP_DOC_QUICK_SUMMARY

public static final String PROP_DOC_QUICK_SUMMARY

The Document Quick Summary property. Quick summaries are only generated if Document Contents are stored in the Query Engine.

PROP_ENGINE_DOC_ID

public static final String PROP_ENGINE_DOC_ID

The Query Engine Document ID property (the ID generated by the Query Engine).

PROP_ENGINE_DOC_REF

public static final String PROP_ENGINE_DOC_REF

The Query Engine Document Reference property.

Method Detail

getProperties

public Map getProperties()

Gets the property values for this Query Result.

Returns:

a Map of property values where the keys are property names

getProperty

public String getProperty(String propName)

Gets a specific property by its name.

Parameters:

propName - the name of the property

Returns:

the property value as it is stored in the Query Engine

getArrayProperty

public String[] getArrayProperty(String propName,
                                 String delim)

Gets a specific multi-valued property by its name.

Parameters:

propName - the name of the property

delim - the delimiter to use to parse the value

Returns:

the property value as it is stored in the Query Engine, parsed out into Strings using the delimiter

getTimestampProperty

public Timestamp getTimestampProperty(String propName)

Gets a specific Timestamp property by its name.

Parameters:

propName - the name of the property

Returns:

the property value

getTimestampArrayProperty

public Timestamp[] getTimestampArrayProperty(String propName,
                                             String delim)

Gets a specific multi-valued Timestamp property by its name.

Parameters:

propName - the name of the property

delim - the delimiter to use to parse the value

Returns:

the property value

getDateProperty

public Date getDateProperty(String propName)

Gets a specific Date property by its name.

Parameters:

propName - the name of the property

Returns:

the property value

getDateArrayProperty

public Date[] getDateArrayProperty(String propName,
                                   String delim)

Gets a specific multi-valued Date property by its name.

Parameters:

propName - the name of the property

delim - the delimiter to use to parse the value

Returns:

the property value

getTimeProperty

public Time getTimeProperty(String propName)

Gets a specific Time property by its name.

Parameters:

propName - the name of the property

Returns:

the property value

getTimeArrayProperty

public Time[] getTimeArrayProperty(String propName,
                                   String delim)

Gets a specific multi-valued Time property by its name.

Parameters:

propName - the name of the property

delim - the delimiter to use to parse the value

Returns:

the property value

getIntegerProperty

public Integer getIntegerProperty(String propName)

Gets a specific Integer property by its name.

Parameters:

propName - the name of the property

Returns:

the property value

getIntegerArrayProperty

public Integer[] getIntegerArrayProperty(String propName,
                                         String delim)

Gets a specific multi-valued Integer property by its name.

Parameters:

propName - the name of the property

delim - the delimiter to use to parse the value

Returns:

the property value

getLongProperty

public Long getLongProperty(String propName)

Gets a specific Long property by its name.

Parameters:

propName - the name of the property

Returns:

the property value

getLongArrayProperty

public Long[] getLongArrayProperty(String propName,
                                   String delim)

Gets a specific multi-valued Long property by its name.

Parameters:

propName - the name of the property

delim - the delimiter to use to parse the value

Returns:

the property value

getDebugSummary

public String getDebugSummary()

Gets a debug summary for this object. Similar to 'toString' but provides nicer formatting.

Returns:

the debug summary for this object