Package io.siddhi.core.table.record

Class AbstractQueryableRecordTable

java.lang.Object

io.siddhi.core.table.Table

io.siddhi.core.table.record.AbstractRecordTable

io.siddhi.core.table.record.AbstractQueryableRecordTable

All Implemented Interfaces:

FindableProcessor, QueryableProcessor, MemoryCalculable

public abstract class AbstractQueryableRecordTable
extends AbstractRecordTable
implements QueryableProcessor

An abstract implementation of table. Abstract implementation will handle ComplexEventChunk so that developer can directly work with event data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AbstractQueryableRecordTable.CompiledSelectionWithCache	class to hold both store compile selection and cache compile selection wrapped
class	AbstractQueryableRecordTable.OrderByAttributeBuilder	Holder of order by attribute with order orientation
class	AbstractQueryableRecordTable.SelectAttributeBuilder	Holder of Selection attribute with renaming field

Nested classes/interfaces inherited from class io.siddhi.core.table.Table

Table.OnErrorAction

Field Summary

Fields

Modifier and Type	Field	Description
protected StateEvent	containsMatchingEvent
protected StateEvent	findMatchingEvent
protected MatchingMetaInfoHolder	matchingMetaInfoHolderForTestOnDemandQuery
static ThreadLocal<Boolean>	queryStoreWithoutCheckingCache
protected io.siddhi.query.api.execution.query.selection.Selector	selectorForTestOnDemandQuery
protected SiddhiQueryContext	siddhiQueryContextForTestOnDemandQuery

Fields inherited from class io.siddhi.core.table.record.AbstractRecordTable

recordTableHandler, storeEventPool

Fields inherited from class io.siddhi.core.table.Table

siddhiAppContext, tableDefinition, tableMap

Constructor Summary

Constructors

Constructor	Description
AbstractQueryableRecordTable()

Method Summary

Modifier and Type	Method	Description
void	add(ComplexEventChunk<StreamEvent> addingEventChunk)
CompiledCondition	compileCondition(io.siddhi.query.api.expression.Expression condition, MatchingMetaInfoHolder matchingMetaInfoHolder, List<VariableExpressionExecutor> variableExpressionExecutors, Map<String,Table> tableMap, SiddhiQueryContext siddhiQueryContext)	To construct a finder having the capability of finding events at the processor that corresponds to the incoming matchingEvent and the given matching expression logic.
CompiledSelection	compileSelection(io.siddhi.query.api.execution.query.selection.Selector selector, List<io.siddhi.query.api.definition.Attribute> expectedOutputAttributes, MatchingMetaInfoHolder matchingMetaInfoHolder, List<VariableExpressionExecutor> variableExpressionExecutors, Map<String,Table> tableMap, SiddhiQueryContext siddhiQueryContext)	To construct a selection having the capability of transforming events based on given selection logic.
protected abstract CompiledSelection	compileSelection(List<AbstractQueryableRecordTable.SelectAttributeBuilder> selectAttributeBuilders, List<ExpressionBuilder> groupByExpressionBuilder, ExpressionBuilder havingExpressionBuilder, List<AbstractQueryableRecordTable.OrderByAttributeBuilder> orderByAttributeBuilders, Long limit, Long offset)	Compile the query selection
CompiledUpdateSet	compileUpdateSet(io.siddhi.query.api.execution.query.output.stream.UpdateSet updateSet, MatchingMetaInfoHolder matchingMetaInfoHolder, List<VariableExpressionExecutor> variableExpressionExecutors, Map<String,Table> tableMap, SiddhiQueryContext siddhiQueryContext)	Builds the "compiled" set clause of an update query.
protected void	connectAndLoadCache()
boolean	contains(StateEvent matchingEvent, CompiledCondition compiledCondition)
void	delete(ComplexEventChunk<StateEvent> deletingEventChunk, CompiledCondition compiledCondition)
StreamEvent	find(CompiledCondition compiledCondition, StateEvent matchingEvent)
void	handleCacheExpiry(CompiledCondition cacheExpiryCompiledCondition, ComplexEventChunk<StateEvent> deleteEventChunk)
void	initCache(io.siddhi.query.api.definition.TableDefinition tableDefinition, SiddhiAppContext siddhiAppContext, StreamEventCloner storeEventCloner, ConfigReader configReader)
StreamEvent	query(StateEvent matchingEvent, CompiledCondition compiledCondition, CompiledSelection compiledSelection)	To find events from the processor event pool, that the matches the matchingEvent based on finder logic and return them based on the defined selection.
StreamEvent	query(StateEvent matchingEvent, CompiledCondition compiledCondition, CompiledSelection compiledSelection, io.siddhi.query.api.definition.Attribute[] outputAttributes)	To find events from the processor event pool, that the matches the matchingEvent based on finder logic and return them based on the defined selection.
protected abstract RecordIterator<Object[]>	query(Map<String,Object> parameterMap, CompiledCondition compiledCondition, CompiledSelection compiledSelection, io.siddhi.query.api.definition.Attribute[] outputAttributes)	Query records matching the compiled condition and selection
void	update(ComplexEventChunk<StateEvent> updatingEventChunk, CompiledCondition compiledCondition, CompiledUpdateSet compiledUpdateSet)
void	updateOrAdd(ComplexEventChunk<StateEvent> updateOrAddingEventChunk, CompiledCondition compiledCondition, CompiledUpdateSet compiledUpdateSet, AddingStreamEventExtractor addingStreamEventExtractor)

