GoIndoor

java.lang.Object
- com.oym.indoor.GoIndoor

```
public class GoIndoor
extends java.lang.Object
```
This class is the entry point of the GoIndoor library. From here, all the data stored in the server can be accessed.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GoIndoor.Builder` Builder class for GoIndoor.
`static interface`	`GoIndoor.LocationAlgorithm` Annotation defining the possible algorithms to be used
`static interface`	`GoIndoor.UpdatePolicy` Annotation defining the database update policy

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_LOCATION_REFRESH` Variable defining the default location update rate in msec
`static int`	`LOCATION_TYPE_AVERAGE` Weighted average
`static int`	`LOCATION_TYPE_CLOSEST` Closest Beacon
`static int`	`LOCATION_TYPE_PROJECT` Weighted average with projection to the closest edge
`static int`	`UPDATE_MOBILE` Update only over Mobile data connection
`static int`	`UPDATE_NO` Updates are disabled
`static int`	`UPDATE_WIFI` Update only over Wifi

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Route`	`computeRoute(RoutePoint start, RoutePoint destination)` This method computes a route between two given points.
`void`	`disconnect()` This method will disconnect the location provider and closes the session to the server.
`java.util.ArrayList<Asset>`	`getAssets()` Getter for the asset list.
`java.util.ArrayList<Asset>`	`getAssets(java.util.ArrayList<java.lang.String> ids)` Getter for the asset list.
`java.util.ArrayList<Asset>`	`getAssets(java.lang.String id)` Getter for the asset list.
`java.util.ArrayList<Beacon>`	`getBeacons()` Getter for the beacon list.
`java.util.ArrayList<Beacon>`	`getBeacons(java.util.ArrayList<java.lang.String> ids)` Getter for the beacon list.
`java.util.ArrayList<Beacon>`	`getBeacons(java.lang.String id)` Getter for the beacon list.
`java.util.ArrayList<Building>`	`getBuildings()` Getter for the building list.
`java.util.ArrayList<Building>`	`getBuildings(java.util.ArrayList<java.lang.String> ids)` Getter for the building list.
`Building`	`getBuildings(java.lang.String id)` Getter for a building.
`Logger`	`getLogger()` Getter for the logger object.
`java.util.ArrayList<Notification>`	`getNotifications()` Getter for the notification list.
`java.util.ArrayList<Notification>`	`getNotifications(java.util.ArrayList<java.lang.String> ids)` Getter for the notification list.
`java.util.ArrayList<Notification>`	`getNotifications(java.lang.String id)` Getter for the notification list.
`Place`	`getPlace(java.lang.String id)` Getter for a place.
`java.util.ArrayList<Place>`	`getPlaces()` Getter for the place list.
`java.util.ArrayList<Place>`	`getPlaces(java.util.ArrayList<java.lang.String> ids)` Getter for the places list.
`java.util.ArrayList<Place>`	`getPlaces(double latitude, double longitude, int radius, int floorNumber, java.lang.String building, java.util.ArrayList<java.lang.String> tags, java.util.HashMap<java.lang.String,java.lang.String> filter)` Getter for the place list.
`java.util.ArrayList<Place>`	`getPlaces(LocationResult loc, int radius, java.util.ArrayList<java.lang.String> tags, java.util.HashMap<java.lang.String,java.lang.String> filter)` Getter for places inside a defined area.
`java.util.ArrayList<Place>`	`getPlaces(java.lang.String id)` Getter for the place list.
`java.util.ArrayList<Place>`	`getPlaces(java.lang.String id, java.util.ArrayList<java.lang.String> tags, java.util.HashMap<java.lang.String,java.lang.String> filter)` Getter for the place list.
`Settings`	`getSettings()` Getter for the settings.
`UserProfile`	`getUserProfile()` Getter for the user profile.
`void`	`setLocationType(int type)` Sets the positioning type.
`void`	`setMinDistanceUpdate(double distanceUpdate)` Sets the minimum distance that should change the location result to be updated.
`void`	`setScanForced(boolean scanForced)` Beta feature In order to palliate the Android bug 65863, this method will force the beacons scan to be enabled for at least 700ms and disabled at least 300ms.
`void`	`setScanForced(boolean scanForced, long enabled, long disabled)` Beta feature In order to palliate the Android bug 65863, this method will force the beacons scan to be enabled for at least 700ms and disabled at least 300ms.
`void`	`setUpdatePolicy(int policy)` Sets the update policy.
`void`	`startLocate(LocationBroadcast br)` Method to start the indoor location.
`void`	`stopLocate()` Method to stop the indoor location
`void`	`triggerUpdate()` Triggers an immediate update to the database.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_LOCATION_REFRESH
```
public static final long DEFAULT_LOCATION_REFRESH
```
    Variable defining the default location update rate in msec
  - LOCATION_TYPE_AVERAGE
```
public static final int LOCATION_TYPE_AVERAGE
```
    Weighted average
    
    See Also:
    
    Constant Field Values
  - LOCATION_TYPE_CLOSEST
```
public static final int LOCATION_TYPE_CLOSEST
```
    Closest Beacon
    
    See Also:
    
    Constant Field Values
  - LOCATION_TYPE_PROJECT
```
public static final int LOCATION_TYPE_PROJECT
```
    Weighted average with projection to the closest edge
    
    See Also:
    
    Constant Field Values
  - UPDATE_NO
```
public static final int UPDATE_NO
```
    Updates are disabled
    
    See Also:
    
    Constant Field Values
  - UPDATE_WIFI
```
public static final int UPDATE_WIFI
```
    Update only over Wifi
    
    See Also:
    
    Constant Field Values
  - UPDATE_MOBILE
```
public static final int UPDATE_MOBILE
```
    Update only over Mobile data connection
    
    See Also:
    
    Constant Field Values
- Method Detail
  - disconnect
```
public void disconnect()
```
    This method will disconnect the location provider and closes the session to the server.
  - startLocate
```
public void startLocate(LocationBroadcast br)
```
    Method to start the indoor location.
    
    Parameters:
    
    br - LocationBroadcast to handle the output from the library
  - stopLocate
```
public void stopLocate()
```
    Method to stop the indoor location
  - computeRoute
```
public Route computeRoute(RoutePoint start,
                          RoutePoint destination)
                   throws java.lang.IllegalArgumentException
```
    This method computes a route between two given points.
    
    Parameters:
    
    start - Departure point
    
    destination - Destination point
    
    Returns:
    
    A Route object describing the route between the given points
    
    Throws:
    
    java.lang.IllegalArgumentException - If route between buildings is computed or there are no edges
  - getLogger
```
public Logger getLogger()
```
    Getter for the logger object. It can be used to log position and routes in the server.
    
    Returns:
    
    The logger object
  - getBeacons
```
public java.util.ArrayList<Beacon> getBeacons()
```
    Getter for the beacon list.
    
    Returns:
    
    The beacon list
  - getBeacons
```
public java.util.ArrayList<Beacon> getBeacons(java.lang.String id)
```
    Getter for the beacon list.
    
    Parameters:
    
    id - Building or floor ID whose beacons need to be retrieved
    
    Returns:
    
    The beacon list
  - getBeacons
```
public java.util.ArrayList<Beacon> getBeacons(java.util.ArrayList<java.lang.String> ids)
```
    Getter for the beacon list.
    
    Parameters:
    
    ids - Building or floor IDs whose beacons need to be retrieved
    
    Returns:
    
    The beacon list
  - getBuildings
```
public java.util.ArrayList<Building> getBuildings()
```
    Getter for the building list.
    
    Returns:
    
    The building list
  - getBuildings
```
public Building getBuildings(java.lang.String id)
```
    Getter for a building.
    
    Parameters:
    
    id - Building ID to be retrieved
    
    Returns:
    
    The building if exists, null otherwise
  - getBuildings
```
public java.util.ArrayList<Building> getBuildings(java.util.ArrayList<java.lang.String> ids)
```
    Getter for the building list.
    
    Parameters:
    
    ids - Building IDs to be retrieved
    
    Returns:
    
    The building list if available
  - getAssets
```
public java.util.ArrayList<Asset> getAssets()
```
    Getter for the asset list.
    
    Returns:
    
    The asset list
  - getAssets
```
public java.util.ArrayList<Asset> getAssets(java.lang.String id)
```
    Getter for the asset list.
    
    Parameters:
    
    id - Building or floor ID whose assets need to be retrieved
    
    Returns:
    
    The asset list
  - getAssets
```
public java.util.ArrayList<Asset> getAssets(java.util.ArrayList<java.lang.String> ids)
```
    Getter for the asset list.
    
    Parameters:
    
    ids - Building or floor IDs whose assets need to be retrieved
    
    Returns:
    
    The asset list
  - getPlace
```
public Place getPlace(java.lang.String id)
```
    Getter for a place.
    
    Returns:
    
    The place if it exists, null otherwise
  - getPlaces
```
public java.util.ArrayList<Place> getPlaces()
```
    Getter for the place list.
    
    Returns:
    
    The place list
  - getPlaces
```
public java.util.ArrayList<Place> getPlaces(java.lang.String id)
```
    Getter for the place list.
    
    Parameters:
    
    id - Building or floor ID whose places need to be retrieved
    
    Returns:
    
    The place list
  - getPlaces
```
public java.util.ArrayList<Place> getPlaces(java.util.ArrayList<java.lang.String> ids)
```
    Getter for the places list.
    
    Parameters:
    
    ids - Building or floor IDs whose places need to be retrieved
    
    Returns:
    
    The place list
  - getPlaces
```
public java.util.ArrayList<Place> getPlaces(LocationResult loc,
                                            int radius,
                                            java.util.ArrayList<java.lang.String> tags,
                                            java.util.HashMap<java.lang.String,java.lang.String> filter)
