com.softwareag.eda.estore.query.api

Class FullTextQueryHit

java.lang.Object

com.softwareag.eda.estore.query.api.FullTextQueryHit

public abstract class FullTextQueryHit
extends java.lang.Object

This abstract class defines the domain specific language for EVP full text query hit. A query hit contains a score indicating how closely the term matched the document and the document matched. The query hit is a very simple class that mainly contains methods to access the individual result. 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
FullTextQueryHit()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getCollection() This method returns the name of the collection in which the match was found.
abstract byte[]	getEvent() This method returns the matched event instance in JSON format.
abstract double	getScore() This method returns the accuracy (score) of the match.

Methods inherited from class java.lang.Object

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

Constructor Detail

FullTextQueryHit

public FullTextQueryHit()

Method Detail

getCollection

public abstract java.lang.String getCollection()

This method returns the name of the collection in which the match was found.

Returns:

The matching hits origin location.

getScore

public abstract double getScore()

This method returns the accuracy (score) of the match. There is currently no abstraction on a common representation of the score. For this reason the score is simply returned as a floating point value. This is the Elasticsearch default. In future revisions the score may be standardized across different implementations.

Returns:

a double value indicating the accuracy of the match.

getEvent

public abstract byte[] getEvent()

This method returns the matched event instance in JSON format. The standard format contains the application event instance properties and also the standard EDA event header properties.

Returns:

a byte array containing the contents of the event instance.