Package org.sensorhub.api.datastore.command

Interface ICommandStore

All Superinterfaces:

IDataStore<BigId,ICommandData,ICommandStore.CommandField,CommandFilter>, Map<BigId,ICommandData>

All Known Implementing Classes:

EmptyCommandStore

public interface ICommandStore
extends IDataStore<BigId,ICommandData,ICommandStore.CommandField,CommandFilter>

Generic interface for data stores containing commands.

Commands are organized into command streams. Each command stream contains commands sharing the same schema (i.e. record structure).

Commands retrieved by select methods are sorted by issue time.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ICommandStore.CommandField

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Method Summary

Modifier and Type	Method	Description
BigId	add(ICommandData cmd)	Add a command to the datastore
default CommandFilter.Builder	filterBuilder()
ICommandStreamStore	getCommandStreams()
Stream<CommandStats>	getStatistics(CommandStatsQuery query)	Select statistics for commands matching the query
ICommandStatusStore	getStatusReports()
void	linkTo(IFoiStore foiStore)	Link this store to a feature of interest store to enable JOIN queries
default CommandFilter	selectAllFilter()

Methods inherited from interface org.sensorhub.api.datastore.IDataStore

backup, commit, containsKey, containsValue, countMatchingEntries, entrySet, getDatastoreName, getNumRecords, isEmpty, isReadOnly, keySet, putAll, removeEntries, restore, select, select, select, selectEntries, selectEntries, selectEntries, selectKeys, size, values

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, equals, forEach, get, getOrDefault, hashCode, merge, put, putIfAbsent, remove, remove, replace, replace, replaceAll

Method Details

getCommandStreams

ICommandStreamStore getCommandStreams()

Returns:

Associated command streams store

getStatusReports

ICommandStatusStore getStatusReports()

Returns:

Associated command status store

add

BigId add(ICommandData cmd)

Add a command to the datastore

Parameters:

cmd -

Returns:

The auto-generated ID

getStatistics

Stream<CommandStats> getStatistics(CommandStatsQuery query)

Select statistics for commands matching the query

Parameters:

query - filter to select desired systems and time range

Returns:

stream of statistics buckets. Each item represents statistics for commands recorded for a given system

filterBuilder

default CommandFilter.Builder filterBuilder()

Returns:

A builder for a filter compatible with this datastore

selectAllFilter

default CommandFilter selectAllFilter()

Specified by:

selectAllFilter in interface IDataStore<BigId,ICommandData,ICommandStore.CommandField,CommandFilter>

Returns:

The filter to use to select all records

linkTo

void linkTo(IFoiStore foiStore)

Link this store to a feature of interest store to enable JOIN queries

Parameters:

foiStore -