Package org.openhab.core.persistence

Interface PersistenceItemInfo

@NonNullByDefault public interface PersistenceItemInfo
This class provides information about an item that is stored in a persistence service. It is used to return information about the item to the system
Author:
Chris Jackson - Initial contribution

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable Integer
    getCount()
    Returns a counter with the number of rows of data associated with the item Note that this should be used as a guide to the amount of data and may note be 100% accurate.
    @Nullable Date
    getEarliest()
    Returns the earliest timestamp from data in the persistence database
    @Nullable Date
    getLatest()
    Returns the latest timestamp from data in the persistence database
    String
    getName()
    Returns the item name.

  • Method Details

    • getName

      String getName()
      Returns the item name. It should be noted that the item name is as stored in the persistence service and as such may not be linked to an item. This may be the case if the item was removed from the system, but data still exists in the persistence service.
      Returns:
      Item name

    • getCount

      @Nullable Integer getCount()
      Returns a counter with the number of rows of data associated with the item Note that this should be used as a guide to the amount of data and may note be 100% accurate. If accurate information is required, the QueryablePersistenceService.query(org.openhab.core.persistence.FilterCriteria) method should be used.
      Returns:
      count of the number of rows of data. May return null if the persistence service doesn't support this.

    • getEarliest

      @Nullable Date getEarliest()
      Returns the earliest timestamp from data in the persistence database
      Returns:
      the earliest Date stored in the database. May return null if the persistence service doesn't support this.

    • getLatest

      @Nullable Date getLatest()
      Returns the latest timestamp from data in the persistence database
      Returns:
      the latest Date stored in the database. May return null if the persistence service doesn't support this.