Package org.sensorhub.api.datastore.command

Interface ICommandStreamStore

All Superinterfaces:

IDataStore<CommandStreamKey,ICommandStreamInfo,ICommandStreamStore.CommandStreamInfoField,CommandStreamFilter>, IResourceStore<CommandStreamKey,ICommandStreamInfo,ICommandStreamStore.CommandStreamInfoField,CommandStreamFilter>, Map<CommandStreamKey,ICommandStreamInfo>

All Known Implementing Classes:

EmptyCommandStreamStore

public interface ICommandStreamStore
extends IResourceStore<CommandStreamKey,ICommandStreamInfo,ICommandStreamStore.CommandStreamInfoField,CommandStreamFilter>

Generic interface for managing command streams within a command store.
Removal operations also remove all commands associated to a command stream.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ICommandStreamStore.CommandStreamInfoField

Nested classes/interfaces inherited from interface org.sensorhub.api.datastore.resource.IResourceStore

IResourceStore.ResourceField

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

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

Method Summary

Modifier and Type	Method	Description
CommandStreamKey	add(ICommandStreamInfo csInfo)	Add a new command stream and generate a new unique key for it. If the command stream valid time is not set, it will be set to the valid time of the parent system.
default CommandStreamFilter.Builder	filterBuilder()
default ICommandStreamInfo	getLatestVersion(String sysUID, String commandName)	Helper method to retrieve the latest version of the command stream corresponding to the specified system and command input.
default Map.Entry<CommandStreamKey,ICommandStreamInfo>	getLatestVersionEntry(String sysUID, String controlInput)	Helper method to retrieve the entry for the latest version of the command stream corresponding to the specified system and command input.
default CommandStreamKey	getLatestVersionKey(String sysUID, String commandName)	Helper method to retrieve the internal ID of the latest version of the command stream corresponding to the specified system and command input.
void	linkTo(ISystemDescStore systemStore)	Link this store to a system store to enable JOIN queries
default long	removeAllVersions(String sysUID, String controlInput)	Remove all command streams that are associated to the given system command input

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 org.sensorhub.api.datastore.resource.IResourceStore

selectAllFilter

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

filterBuilder

default CommandStreamFilter.Builder filterBuilder()

Specified by:

filterBuilder in interface IResourceStore<CommandStreamKey,ICommandStreamInfo,ICommandStreamStore.CommandStreamInfoField,CommandStreamFilter>

Returns:

A builder for a filter compatible with this datastore

add

CommandStreamKey add(ICommandStreamInfo csInfo)
              throws DataStoreException

Add a new command stream and generate a new unique key for it.
If the command stream valid time is not set, it will be set to the valid time of the parent system.

Specified by:

add in interface IResourceStore<CommandStreamKey,ICommandStreamInfo,ICommandStreamStore.CommandStreamInfoField,CommandStreamFilter>

Parameters:

csInfo - The command stream info object to be stored

Returns:

The key associated with the new command stream

Throws:

DataStoreException - if a command stream with the same parent system, taskable parameter and valid time already exists, or if the parent system is unknown.

getLatestVersionKey

default CommandStreamKey getLatestVersionKey(String sysUID,
 String commandName)

Helper method to retrieve the internal ID of the latest version of the command stream corresponding to the specified system and command input.

Parameters:

sysUID - Unique ID of system receiving the command stream

commandName - Name of taskable parameter associated to the command stream

Returns:

The command stream key or null if none was found

getLatestVersion

default ICommandStreamInfo getLatestVersion(String sysUID,
 String commandName)

Helper method to retrieve the latest version of the command stream corresponding to the specified system and command input.

Parameters:

sysUID - Unique ID of system receiving the command stream

commandName - Name of taskable parameter associated to the command stream

Returns:

The command stream info or null if none was found

getLatestVersionEntry

default Map.Entry<CommandStreamKey,ICommandStreamInfo> getLatestVersionEntry(String sysUID,
 String controlInput)

Helper method to retrieve the entry for the latest version of the command stream corresponding to the specified system and command input.

Parameters:

sysUID - Unique ID of system receiving the command stream

controlInput - Name of control input associated to the command stream

Returns:

The feature entry or null if none was found with this UID

removeAllVersions

default long removeAllVersions(String sysUID,
 String controlInput)

Remove all command streams that are associated to the given system command input

Parameters:

sysUID - Unique ID of system receiving the command stream

controlInput - Name of control input associated to the command stream

Returns:

The number of entries actually removed

linkTo

void linkTo(ISystemDescStore systemStore)

Link this store to a system store to enable JOIN queries

Parameters:

systemStore -