Package 

Interface PoiManager

  • All Implemented Interfaces:
    com.pointrlabs.core.management.interfaces.Advertiser

    
    public interface PoiManager
     implements Advertiser<PoiManager.Listener>
                        

    Main class responsible for POI related search and access.

    • Constructor Detail

    • Method Detail

      • getPois

         abstract PoiContainer getPois(Site site)

        Returns all Poi objects. Sorted alphabetically ignoring case by title. Note there might be multiple Poi objects with same title.

        Parameters:
        site - to get pois for
      • getPois

         abstract PoiContainer getPois(Site site, List<String> types)

        Returns all Poi objects. Sorted alphabetically ignoring case by title. Note there might be multiple Poi objects with same title.

        Parameters:
        site - to get pois for
        types - a list of types to filter the pois.
      • getPois

         abstract PoiContainer getPois(Site site, List<String> types, Boolean shouldSortByProximity)

        Returns all Poi objects. Sorted by proximity.

        Parameters:
        site - to get pois for
        types - a list of types to filter the pois.
        shouldSortByProximity - enables/disables sorting by proximity to the current location.
      • getPois

         abstract PoiContainer getPois(Building building)

        Returns all Poi objects. Sorted alphabetically ignoring case by title. Note there might be multiple Poi objects with same title.

        Parameters:
        building - to get pois for
      • getPois

         abstract PoiContainer getPois(Building building, List<String> types)

        Returns all Poi objects. Sorted alphabetically ignoring case by title. Note there might be multiple Poi objects with same title.

        Parameters:
        building - to get pois for
        types - a list of types to filter the pois.
      • getPois

         abstract PoiContainer getPois(Building building, List<String> types, Boolean shouldSortByProximity)

        Returns all Poi objects. Sorted by proximity.

        Parameters:
        building - to get pois for
        types - a list of types to filter the pois.
        shouldSortByProximity - enables/disables sorting by proximity to the current location.
      • getPois

         abstract List<Poi> getPois(Site site, Building buildingInFocus, PoiCategory poiCategory)

        Returns all poi objects that are included in the types designated for the given poi category The sorting mechanism is as below; If there is a valid indoor position, the pois in the physical building are sorted by proximity and appended at the beginning of the resulting list If there is a valid focused building, the pois in the focused building are appended to the resulting list without proximity sort Then the pois from the remaining buildings are appended.

        Parameters:
        site - The site that the user is viewing in MapWidget.
        buildingInFocus - The building that the user is viewing in MapWidget.
        poiCategory - The poi category that will be used to filter the pois
      • getPois

         abstract PoiContainer getPois(Level level)

        Returns all Poi objects. Sorted alphabetically ignoring case by title. Note there might be multiple Poi objects with same title.

        Parameters:
        level - to get pois for
      • getPois

         abstract PoiContainer getPois(Level level, List<String> types)

        Returns all Poi objects. Sorted alphabetically ignoring case by title. Note there might be multiple Poi objects with same title.

        Parameters:
        level - to get pois for
        types - a list of types to filter the pois.
      • getPois

         abstract PoiContainer getPois(Level level, List<String> types, Boolean shouldSortByProximity)

        Returns all Poi objects. Sorted by proximity.

        Parameters:
        level - to get pois for
        types - a list of types to filter the pois.
        shouldSortByProximity - enables/disables sorting by proximity to the current location.
      • searchPois

         abstract PoiContainer searchPois(Site site, String searchString)

        Search poi in site with a string

        Parameters:
        site - the site to search in
        searchString - the query string
      • searchPois

         abstract PoiContainer searchPois(Site site, String searchString, List<String> types)

        Search poi in site with a string

        Parameters:
        site - the site to search in
        searchString - the query string
        types - only search for pois with this types
      • searchPois

         abstract PoiContainer searchPois(Building building, String searchString)

        Search poi in site with a string

        Parameters:
        building - the building to search in
        searchString - the query string
      • searchPois

         abstract PoiContainer searchPois(Building building, String searchString, List<String> types)

        Search poi in site with a string

        Parameters:
        building - the building to search in
        searchString - the query string
        types - only search for pois with this types