Methods inherited from class io.siddhi.core.table.record.AbstractRecordTable

add, compileCondition, compileSetAttribute, connect, contains, delete, find, getTableDefinition, init, init, isStateful, update, updateOrAdd

Methods inherited from class io.siddhi.core.table.Table

addEvents, connectWithRetry, containsEvent, deleteEvents, destroy, disconnect, find, getHandler, getIsConnected, getIsTryingToConnect, initTable, onAddError, onDeleteError, onUpdateError, onUpdateOrAddError, setIsConnectedToFalse, shutdown, updateEvents, updateOrAddEvents, waitWhileConnect

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.siddhi.core.query.processor.stream.window.FindableProcessor

find

Field Detail

queryStoreWithoutCheckingCache

public static ThreadLocal<Boolean> queryStoreWithoutCheckingCache

findMatchingEvent

protected StateEvent findMatchingEvent

selectorForTestOnDemandQuery

protected io.siddhi.query.api.execution.query.selection.Selector selectorForTestOnDemandQuery

siddhiQueryContextForTestOnDemandQuery

protected SiddhiQueryContext siddhiQueryContextForTestOnDemandQuery

matchingMetaInfoHolderForTestOnDemandQuery

protected MatchingMetaInfoHolder matchingMetaInfoHolderForTestOnDemandQuery

containsMatchingEvent

protected StateEvent containsMatchingEvent

Constructor Detail

AbstractQueryableRecordTable

public AbstractQueryableRecordTable()

Method Detail

initCache

public void initCache(io.siddhi.query.api.definition.TableDefinition tableDefinition,
                      SiddhiAppContext siddhiAppContext,
                      StreamEventCloner storeEventCloner,
                      ConfigReader configReader)

Overrides:

initCache in class AbstractRecordTable

connectAndLoadCache

protected void connectAndLoadCache()
                            throws ConnectionUnavailableException

Overrides:

connectAndLoadCache in class AbstractRecordTable

Throws:

ConnectionUnavailableException

query

public StreamEvent query(StateEvent matchingEvent,
                         CompiledCondition compiledCondition,
                         CompiledSelection compiledSelection)
                  throws ConnectionUnavailableException

Description copied from interface: QueryableProcessor

To find events from the processor event pool, that the matches the matchingEvent based on finder logic and return them based on the defined selection.

Specified by:

query in interface QueryableProcessor

Parameters:

matchingEvent - the event to be matched with the events at the processor

compiledCondition - the execution element responsible for matching the corresponding events that matches the matchingEvent based on pool of events at Processor

compiledSelection - the execution element responsible for transforming the corresponding events to the given selection

Returns:

the matched events

Throws:

ConnectionUnavailableException

add

public void add(ComplexEventChunk<StreamEvent> addingEventChunk)

Overrides:

add in class AbstractRecordTable

delete

public void delete(ComplexEventChunk<StateEvent> deletingEventChunk,
                   CompiledCondition compiledCondition)

Overrides:

delete in class AbstractRecordTable

update

public void update(ComplexEventChunk<StateEvent> updatingEventChunk,
                   CompiledCondition compiledCondition,
                   CompiledUpdateSet compiledUpdateSet)

Overrides:

update in class AbstractRecordTable

contains

public boolean contains(StateEvent matchingEvent,
                        CompiledCondition compiledCondition)
                 throws ConnectionUnavailableException

Overrides:

contains in class AbstractRecordTable

Throws:

ConnectionUnavailableException

updateOrAdd

public void updateOrAdd(ComplexEventChunk<StateEvent> updateOrAddingEventChunk,
                        CompiledCondition compiledCondition,
                        CompiledUpdateSet compiledUpdateSet,
                        AddingStreamEventExtractor addingStreamEventExtractor)

Overrides:

updateOrAdd in class AbstractRecordTable

find

public StreamEvent find(CompiledCondition compiledCondition,
                        StateEvent matchingEvent)
                 throws ConnectionUnavailableException

Overrides:

find in class AbstractRecordTable

Throws:

ConnectionUnavailableException

compileUpdateSet

public CompiledUpdateSet compileUpdateSet(io.siddhi.query.api.execution.query.output.stream.UpdateSet updateSet,
                                          MatchingMetaInfoHolder matchingMetaInfoHolder,
                                          List<VariableExpressionExecutor> variableExpressionExecutors,
                                          Map<String,Table> tableMap,
                                          SiddhiQueryContext siddhiQueryContext)

Description copied from class: Table

