org.yamcs.archive

Interface TagDb

All Known Implementing Classes:

RdbTagDb

public interface TagDb

Method Summary

Modifier and Type	Method and Description
void	close() close the database and release resources the object is unusable after this call.
Yamcs.ArchiveTag	deleteTag(long tagTime, int tagId) Deletes the specified tag
Yamcs.ArchiveTag	getTag(long tagTime, int tagId) Returns a specific tag, or null if the requested tag does not exist
void	getTags(TimeInterval intv, TagReceiver callback) Synchonously gets tags, passing every separate one to the provided TagReceiver.
Yamcs.ArchiveTag	insertTag(Yamcs.ArchiveTag tag) Inserts a new Tag.
Yamcs.ArchiveTag	updateTag(long tagTime, int tagId, Yamcs.ArchiveTag tag) Updates an existing tag.

Method Detail

getTags

void getTags(TimeInterval intv,
             TagReceiver callback)
      throws IOException

Synchonously gets tags, passing every separate one to the provided TagReceiver.

Throws:

IOException

getTag

Yamcs.ArchiveTag getTag(long tagTime,
                        int tagId)
                 throws IOException

Returns a specific tag, or null if the requested tag does not exist

Throws:

IOException

insertTag

Yamcs.ArchiveTag insertTag(Yamcs.ArchiveTag tag)
                    throws IOException

Inserts a new Tag. No id should be specified. If it is, it will silently be overwritten, and the new tag will be returned.

Throws:

IOException

updateTag

Yamcs.ArchiveTag updateTag(long tagTime,
                           int tagId,
                           Yamcs.ArchiveTag tag)
                    throws IOException,
                           YamcsException

Updates an existing tag. The tag is fetched by the specified id throws YamcsException if the tag could not be found.

Note that both tagId and oldTagStart need to be specified so that a direct lookup in the internal data structure can be made.

Returns:

the updated tag

Throws:

IOException

YamcsException

deleteTag

Yamcs.ArchiveTag deleteTag(long tagTime,
                           int tagId)
                    throws IOException,
                           YamcsException

Deletes the specified tag

Throws:

YamcsException - if the id was invalid, or if the tag could not be found

IOException

close

void close()

close the database and release resources the object is unusable after this call.