Index (evp-query-api 9.12.0-v0063 API)

A B C D E F G H L M N O P Q R S U V

A

addAggregate(Aggregate) - Method in class com.softwareag.eda.estore.query.api.builder.QueryBuilder: Adds an Aggregate function to this queries select expression.
addCollection(String) - Method in class com.softwareag.eda.estore.query.api.FullTextQuery: By default the FTS api searches across all collections, types and properties in the store.
addEventType(String) - Method in class com.softwareag.eda.estore.query.api.FullTextQuery: By default the FTS api searches across all collections, types and properties in the store.
addProperty(String) - Method in class com.softwareag.eda.estore.query.api.builder.GroupBy: Add an Event property to the list of desired group by fields.
addProperty(String) - Method in class com.softwareag.eda.estore.query.api.builder.OrderBy: Add the specified Event property to the order by list using the default sort (ASC).
addProperty(String, Sort) - Method in class com.softwareag.eda.estore.query.api.builder.OrderBy: Add the specified Event property to the order by list using specified sort.
addProperty(String) - Method in class com.softwareag.eda.estore.query.api.FullTextQuery: By default the FTS api searches across all collections, types and properties in the store.
addSelectProperty(String) - Method in class com.softwareag.eda.estore.query.api.builder.QueryBuilder: Adds an Event Types property value to this queries select expression.
Aggregate - Class in com.softwareag.eda.estore.query.api.builder: The Aggregate class provides static factory methods for creating count, sum, min, max and avg operations.
and() - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Adds an AND operator to the current query expression.
and(ExpressionBuilder) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Adds an AND operator to the current query expression.
avg(String, String) - Static method in class com.softwareag.eda.estore.query.api.builder.Aggregate: Create an average aggregate on the specified field and store the result in variable

B

between(String, String, String, boolean) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Add a between expression for the given Event property and string range.
between(String, Integer, Integer, boolean) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Add a between expression for the given Event property and integer range.
between(String, Long, Long, boolean) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Add a between expression for the given Event property and long integer range.
between(String, Float, Float, boolean) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Add a between expression for the given Event property and floating point range.
between(String, Double, Double, boolean) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Add a between expression for the given Event property and double precision floating point range.
between(String, Timestamp, Timestamp, boolean) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Add a between expression for the given Event property and timestamp range.
between(ExpressionBuilder) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Create a between expression using the specified sub-expression.
build() - Method in class com.softwareag.eda.estore.query.api.builder.QueryBuilder: The "build" method is used to evaluate the builders state and return a string representation of the query suitable for use when creating Query instances through the QuerySession.

C

close() - Method in interface com.softwareag.eda.estore.query.api.Query: Close the session and free any and all associated resources
close() - Method in interface com.softwareag.eda.estore.query.api.QuerySession: Close the session and free any and all associated resources
close() - Method in interface com.softwareag.eda.estore.query.api.ResultStream: Close the session and free any and all associated resources
com.softwareag.eda.estore.query.api - package com.softwareag.eda.estore.query.api
com.softwareag.eda.estore.query.api.builder - package com.softwareag.eda.estore.query.api.builder
count(String, String) - Static method in class com.softwareag.eda.estore.query.api.builder.Aggregate: Create a count aggregate on the specified field and store the result in variable
createFullTextQuery() - Method in interface com.softwareag.eda.estore.query.api.QuerySession: Create and return a full text query object.
createQuery(String) - Method in interface com.softwareag.eda.estore.query.api.QuerySession: Create and return a Query object based on the specified query string.
createSession(URI, QuerySessionContext) - Method in interface com.softwareag.eda.estore.query.api.QuerySessionFactory: Create a query session to the Event Store instance specified by URL.
createSession(URI, QuerySessionContext) - Method in class com.softwareag.eda.estore.query.api.QuerySessionFactoryProvider
createSession(URI, QuerySessionContext) - Method in class com.softwareag.eda.estore.query.api.QuerySessionManager

D

deregisterSessionFactory(String) - Method in class com.softwareag.eda.estore.query.api.QuerySessionFactoryProvider
deregisterSessionFactory(String) - Method in interface com.softwareag.eda.estore.query.api.QuerySessionFactoryRegistry: This message deregisters the session factory implementation for the given scheme

E

execute() - Method in class com.softwareag.eda.estore.query.api.FullTextQuery: Execute the specified query.
execute() - Method in interface com.softwareag.eda.estore.query.api.Query: Executes the query and returns the result stream to the caller.
explain() - Method in class com.softwareag.eda.estore.query.api.FullTextQuery: Returns a buffer containing information about the current query.
explain() - Method in interface com.softwareag.eda.estore.query.api.Query: Returns a buffer containing information about the current query.
ExpressionBuilder - Class in com.softwareag.eda.estore.query.api.builder
ExpressionBuilder() - Constructor for class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder

F

first() - Method in interface com.softwareag.eda.estore.query.api.ResultStream: Position the cursor at the first element in the result stream
FullTextQuery - Class in com.softwareag.eda.estore.query.api: This abstract class defines the domain specific language for EVP full text queries.
FullTextQuery() - Constructor for class com.softwareag.eda.estore.query.api.FullTextQuery
FullTextQueryHit - Class in com.softwareag.eda.estore.query.api: This abstract class defines the domain specific language for EVP full text query hit.
FullTextQueryHit() - Constructor for class com.softwareag.eda.estore.query.api.FullTextQueryHit
FullTextQueryResponse - Class in com.softwareag.eda.estore.query.api: This abstract class defines the domain specific language for EVP full text query responses.
FullTextQueryResponse() - Constructor for class com.softwareag.eda.estore.query.api.FullTextQueryResponse

G

getCollection() - Method in class com.softwareag.eda.estore.query.api.FullTextQueryHit: This method returns the name of the collection in which the match was found.
getEvent() - Method in class com.softwareag.eda.estore.query.api.FullTextQueryHit: This method returns the matched event instance in JSON format.
getEventStorePassword() - Method in class com.softwareag.eda.estore.query.api.QuerySessionContext
getEventStoreUser() - Method in class com.softwareag.eda.estore.query.api.QuerySessionContext
getEventTypeStoreLocation() - Method in class com.softwareag.eda.estore.query.api.QuerySessionContext
getExpression() - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder
getOperation() - Method in class com.softwareag.eda.estore.query.api.builder.Aggregate
getOption(String) - Method in class com.softwareag.eda.estore.query.api.QuerySessionContext: Return the value of the option speciifed by name.
getOptionKeys() - Method in class com.softwareag.eda.estore.query.api.QuerySessionContext: Return a list of all the specified option names.
getProperty() - Method in class com.softwareag.eda.estore.query.api.builder.Aggregate
getQueryHits() - Method in class com.softwareag.eda.estore.query.api.FullTextQueryResponse: This method returns an array of query hits.
getResult() - Method in interface com.softwareag.eda.estore.query.api.ResultStream: Return the result at the current position in the stream.
getScore() - Method in class com.softwareag.eda.estore.query.api.FullTextQueryHit: This method returns the accuracy (score) of the match.
getSessionContext() - Method in interface com.softwareag.eda.estore.query.api.QuerySession: Return the context used in the creation of this session.
getSymbol() - Method in enum com.softwareag.eda.estore.query.api.builder.Op
getTotalQueryHits() - Method in class com.softwareag.eda.estore.query.api.FullTextQueryResponse: This method returns the total number of document hits matched during the query.
getVariable() - Method in class com.softwareag.eda.estore.query.api.builder.Aggregate
GroupBy - Class in com.softwareag.eda.estore.query.api.builder: This simple class represents a group by expression.
GroupBy() - Constructor for class com.softwareag.eda.estore.query.api.builder.GroupBy

H

hasMoreQueryHits() - Method in class com.softwareag.eda.estore.query.api.FullTextQueryResponse: Query hit results are batched back to the client.

L

last() - Method in interface com.softwareag.eda.estore.query.api.ResultStream: Position the cursor at the last element in the result stream

M

max(String, String) - Static method in class com.softwareag.eda.estore.query.api.builder.Aggregate: Create a max aggregate on the specified field and store the result in variable
min(String, String) - Static method in class com.softwareag.eda.estore.query.api.builder.Aggregate: Create a min aggregate on the specified field and store the result in variable

N

next() - Method in interface com.softwareag.eda.estore.query.api.ResultStream: Position the cursor at the next element in the result stream.

O