Builds the "compiled" set clause of an update query. Here, all the pre-processing that can be done prior to receiving the update event is done, so that such pre-processing work will not be done at each update-event-arrival.

Overrides:

compileUpdateSet in class AbstractRecordTable

Parameters:

updateSet - the set of assignment expressions, each containing the table column to be updated and the expression to be assigned.

matchingMetaInfoHolder - the meta structure of the incoming matchingEvent

variableExpressionExecutors - the list of variable ExpressionExecutors already created

tableMap - map of event tables

siddhiQueryContext - current siddhi query context

Returns:

CompiledUpdateSet

compileCondition

public CompiledCondition compileCondition(io.siddhi.query.api.expression.Expression condition,
                                          MatchingMetaInfoHolder matchingMetaInfoHolder,
                                          List<VariableExpressionExecutor> variableExpressionExecutors,
                                          Map<String,Table> tableMap,
                                          SiddhiQueryContext siddhiQueryContext)

Description copied from interface: FindableProcessor

To construct a finder having the capability of finding events at the processor that corresponds to the incoming matchingEvent and the given matching expression logic.

Specified by:

compileCondition in interface FindableProcessor

Overrides:

compileCondition in class AbstractRecordTable

Parameters:

condition - the matching condition

matchingMetaInfoHolder - the meta structure of the incoming matchingEvent

variableExpressionExecutors - the list of variable ExpressionExecutors already created

tableMap - map of event tables

siddhiQueryContext - current siddhi query context

Returns:

compiled Condition having the capability of matching events against the incoming matchingEvent

query

public StreamEvent query(StateEvent matchingEvent,
                         CompiledCondition compiledCondition,
                         CompiledSelection compiledSelection,
                         io.siddhi.query.api.definition.Attribute[] outputAttributes)
                  throws ConnectionUnavailableException

Description copied from interface: QueryableProcessor

To find events from the processor event pool, that the matches the matchingEvent based on finder logic and return them based on the defined selection.

Specified by:

query in interface QueryableProcessor

Parameters:

matchingEvent - the event to be matched with the events at the processor

compiledCondition - the execution element responsible for matching the corresponding events that matches the matchingEvent based on pool of events at Processor

compiledSelection - the execution element responsible for transforming the corresponding events to the given selection

outputAttributes - the output attributes specified in the query.

Returns:

the matched events

Throws:

ConnectionUnavailableException

query

protected abstract RecordIterator<Object[]> query(Map<String,Object> parameterMap,
                                                  CompiledCondition compiledCondition,
                                                  CompiledSelection compiledSelection,
                                                  io.siddhi.query.api.definition.Attribute[] outputAttributes)
                                           throws ConnectionUnavailableException

Query records matching the compiled condition and selection

Parameters:

parameterMap - map of matching StreamVariable Ids and their values corresponding to the compiled condition and selection

compiledCondition - the compiledCondition against which records should be matched

compiledSelection - the compiledSelection that maps records based to requested format

Returns:

RecordIterator of matching records

Throws:

ConnectionUnavailableException

compileSelection

public CompiledSelection compileSelection(io.siddhi.query.api.execution.query.selection.Selector selector,
                                          List<io.siddhi.query.api.definition.Attribute> expectedOutputAttributes,
                                          MatchingMetaInfoHolder matchingMetaInfoHolder,
                                          List<VariableExpressionExecutor> variableExpressionExecutors,
                                          Map<String,Table> tableMap,
                                          SiddhiQueryContext siddhiQueryContext)

Description copied from interface: QueryableProcessor

To construct a selection having the capability of transforming events based on given selection logic.

Specified by:

compileSelection in interface QueryableProcessor

Parameters:

selector - the query selector

matchingMetaInfoHolder - the meta structure of the incoming matchingEvent

variableExpressionExecutors - the list of variable ExpressionExecutors already created

tableMap - map of event tables

siddhiQueryContext - current siddhi query context

Returns:

compiled Selection having the capability of transforming events based on the selection

compileSelection

protected abstract CompiledSelection compileSelection(List<AbstractQueryableRecordTable.SelectAttributeBuilder> selectAttributeBuilders,
                                                      List<ExpressionBuilder> groupByExpressionBuilder,
                                                      ExpressionBuilder havingExpressionBuilder,
                                                      List<AbstractQueryableRecordTable.OrderByAttributeBuilder> orderByAttributeBuilders,
                                                      Long limit,
                                                      Long offset)

Compile the query selection

Parameters:

selectAttributeBuilders - helps visiting the select attributes in order

groupByExpressionBuilder - helps visiting the group by attributes in order

havingExpressionBuilder - helps visiting the having condition

orderByAttributeBuilders - helps visiting the order by attributes in order

limit - defines the limit level

offset - defines the offset level

Returns:

compiled selection that can be used for retrieving events on a defined format

handleCacheExpiry

public void handleCacheExpiry(CompiledCondition cacheExpiryCompiledCondition,
                              ComplexEventChunk<StateEvent> deleteEventChunk)