Package org.openhab.core.semantics

Interface SemanticsService

@NonNullByDefault public interface SemanticsService
This interface defines a service, which offers functionality regarding semantic tags.
Author:
Kai Kreuzer - Initial contribution

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<Item>
    getItemsInLocation(Class<? extends Location> locationType)
    Retrieves all items that are located in a given location type and which are either classified as Points or Equipments.
    Set<Item>
    getItemsInLocation(String labelOrSynonym, Locale locale)
    Retrieves all items that are located in a given location and which are either classified as Points or Equipments.

  • Method Details

    • getItemsInLocation

      Set<Item> getItemsInLocation(Class<? extends Location> locationType)
      Retrieves all items that are located in a given location type and which are either classified as Points or Equipments.
      Parameters:
      locationType - the location type (tag) where items must be located.
      Returns:
      as set of items that are located in a given location type

    • getItemsInLocation

      Set<Item> getItemsInLocation(String labelOrSynonym, Locale locale)
      Retrieves all items that are located in a given location and which are either classified as Points or Equipments. The location is identified by its label or synonym and can reference either a type (e.g. "Bathroom") or a concrete instance (e.g. "Joe's Room").
      Parameters:
      labelOrSynonym - the label or synonym of the location
      locale - the locale used to look up the tag label
      Returns:
      as set of items that are located in the given location(s)