|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTSResult
A single search result, returned as part of an IPTSQueryResponse
.
Method Summary | |
---|---|
boolean |
getFieldAsBoolean(IPTSField field)
Returns the value of a boolean IPTSField . |
double |
getFieldAsDouble(IPTSField field)
Returns the value of a floating-point IPTSField . |
int |
getFieldAsInt(IPTSField field)
Returns the value of an integer IPTSField . |
java.lang.Object |
getFieldAsObject(IPTSField field)
Returns the value of a IPTSField ,
regardless of type. |
java.lang.String |
getFieldAsString(IPTSField field)
Returns the value of a String IPTSField . |
com.plumtree.openfoundation.util.XPDateTime |
getFieldAsXPDateTime(IPTSField field)
Returns the value of a floating-point IPTSField . |
java.lang.String[] |
getFieldExcerpts(IPTSField field,
java.lang.String startingDelimiter,
java.lang.String endingDelimiter)
Returns a set of excerpts of the indicated IPTSField that matched the user's query. |
boolean |
getFieldExists(IPTSField field)
Returns whether or not the field exists in this result. |
int |
getRank()
Returns the rank of this result within its result set. |
Method Detail |
---|
int getRank()
getFieldAsInt
on the RANK
field (see IPTSSearchableCollection.Rank
).
boolean getFieldExists(IPTSField field)
java.lang.String getFieldAsString(IPTSField field) throws PTSNoFieldValueException
IPTSField
.
Throws a PTSNoFieldValueException
if the field is not defined for this result.
PTSNoFieldValueException
- if the field is not defined for this result.int getFieldAsInt(IPTSField field) throws PTSNoFieldValueException
IPTSField
.
Note that the Search Server stores all numeric types
as 32-bit float
values. Values will
suffer roundoff error.
Throws a PTSNoFieldValueException
if the field is not defined for this result.
PTSNoFieldValueException
- if the field is not defined for this result.double getFieldAsDouble(IPTSField field) throws PTSNoFieldValueException
IPTSField
.
Note that the Search Server stores all numeric types
as 32-bit float
values. Values will
suffer roundoff error.
Throws a PTSNoFieldValueException
if the field is not defined for this result.
PTSNoFieldValueException
- if the field is not defined for this result.com.plumtree.openfoundation.util.XPDateTime getFieldAsXPDateTime(IPTSField field) throws PTSNoFieldValueException
IPTSField
.
Note that the Search Server stores dates
as 32-bit float
values. Values will
suffer roundoff error.
Throws a PTSNoFieldValueException
if the field is not defined for this result.
PTSNoFieldValueException
- if the field is not defined for this result.boolean getFieldAsBoolean(IPTSField field) throws PTSNoFieldValueException
IPTSField
.
Throws a PTSNoFieldValueException
if the field is not defined for this result.
PTSNoFieldValueException
- if the field is not defined for this result.java.lang.Object getFieldAsObject(IPTSField field) throws PTSNoFieldValueException
IPTSField
,
regardless of type. The actual underlying type of
the returned Object will be String, Integer, Double,
Boolean, or XPDateTime.
Throws a PTSNoFieldValueException
if the field is not defined for this result.
PTSNoFieldValueException
- if the field is not defined for this result.java.lang.String[] getFieldExcerpts(IPTSField field, java.lang.String startingDelimiter, java.lang.String endingDelimiter)
IPTSField
that matched the user's query.
For example, if the user searched for dog
, one of the
returned Strings might be "went to the <b>dog</b> park with Rover".
Returns null
if no excerpts were found.
field
- the field to excerpt. Must be a string field (and non-null
).startingDelimiter
- text to insert before the token(s) that matched the query. Usually
some sort of opening HTML tag, like <b>
.endingDelimiter
- text to insert after the token(s) that matched the query. Usually
some sort of closing HTML tag, like </b>
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |