Package org.yamcs.timeline

Class TimelineItemDb

java.lang.Object

org.yamcs.timeline.TimelineItemDb

All Implemented Interfaces:

ItemProvider

public class TimelineItemDb
extends Object
implements ItemProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CNAME_ACTIVITY_DEFINITION
static final String	CNAME_DESCRIPTION
static final String	CNAME_DURATION
static final String	CNAME_FAILURE_REASON
static final String	CNAME_GROUP_ID
static final String	CNAME_ID
static final String	CNAME_NAME
static final String	CNAME_RELTIME_ID
static final String	CNAME_RELTIME_START
static final String	CNAME_RUNS
static final String	CNAME_START
static final String	CNAME_STATUS
static final String	CNAME_TAGS
static final String	CNAME_TYPE
static final String	CRIT_KEY_TAG
static final TupleDefinition	TIMELINE_DEF

Constructor Summary

Constructors

Constructor	Description
TimelineItemDb(String yamcsInstance)

Method Summary

Modifier and Type	Method	Description
TimelineItem	addItem(TimelineItem item)	Add an item and return the added item.
void	addItemListener(ItemListener itemListener)
LogEntry	addItemLog(String id, LogEntry entry)	Adds an entry to the log table
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)
TimelineItemLog	getItemLog(String id)	Returns the item log or null if the item does not exist
void	getItems(int limit, String token, RetrievalFilter filter, ItemReceiver consumer)
Collection<String>	getTags()
void	removeItemListener(ItemListener itemListener)
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

Field Details

TIMELINE_DEF

public static final TupleDefinition TIMELINE_DEF

CNAME_START

public static final String CNAME_START

See Also:

• Constant Field Values

CNAME_DURATION

public static final String CNAME_DURATION

See Also:

• Constant Field Values

CNAME_ID

public static final String CNAME_ID

See Also:

• Constant Field Values

CNAME_NAME

public static final String CNAME_NAME

See Also:

• Constant Field Values

CNAME_TYPE

public static final String CNAME_TYPE

See Also:

• Constant Field Values

CNAME_STATUS

public static final String CNAME_STATUS

See Also:

• Constant Field Values

CNAME_TAGS

public static final String CNAME_TAGS

See Also:

• Constant Field Values

CNAME_GROUP_ID

public static final String CNAME_GROUP_ID

See Also:

• Constant Field Values

CNAME_RELTIME_ID

public static final String CNAME_RELTIME_ID

See Also:

• Constant Field Values

CNAME_RELTIME_START

public static final String CNAME_RELTIME_START

See Also:

• Constant Field Values

CNAME_DESCRIPTION

public static final String CNAME_DESCRIPTION

See Also:

• Constant Field Values

CNAME_FAILURE_REASON

public static final String CNAME_FAILURE_REASON

See Also:

• Constant Field Values

CNAME_ACTIVITY_DEFINITION

public static final String CNAME_ACTIVITY_DEFINITION

See Also:

• Constant Field Values

CNAME_RUNS

public static final String CNAME_RUNS

See Also:

• Constant Field Values

CRIT_KEY_TAG

public static final String CRIT_KEY_TAG

See Also:

• Constant Field Values

Constructor Details

TimelineItemDb

public TimelineItemDb(String yamcsInstance)
               throws InitException

Throws:

InitException

Method Details

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

getItem

public TimelineItem getItem(String id)

Specified by:

getItem in interface ItemProvider

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

getItems

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

Specified by:

getItems in interface ItemProvider

addItemListener

public void addItemListener(ItemListener itemListener)

removeItemListener

public void removeItemListener(ItemListener itemListener)

getTags

public Collection<String> getTags()

getCapabilities

public TimelineSourceCapabilities getCapabilities()

Specified by:

getCapabilities 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

getItemLog

public TimelineItemLog getItemLog(String id)

Description copied from interface: ItemProvider

Returns the item log or null if the item does not exist

Specified by:

getItemLog in interface ItemProvider

addItemLog

public LogEntry addItemLog(String id,
 LogEntry entry)

Description copied from interface: ItemProvider

Adds an entry to the log table

Specified by:

addItemLog in interface ItemProvider