Package org.yamcs.timeline

Class CommandItemProvider

java.lang.Object

org.yamcs.timeline.CommandItemProvider

All Implemented Interfaces:

ItemProvider

public class CommandItemProvider
extends Object
implements ItemProvider

Implements the "commands" timeline source providing items derived from the command history.

The filtering criteria which can be applied is based on the command name patterns (regular expressions matching command names)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CRIT_KEY_CMD_NAME_PATTERN

Constructor Summary

Constructors

Constructor	Description
CommandItemProvider(String yamcsInstance)

Method Summary

Modifier and Type	Method	Description
TimelineItem	addItem(TimelineItem item)	Add an item and return the added item.
TimelineItem	deleteItem(UUID uuid)	Delete the item with the given uuid and return the deleted item.
TimelineItem	deleteTimelineGroup(UUID uuid)
TimelineSourceCapabilities	getCapabilities()
TimelineItem	getItem(String id)
void	getItems(int limit, String next, RetrievalFilter filter, ItemReceiver consumer)
TimelineItem	updateItem(TimelineItem item)	Update an item and return the updated item.
void	validateFilters(List<ItemFilter> filters)	Checks that the source can filter based on the criteria specified

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yamcs.timeline.ItemProvider

addItemLog, getItemLog

Field Details

CRIT_KEY_CMD_NAME_PATTERN

public static final String CRIT_KEY_CMD_NAME_PATTERN

See Also:

• Constant Field Values

Constructor Details

CommandItemProvider

public CommandItemProvider(String yamcsInstance)

Method Details

getItem

public TimelineItem getItem(String id)

Specified by:

getItem in interface ItemProvider

getItems

public void getItems(int limit,
 String next,
 RetrievalFilter filter,
 ItemReceiver consumer)

Specified by:

getItems in interface ItemProvider

validateFilters

public void validateFilters(List<ItemFilter> filters)
                     throws BadRequestException

Description copied from interface: ItemProvider

Checks that the source can filter based on the criteria specified

Specified by:

validateFilters in interface ItemProvider

Throws:

BadRequestException

addItem

public TimelineItem addItem(TimelineItem item)

Description copied from interface: ItemProvider

Add an item and return the added item.

The returned value should have defaults (if any) filled in, also if the item has a relative time, the start time of the returned value will be computed from the relative time and the start of TimelineItem.relativeItemUuid

Specified by:

addItem in interface ItemProvider

updateItem

public TimelineItem updateItem(TimelineItem item)

Description copied from interface: ItemProvider

Update an item and return the updated item.

The item parameter should have the uuid set and at least the start time or relative time

Specified by:

updateItem in interface ItemProvider

Returns:

the updated item

deleteItem

public TimelineItem deleteItem(UUID uuid)

Description copied from interface: ItemProvider

Delete the item with the given uuid and return the deleted item.

If the item does not exist, return null

Specified by:

deleteItem in interface ItemProvider

deleteTimelineGroup

public TimelineItem deleteTimelineGroup(UUID uuid)

Specified by:

deleteTimelineGroup in interface ItemProvider

getCapabilities

public TimelineSourceCapabilities getCapabilities()

Specified by:

getCapabilities in interface ItemProvider