```
    Getter for places inside a defined area.
    
    Parameters:
    
    loc - Location whose places needs to be retrieved
    
    radius - Radius from the location. If 0 it will returns the closest one
    
    tags - List of POI tags that should match in the search, it can be null
    
    filter - Map of POI properties that should match in the search, it can be null
    
    Returns:
    
    The place list satisfying the criteria, sorted by distance
  - getPlaces
```
public java.util.ArrayList<Place> getPlaces(java.lang.String id,
                                            java.util.ArrayList<java.lang.String> tags,
                                            java.util.HashMap<java.lang.String,java.lang.String> filter)
```
    Getter for the place list.
    
    Parameters:
    
    id - Building or floor ID whose places need to be retrieved, it can be null
    
    tags - List of POI tags that should match in the search, it can be null
    
    filter - Map of POI properties that should match in the search, it can be null
    
    Returns:
    
    The place list satisfying the criteria
  - getPlaces
```
public java.util.ArrayList<Place> getPlaces(double latitude,
                                            double longitude,
                                            int radius,
                                            int floorNumber,
                                            java.lang.String building,
                                            java.util.ArrayList<java.lang.String> tags,
                                            java.util.HashMap<java.lang.String,java.lang.String> filter)
```
    Getter for the place list.
    
    Parameters:
    
    latitude - WGS84 latitude whose places needs to be retrieved
    
    longitude - WGS84 longitude whose areas needs to be retrieved
    
    radius - Radius from the location. If 0 it will returns the closest one
    
    floorNumber - Floor number whose places needs to be retrieved
    
    building - Building ID whose places needs to be retrieved
    
    tags - List of POI tags that should match in the search, it can be null
    
    filter - Map of POI properties that should match in the search, it can be null
    
    Returns:
    
    The place list satisfying the criteria, sorted by distance
  - getNotifications
```
public java.util.ArrayList<Notification> getNotifications()
```
    Getter for the notification list.
    
    Returns:
    
    The notification list
  - getNotifications
```
public java.util.ArrayList<Notification> getNotifications(java.lang.String id)
```
    Getter for the notification list.
    
    Parameters:
    
    id - Building or floor ID whose notifications need to be retrieved
    
    Returns:
    
    The notification list
  - getNotifications
```
public java.util.ArrayList<Notification> getNotifications(java.util.ArrayList<java.lang.String> ids)
```
    Getter for the notification list.
    
    Parameters:
    
    ids - Building or floor IDs whose notifications need to be retrieved
    
    Returns:
    
    The notification list
  - getSettings
```
public Settings getSettings()
```
    Getter for the settings.
    
    Returns:
    
    The settings object
  - getUserProfile
```
public UserProfile getUserProfile()
```
    Getter for the user profile.
    
    Returns:
    
    The user profile
  - setScanForced
```
public void setScanForced(boolean scanForced)
```
    Beta feature In order to palliate the Android bug 65863, this method will force the beacons scan to be enabled for at least 700ms and disabled at least 300ms.
    
    Parameters:
    
    scanForced - Flag to enable the forced scan
    
    See Also:
    
    Android bug 65863
  - setScanForced
```
public void setScanForced(boolean scanForced,
                          long enabled,
                          long disabled)
```
    Beta feature In order to palliate the Android bug 65863, this method will force the beacons scan to be enabled for at least 700ms and disabled at least 300ms.
    
    Parameters:
    
    scanForced - Flag to enable the forced scan
    
    enabled - Beacon scanning time in msec. Shall be bigger than 700.
    
    disabled - Beacon stop scanning time in msec. Shall be bigger than 300.
    
    See Also:
    
    Android bug 65863
  - setLocationType
```
public void setLocationType(int type)
```
    Sets the positioning type. It overrides the value given in the builder.
    
    Parameters:
    
    type - Location type to be applied
  - setMinDistanceUpdate
```
public void setMinDistanceUpdate(double distanceUpdate)
```
    Sets the minimum distance that should change the location result to be updated.
    
    Parameters:
    
    distanceUpdate - Distance threshold
  - setUpdatePolicy
```
public void setUpdatePolicy(int policy)
```
    Sets the update policy. It overrides the value given in the builder.
    
    Parameters:
    
    policy - Update policy to be applied
  - triggerUpdate
```
public void triggerUpdate()
```
    Triggers an immediate update to the database. It assumes that the update policy is fulfilled.

Class GoIndoor

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LOCATION_REFRESH

LOCATION_TYPE_AVERAGE

LOCATION_TYPE_CLOSEST

LOCATION_TYPE_PROJECT

UPDATE_NO

UPDATE_WIFI

UPDATE_MOBILE

Method Detail

disconnect

startLocate

stopLocate

computeRoute

getLogger

getBeacons

getBeacons

getBeacons

getBuildings

getBuildings

getBuildings

getAssets

getAssets

getAssets

getPlace

getPlaces

getPlaces

getPlaces

getPlaces

getPlaces

getPlaces

getNotifications

getNotifications

getNotifications

getSettings

getUserProfile

setScanForced

setScanForced

setLocationType

setMinDistanceUpdate

setUpdatePolicy

triggerUpdate