Op - Enum in com.softwareag.eda.estore.query.api.builder: This simple enumeration class defines the various comparisons used in the ExpressionBuilder methods.
or() - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Adds an OR operator to the current query expression.
or(ExpressionBuilder) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Adds an OR operator to the current query expression.
OrderBy - Class in com.softwareag.eda.estore.query.api.builder: Like the GroupBy class the OrderBy class is used to specify the Event property names to include in the sorting of query results.
OrderBy() - Constructor for class com.softwareag.eda.estore.query.api.builder.OrderBy

P

previous() - Method in interface com.softwareag.eda.estore.query.api.ResultStream: Position the cursor at the previous element in the result stream

Q

Query - Interface in com.softwareag.eda.estore.query.api
QueryBuilder - Class in com.softwareag.eda.estore.query.api.builder: The QueryBuilder provides a simple DSL for creating queries for use with the Common Query API.
QueryBuilder() - Constructor for class com.softwareag.eda.estore.query.api.builder.QueryBuilder
QueryBuilderException - Exception in com.softwareag.eda.estore.query.api.builder: This exception is thrown when there is an error when the QueryBuilders build method is invoked.
QueryBuilderException() - Constructor for exception com.softwareag.eda.estore.query.api.builder.QueryBuilderException
QueryBuilderException(String) - Constructor for exception com.softwareag.eda.estore.query.api.builder.QueryBuilderException
QueryBuilderException(String, Throwable) - Constructor for exception com.softwareag.eda.estore.query.api.builder.QueryBuilderException
QueryException - Exception in com.softwareag.eda.estore.query.api
QueryException() - Constructor for exception com.softwareag.eda.estore.query.api.QueryException
QueryException(String) - Constructor for exception com.softwareag.eda.estore.query.api.QueryException
QueryException(String, Throwable) - Constructor for exception com.softwareag.eda.estore.query.api.QueryException
QueryException(Throwable) - Constructor for exception com.softwareag.eda.estore.query.api.QueryException
QuerySession - Interface in com.softwareag.eda.estore.query.api: This interface represents an Event Store session and defines the supported query operations.
QuerySessionContext - Class in com.softwareag.eda.estore.query.api: This class provides a mechanism to specify and pass properties into the QuerySessionManager and QuerySessionFactory implementations.
QuerySessionContext() - Constructor for class com.softwareag.eda.estore.query.api.QuerySessionContext: Construct a new session context for the Event Store session.
QuerySessionException - Exception in com.softwareag.eda.estore.query.api
QuerySessionException() - Constructor for exception com.softwareag.eda.estore.query.api.QuerySessionException
QuerySessionException(String) - Constructor for exception com.softwareag.eda.estore.query.api.QuerySessionException
QuerySessionException(String, Throwable) - Constructor for exception com.softwareag.eda.estore.query.api.QuerySessionException
QuerySessionException(Throwable) - Constructor for exception com.softwareag.eda.estore.query.api.QuerySessionException
QuerySessionFactory - Interface in com.softwareag.eda.estore.query.api: This interface defines the operations that must be provided by all factory implementations.
QuerySessionFactoryProvider - Class in com.softwareag.eda.estore.query.api
QuerySessionFactoryProvider() - Constructor for class com.softwareag.eda.estore.query.api.QuerySessionFactoryProvider
QuerySessionFactoryRegistry - Interface in com.softwareag.eda.estore.query.api
QuerySessionManager - Class in com.softwareag.eda.estore.query.api: This class allows access to the Event Store instances.
QuerySessionManager() - Constructor for class com.softwareag.eda.estore.query.api.QuerySessionManager

R

registerSessionFactory(String, QuerySessionFactory) - Method in class com.softwareag.eda.estore.query.api.QuerySessionFactoryProvider
registerSessionFactory(String, QuerySessionFactory) - Method in interface com.softwareag.eda.estore.query.api.QuerySessionFactoryRegistry: This method is provided to allow factory implementation modules to register with the service implementation.
ResultStream - Interface in com.softwareag.eda.estore.query.api: A table of data representing an Event Store Query result stream, which is usually generated by executing a query against and Event Store.
ResultStreamException - Exception in com.softwareag.eda.estore.query.api
ResultStreamException() - Constructor for exception com.softwareag.eda.estore.query.api.ResultStreamException
ResultStreamException(String) - Constructor for exception com.softwareag.eda.estore.query.api.ResultStreamException
ResultStreamException(String, Throwable) - Constructor for exception com.softwareag.eda.estore.query.api.ResultStreamException
ResultStreamException(Throwable) - Constructor for exception com.softwareag.eda.estore.query.api.ResultStreamException

