com.softwareag.eda.estore.query.api

Class FullTextQuery

java.lang.Object

com.softwareag.eda.estore.query.api.FullTextQuery

public abstract class FullTextQuery
extends java.lang.Object

This abstract class defines the domain specific language for EVP full text queries. The DSL provides a simple mechanism to build up full text queries through chained Java method calls rather than using a string query syntax. This class defines the full text query itself. Methods are provided to build up and execute the query.

Constructor Summary

Constructors

Constructor and Description
FullTextQuery()

Method Summary

Modifier and Type	Method and Description
abstract FullTextQuery	addCollection(java.lang.String collection) By default the FTS api searches across all collections, types and properties in the store.
abstract FullTextQuery	addEventType(java.lang.String eventType) By default the FTS api searches across all collections, types and properties in the store.
abstract FullTextQuery	addProperty(java.lang.String property) By default the FTS api searches across all collections, types and properties in the store.
abstract FullTextQueryResponse	execute() Execute the specified query.
abstract byte[]	explain() Returns a buffer containing information about the current query.
abstract FullTextQuery	setCollections(java.lang.String... collections) By default the FTS api searches across all collections, types and properties in the store.
abstract FullTextQuery	setEventTypes(java.lang.String... eventTypes) By default the FTS api searches across all collections, types and properties in the store.
abstract FullTextQuery	setFilter(ExpressionBuilder filter) Add a filter to the full text query.
abstract FullTextQuery	setLimit(int limit) By default all results for the query are returned to the client.
abstract FullTextQuery	setProperties(java.lang.String... properties) By default the FTS api searches across all collections, types and properties in the store.
abstract FullTextQuery	setQueryString(java.lang.String queryString) Set the term to be matched in the full text search.

Methods inherited from class java.lang.Object

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

Constructor Detail

FullTextQuery

public FullTextQuery()

Method Detail

setCollections

public abstract FullTextQuery setCollections(java.lang.String... collections)

By default the FTS api searches across all collections, types and properties in the store. This method allows the client to specify the collections to be included in the query. In EVP a collection is simply a container for on or more typed events. The method takes multiple collection names and sets them for the query. This operation is not additive and the values will be replaced each time the method is invoked.

Parameters:

collections - The collections to be included in the query.

Returns:

The updated query instance.

addCollection

public abstract FullTextQuery addCollection(java.lang.String collection)

By default the FTS api searches across all collections, types and properties in the store. This method allows the client to specify the collections to be included in the query. In EVP a collection is simply a container for on or more typed events. The method takes a single collection name which will be added to a list of collection names to be included in the query.

Parameters:

collection - The collection to be added to the query.

Returns:

The updated query instance.

setEventTypes

public abstract FullTextQuery setEventTypes(java.lang.String... eventTypes)

By default the FTS api searches across all collections, types and properties in the store. This method allows the client to specify the event types to be included in the query. The event types must be specified in the fully qualified EDA format. The method takes multiple event types and sets them for the query. This operation is not additive and the values will be replaced each time the method is invoked.

Parameters:

eventTypes - The event types to be included in the query.

Returns:

The updated query instance.

addEventType

public abstract FullTextQuery addEventType(java.lang.String eventType)

By default the FTS api searches across all collections, types and properties in the store. The method takes a single event type which will be added to a list of types names to be included in the query. The event type must provided in the fully qualified EDA format.

Parameters:

eventType - The event type to be added to the query.

Returns:

The updated query instance.

setProperties

public abstract FullTextQuery setProperties(java.lang.String... properties)

By default the FTS api searches across all collections, types and properties in the store. This method allows the client to specify the event properties to be included in the query. The method takes multiple property names and sets them in the query. This operation is not additive and the values will be replaced each time the method is invoked. The properties can be fully qualified or wildcards can be specified. For example the property "*.DisplayName" will search all events that contain a "DisplayName" property.

Parameters:

properties - The properties to be included in the query.

Returns:

The updated query instance.

addProperty

public abstract FullTextQuery addProperty(java.lang.String property)

By default the FTS api searches across all collections, types and properties in the store. This method allows the client to specify the event properties to be included in the query. The method takes a single property that will be added to a list of properties to be included in the query. The properties can be fully qualified or wildcards can be specified. For example the property "*.DisplayName" will search all events that contain a "DisplayName" property.

Parameters:

property - The event property to be added to the query.

Returns:

The updated query instance.

setQueryString

public abstract FullTextQuery setQueryString(java.lang.String queryString)

Set the term to be matched in the full text search. Currently there is no abstraction for a common set of term operators so the value of term will be passed straight through to the store without interpretation. In the future a common set of term operators will be defined as part of the DSL.

Parameters:

queryString - A string containing a list of terms to be matched during the search

Returns:

an instance of the FullTextQuery. This allows the different methods to be chained together.

setFilter

public abstract FullTextQuery setFilter(ExpressionBuilder filter)

Add a filter to the full text query. A filter is similar to the WHERE clause provided in the simple query api. A filter supports both simple and complex expressions.

setLimit

public abstract FullTextQuery setLimit(int limit)

By default all results for the query are returned to the client. This method allows the client to set a limit on the number of results returned in the query response. Note that in future versions of the API the team will introduce a mechanism to return the results in batches.

Parameters:

limit - The number of results to be returned in the response.

execute

public abstract FullTextQueryResponse execute()
                                       throws QueryException

Execute the specified query. It is up to the implementation class to validate the various components of the query and to throw an exception if invalid. For example executing a full text query without having the term set.

Returns:

a FullTextQueryResponse object that contains the results of the query.

Throws:

QueryException - on error.

explain

public abstract byte[] explain()
                        throws QueryException

Returns a buffer containing information about the current query. This information consists of the current query string in the Common Query Syntax and the query after transformation to the underlying storage technology. This information can then be used to debug issues found in one or more queries.

Returns:

A buffer containing the query information.

Throws:

QueryException - if the information can't be provided.