com.softwareag.eda.estore.query.api

Class FullTextQueryResponse

java.lang.Object

com.softwareag.eda.estore.query.api.FullTextQueryResponse

public abstract class FullTextQueryResponse
extends java.lang.Object

This abstract class defines the domain specific language for EVP full text query responses. The query response is a very simple class that mainly contains methods to access the individual query results. As such there are no DSL based setter methods though the class itself makes up part of the defined DSL.

Constructor Summary

Constructors

Constructor and Description
FullTextQueryResponse()

Method Summary

Modifier and Type	Method and Description
abstract FullTextQueryHit[]	getQueryHits() This method returns an array of query hits.
abstract long	getTotalQueryHits() This method returns the total number of document hits matched during the query.
abstract boolean	hasMoreQueryHits() Query hit results are batched back to the client.

Methods inherited from class java.lang.Object

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

Constructor Detail

FullTextQueryResponse

public FullTextQueryResponse()

Method Detail

getTotalQueryHits

public abstract long getTotalQueryHits()

This method returns the total number of document hits matched during the query.

Returns:

the total hits that the query matched.

hasMoreQueryHits

public abstract boolean hasMoreQueryHits()

Query hit results are batched back to the client. This method returns true if there are more Query Hits available to the client. When the method returns true you can invoke the getQueryHits method to retrieve the next set of Query hits. If this method returns false no more hits are available and the client should conclude it's processing.

Returns:

the total hits that the query matched.

getQueryHits

public abstract FullTextQueryHit[] getQueryHits()
                                         throws QueryException

This method returns an array of query hits. The hits are returned to the client in batches. This method can be called repeatedly after a query until the hit array is empty. You can use the hasMoreQueryHits to identify if the query has more hits available. When returned each hit contains the ranking (score) and document that was matched. As this implementation is enhanced additional information will be added to the query hit class.

Returns:

An array of FullTextQueryHit references containing detailed information about the match.

Throws:

QueryException - if an error occurs while processing the query hits.