Interface TagDb

  • All Known Implementing Classes:
    RdbTagDb

    public interface TagDb
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()
      close the database and release resources the object is unusable after this call.
      org.yamcs.protobuf.Yamcs.ArchiveTag deleteTag​(long tagTime, int tagId)
      Deletes the specified tag
      org.yamcs.protobuf.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.
      org.yamcs.protobuf.Yamcs.ArchiveTag insertTag​(org.yamcs.protobuf.Yamcs.ArchiveTag tag)
      Inserts a new Tag.
      org.yamcs.protobuf.Yamcs.ArchiveTag updateTag​(long tagTime, int tagId, org.yamcs.protobuf.Yamcs.ArchiveTag tag)
      Updates an existing tag.
    • Method Detail

      • getTag

        org.yamcs.protobuf.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

        org.yamcs.protobuf.Yamcs.ArchiveTag insertTag​(org.yamcs.protobuf.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

        org.yamcs.protobuf.Yamcs.ArchiveTag updateTag​(long tagTime,
                                                      int tagId,
                                                      org.yamcs.protobuf.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
      • close

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