S

setCollections(String...) - Method in class com.softwareag.eda.estore.query.api.FullTextQuery: By default the FTS api searches across all collections, types and properties in the store.
setEventNamespace(String) - Method in class com.softwareag.eda.estore.query.api.builder.QueryBuilder: Sets the namespace containing the EventType for use in this queries "in" clause.
setEventStorePassword(String) - Method in class com.softwareag.eda.estore.query.api.QuerySessionContext: Set the password associated with the user.
setEventStoreUser(String) - Method in class com.softwareag.eda.estore.query.api.QuerySessionContext: Set the user under which all operations are performed.
setEventType(String) - Method in class com.softwareag.eda.estore.query.api.builder.QueryBuilder: Sets the name of the Event Type in this queries "from" clause.
setEventTypes(String...) - Method in class com.softwareag.eda.estore.query.api.FullTextQuery: By default the FTS api searches across all collections, types and properties in the store.
setEventTypeStoreLocation(String) - Method in class com.softwareag.eda.estore.query.api.QuerySessionContext: Set the location of the EDA Event Type Store.
setFilter(ExpressionBuilder) - Method in class com.softwareag.eda.estore.query.api.FullTextQuery: Add a filter to the full text query.
setGroupBy(GroupBy) - Method in class com.softwareag.eda.estore.query.api.builder.QueryBuilder: Sets the group by clause for this query.
setLimit(int) - Method in class com.softwareag.eda.estore.query.api.FullTextQuery: By default all results for the query are returned to the client.
setOption(String, String) - Method in class com.softwareag.eda.estore.query.api.QuerySessionContext: Set the value for the session option specified by name.
setOrderBy(OrderBy) - Method in class com.softwareag.eda.estore.query.api.builder.QueryBuilder: Sets the order by clause for this query.
setProperties(String...) - Method in class com.softwareag.eda.estore.query.api.FullTextQuery: By default the FTS api searches across all collections, types and properties in the store.
setQueryString(String) - Method in class com.softwareag.eda.estore.query.api.FullTextQuery: Set the term to be matched in the full text search.
setWhereClause(ExpressionBuilder) - Method in class com.softwareag.eda.estore.query.api.builder.QueryBuilder: Sets the where clause to be used in this query.
simple(String, Op, String) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Add a simple expression to the current expression.
simple(String, Op, Integer) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Add a simple expression to the current expression.
simple(String, Op, Long) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Add a simple expression to the current expression.
simple(String, Op, Float) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Add a simple expression to the current expression.
simple(String, Op, Double) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Add a simple expression to the current expression.
simple(String, Op, Timestamp) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Add a simple expression to the current expression.
simple(ExpressionBuilder) - Method in class com.softwareag.eda.estore.query.api.builder.ExpressionBuilder: Add a simple expression using the specified sub-expression.
Sort - Enum in com.softwareag.eda.estore.query.api.builder: Simple enumeration class that defines the available sort operations for the OrderBy class
sum(String, String) - Static method in class com.softwareag.eda.estore.query.api.builder.Aggregate: Create a sum aggregate on the specified field and store the result in variable

U

UnsupportedFeatureException - Exception in com.softwareag.eda.estore.query.api
UnsupportedFeatureException() - Constructor for exception com.softwareag.eda.estore.query.api.UnsupportedFeatureException
UnsupportedFeatureException(String) - Constructor for exception com.softwareag.eda.estore.query.api.UnsupportedFeatureException
UnsupportedFeatureException(String, Throwable) - Constructor for exception com.softwareag.eda.estore.query.api.UnsupportedFeatureException
UnsupportedFeatureException(Throwable) - Constructor for exception com.softwareag.eda.estore.query.api.UnsupportedFeatureException

V

validate() - Method in class com.softwareag.eda.estore.query.api.QuerySessionContext: Some storage technologies don't require a user name or password.
valueOf(String) - Static method in enum com.softwareag.eda.estore.query.api.builder.Op: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.softwareag.eda.estore.query.api.builder.Sort: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.softwareag.eda.estore.query.api.builder.Op: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.softwareag.eda.estore.query.api.builder.Sort: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H L M N O P Q R S U V