Package es.situm.sdk.model.cartography

Class Poi

java.lang.Object

es.situm.sdk.model.Resource

es.situm.sdk.model.cartography.Poi

All Implemented Interfaces:

android.os.Parcelable, BuildingResource, FloorResource, MapperInterface, Filterable

public class Poi
extends Resource
implements FloorResource, android.os.Parcelable, MapperInterface

Point of Interest, associated to a building, regardless of whether it's place inside or outside the building.

Instances are immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Poi.Builder	Builder to create a Poi instances

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
static android.os.Parcelable.Creator<Poi>	CREATOR

Fields inherited from class es.situm.sdk.model.Resource

EMPTY_IDENTIFIER, EMPTY_IDENTIFIER_BACKWARDS

Fields inherited from interface es.situm.sdk.model.MapperInterface

ACCESSIBILITY_MODE, ACCURACY, ADDRESS, ALTITUDE, ASSET_TRACKING_OPTIONS_BEACON_FILTERS, ASSET_TRACKING_OPTIONS_ENABLED, ASSET_TRACKING_OPTIONS_ITERATIONS_TO_UPLOAD, ASSET_TRACKING_OPTIONS_SCANNING_INTERVAL, BEACON_FILTER_UUID, BEARING, BEARING_FROM, BEARING_QUALITY, BOUNDS, BOUNDS_ROTATED, BUILDING, BUILDING_IDENTIFIER, BUILDING_NAME, CARTESIAN_BEARING, CARTESIAN_COORDINATE, CENTER, CLOSEST_LOCATION_IN_ROUTE, CODE, CONVERSION, COORDINATE, CREATED_AT, CURRENT_INDICATION, CURRENT_STEP_INDEX, CUSTOM_FIELDS, dateFormat, DEGREES, DEGREES_CLOCKWISE, DEVICE_ID, DIAGNOSTICS_OPTIONS_UPLOAD_DIAGNOSTICS_DATA, DIMENSIONS, DISTANCE, DISTANCE_TO_CHANGE_FLOOR_THRESHOLD, DISTANCE_TO_CHANGE_INDICATION_THRESHOLD, DISTANCE_TO_CLOSEST_POINT_IN_ROUTE, DISTANCE_TO_END_STEP, DISTANCE_TO_GOAL, DISTANCE_TO_GOAL_THRESHOLD, DISTANCE_TO_IGNORE_FIRST_INDICATION, DISTANCE_TO_NEXT_LEVEL, EDGES, EVENTS, EXCLUDED_TAGS, EXTERNAL_NAVIGATION_PAYLOAD, EXTERNAL_NAVIGATION_TYPE, FIRST_STEP, FLOOR, FLOOR_IDENTIFIER, FLOORS, FOREGROUND_SERVICE_NOTIFICATION_MESSAGE, FOREGROUND_SERVICE_NOTIFICATION_SHOW_STOP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_STOP_ACTION_TEXT, FOREGROUND_SERVICE_NOTIFICATION_TAP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_TITLE, FROM, GEOFENCES, HAS_BEARING, HAS_CARTESIAN_BEARING, HEIGHT, HUMAN_READABLE_MESSAGE, ID, IDENTIFIER, IGNORE_LOW_QUALITY_LOCATIONS, INCLUDED_TAGS, INDICATION_TYPE, INDICATIONS, INDICATIONS_INTERVAL, INDOOR_POIS, INFO_HTML, IS_FIRST, IS_INDOOR, IS_LAST, IS_OUTDOOR, IS_PUBLIC, LAST_STEP, LATITUDE, LONGITUDE, MAP_URL, MINIMIZE_FLOOR_CHANGES, NAME, NEEDED_LEVEL_CHANGE, NEXT_INDICATION, NEXT_LEVEL, NODES, NORTH_EAST, NORTH_WEST, ORIENTATION, ORIENTATION_TYPE, OUTDOOR_BUILDING_DETECTOR_BLE, OUTDOOR_POIS, OUTSIDE_ROUTE_THRESHOLD, PICTURE_THUMB_URL, PICTURE_URL, POI_CATEGORIES, POI_CATEGORY, POI_CATEGORY_CODE, POI_CATEGORY_ICON_SELECTED, POI_CATEGORY_ICON_UNSELECTED, POI_CATEGORY_IDENTIFIER, POI_CATEGORY_IDENTIFIERS, POI_CATEGORY_iNAME, POI_CATEGORY_NAME, POI_NAME, POI_TO, POI_TO_IDENTIFIER, POINTS, POLYGON_POINTS, POSITION, PROVIDER, QUALITY, RADIANS, RADIANS_MINUS_PI_PI, RADIUS, ROTATION, ROUND_INDICATIONS_STEP, ROUTE, ROUTE_STEP, SCALE, SEGMENTS, SOUTH_EAST, SOUTH_WEST, STATUS_NAME, STATUS_ORDINAL, STEP_IDX_DESTINATION, STEP_IDX_ORIGIN, STEPS, TIME_TO_END_STEP, TIME_TO_FIRST_INDICATION, TIME_TO_GOAL, TIME_TO_IGNORE_UNEXPECTED_FLOOR_CHANGES, TIMESTAMP, TO, TO_LEGACY, TRIGGER, UPDATED_AT, USER_IDENTIFIER, WIDTH, X, Y

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method	Description
int	describeContents()
boolean	equals(java.lang.Object o)
static Poi	fromMap(java.util.Map<java.lang.String,java.lang.Object> map)
java.lang.String	getBuildingIdentifier()	Returns identifier of building to which the POI belongs.
CartesianCoordinate	getCartesianCoordinate()	Returns cartesian coordinate of this position, relative to building Bounds).
java.util.Collection<PoiCategory>	getCategories()	Returns the list of PoiCategorys this POI belongs to.
PoiCategory	getCategory()	Returns category of the POI
java.lang.String	getCategoryIdentifier()	Return the identifier of the PoiCategory this POI belongs to.
java.util.Collection<java.lang.String>	getCategoryIdentifiers()	Returns the list of PoiCategory identifiers this POI belongs to.
Coordinate	getCoordinate()	Return geographical coordinate of this position
java.lang.String	getFloorIdentifier()	If this POI is outside the building (isOutdoor() == true), this field has no meaning.
java.lang.String	getInfoHtml()	Returns additional information about POI, in HTML.
java.lang.String	getLocalizedName(java.lang.String langCode)	Returns the name of the POI in the language specified.
java.lang.String	getName()	Returns a name for the POI, appropriate for display to the user.
Point	getPosition()
int	hashCode()
boolean	isIndoor()	Returns whether the POI is placed outside the building or not.
boolean	isOutdoor()	Returns whether the POI is placed outside the building or not.
java.util.Map<java.lang.String,java.lang.Object>	toMap()	Method to transform object into Map
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class es.situm.sdk.model.Resource

getCreatedAt, getCustomFields, getIdentifier, getUpdatedAt

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<Poi> CREATOR

Method Detail

getName

@NonNull
public java.lang.String getName()

Returns a name for the POI, appropriate for display to the user.

getLocalizedName

@NonNull
public java.lang.String getLocalizedName(java.lang.String langCode)

Returns the name of the POI in the language specified. If there is no name for that language it will return the default value

Parameters:

langCode - Language code in ISO 639. It must have two digits, for example "es", "en"

Returns:

Localized name

getInfoHtml

@NonNull
public java.lang.String getInfoHtml()

Returns additional information about POI, in HTML.

getCategory

@NonNull
public PoiCategory getCategory()

Returns category of the POI

getCategoryIdentifier

@NonNull
public java.lang.String getCategoryIdentifier()

Return the identifier of the PoiCategory this POI belongs to.

Returns:

Identifier

getCategories

@NonNull
public java.util.Collection<PoiCategory> getCategories()

Returns the list of PoiCategorys this POI belongs to.

Returns:

List of categories.

getCategoryIdentifiers

@NonNull
public java.util.Collection<java.lang.String> getCategoryIdentifiers()

Returns the list of PoiCategory identifiers this POI belongs to.

Returns:

List of identifiers.

getBuildingIdentifier

@NonNull
public java.lang.String getBuildingIdentifier()

Returns identifier of building to which the POI belongs.

Specified by:

getBuildingIdentifier in interface BuildingResource

getFloorIdentifier

@NonNull
public java.lang.String getFloorIdentifier()

If this POI is outside the building (isOutdoor() == true), this field has no meaning.

Specified by:

getFloorIdentifier in interface FloorResource

getPosition

public Point getPosition()

getCoordinate

@NonNull
public Coordinate getCoordinate()

Return geographical coordinate of this position

getCartesianCoordinate

@NonNull
public CartesianCoordinate getCartesianCoordinate()

Returns cartesian coordinate of this position, relative to building Bounds). If this POI is outside the building (isOutdoor() == true), this field has no meaning.

isOutdoor

public boolean isOutdoor()

Returns whether the POI is placed outside the building or not.

Returns:

true if it's outside, so it has no getCartesianCoordinate() nor getFloorIdentifier() ()}.

false otherwise.

isIndoor

public boolean isIndoor()

Returns whether the POI is placed outside the building or not.

Returns:

true if it's inside.

false otherwise.

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

Description copied from interface: MapperInterface

Method to transform object into Map

Specified by:

toMap in interface MapperInterface

Returns:

Map with the information of the object mapped

fromMap

public static Poi fromMap(java.util.Map<java.lang.String,java.lang.Object> map)
                   throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Resource

hashCode

public int hashCode()

Overrides:

hashCode in class Resource

toString

public java.lang.String toString()

Overrides:

toString in class Resource

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable