Package es.situm.sdk.model.cartography

Class Point

java.lang.Object

es.situm.sdk.model.cartography.Point

All Implemented Interfaces:

android.os.Parcelable, BuildingResource, FloorResource, MapperInterface

public class Point
extends Object
implements FloorResource, android.os.Parcelable, MapperInterface

Associate geographical coordinate (Location) with Building and Floor (Cartography) and cartesian coordinate relative to that building. Instances are immutable.

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final android.os.Parcelable.Creator<Point>	CREATOR
static final Point	EMPTY_INDOOR
static final Point	EMPTY_OUTDOOR

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, DURATION_MINUTES, 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, REALTIME_UPDATE_INTERVAL, 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

Constructor Summary

Constructors

Constructor	Description
Point(Building building, String floorIdentifier, CartesianCoordinate cartesianCoordinate)	Create a point placed indoors.
Point(Building building, String floorIdentifier, Coordinate coordinate)	Create a point placed indoors.
Point(Point point)
Point(Coordinate coordinate)	Create a point placed outdoors.
Point(String buildingIdentifier, Coordinate coordinate)	Create a point placed outdoors.
Point(String buildingIdentifier, String floorIdentifier, Coordinate coordinate, CartesianCoordinate cartesianCoordinate)	Create a point placed indoors.

Method Summary

Modifier and Type	Method	Description
int	describeContents()
boolean	equals(Object o)
static Point	fromMap(Map<String,Object> map)	Return a new Point instance object containing the data at the given map.
final String	getBuildingIdentifier()	Returns unique identifier for the building to which this point belongs
final CartesianCoordinate	getCartesianCoordinate()	Returns cartesian coordinate (in meters) relative to the Bounds of building's base.
final Coordinate	getCoordinate()	Returns geographic coordinate (latitude, longitude) of the point, regardless of whether it's placed inside or outside the building You can obtain this value from CartesianCoordinate using CoordinateConverter.
final String	getFloorIdentifier()	Returns floor identifier (inside the building) where this point is placed.
int	hashCode()
final boolean	isIndoor()	Return if the POI is inside the building.
final boolean	isOutdoor()	Return if the POI is outside the building.
String	lookupKey()
final boolean	sameFloor(Point that)
Map<String,Object>	toMap()	Method to transform object into Map<String, Object>
String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY_INDOOR

public static final Point EMPTY_INDOOR

EMPTY_OUTDOOR

public static final Point EMPTY_OUTDOOR

CREATOR

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

Constructor Details

Point

public Point(@NonNull
 Coordinate coordinate)

Create a point placed outdoors. It has no cartesian coordinate nor floor, because it's placed outside the building.

Parameters:

coordinate -

Point

public Point(@NonNull
 String buildingIdentifier,
 @NonNull
 Coordinate coordinate)

Create a point placed outdoors. It has no cartesian coordinate nor floor, because it's placed outside the building.

Parameters:

buildingIdentifier -

coordinate -

Point

public Point(@NonNull
 String buildingIdentifier,
 @NonNull
 String floorIdentifier,
 @NonNull
 Coordinate coordinate,
 @NonNull
 CartesianCoordinate cartesianCoordinate)

Create a point placed indoors.

Parameters:

buildingIdentifier -

floorIdentifier -

coordinate -

cartesianCoordinate -

Point

public Point(@NonNull
 Building building,
 @NonNull
 String floorIdentifier,
 @NonNull
 CartesianCoordinate cartesianCoordinate)

Create a point placed indoors. The geographical coordinate is calculated using the building

Point

public Point(@NonNull
 Building building,
 @NonNull
 String floorIdentifier,
 @NonNull
 Coordinate coordinate)

Create a point placed indoors. The cartesian coordinate is calculated using the building

Point

public Point(@NonNull
 Point point)

Method Details

getCartesianCoordinate

@NonNull
public final CartesianCoordinate getCartesianCoordinate()

Returns cartesian coordinate (in meters) relative to the Bounds of building's base. If this point is outdoors (isOutdoor == true), this field has no meaning.

Use isOutdoor() to check if the poi is indoors or outdoors

Returns:

Coordinate of this point, or (0,0) if it's outdoors.

getCoordinate

@NonNull
public final Coordinate getCoordinate()

Returns geographic coordinate (latitude, longitude) of the point, regardless of whether it's placed inside or outside the building You can obtain this value from CartesianCoordinate using CoordinateConverter.

Returns:

Coordinate of this point.

getBuildingIdentifier

@NonNull
public final String getBuildingIdentifier()

Returns unique identifier for the building to which this point belongs

Specified by:

getBuildingIdentifier in interface BuildingResource

getFloorIdentifier

@NonNull
public final String getFloorIdentifier()

Returns floor identifier (inside the building) where this point is placed. If this point is outdoors, this field has no meaning.

See isOutdoor() to check if the poi is indoors or outdoors

Specified by:

getFloorIdentifier in interface FloorResource

Returns:

String. If the point is outdoors, the value is unexpected.

isOutdoor

public final boolean isOutdoor()

Return if the POI is outside the building.

Returns:

true if the building is outdoors. Otherwise, false.

isIndoor

public final boolean isIndoor()

Return if the POI is inside the building.

Returns:

true if the building is indoors. Otherwise, false.

sameFloor

public final boolean sameFloor(Point that)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

lookupKey

public String lookupKey()

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

toMap

public Map<String,Object> toMap()

Description copied from interface: MapperInterface

Method to transform object into Map<String, Object>

Specified by:

toMap in interface MapperInterface

Returns:

Map<String, Object> with the information of the object mapped

fromMap

public static Point fromMap(Map<String,Object> map)
                     throws IllegalArgumentException

Return a new Point instance object containing the data at the given map. Use MapperInterface to populate the Map. The expected fields are those defined at this class.

Parameters:

map - Map containing the data used to populate the new object.

Returns:

New instance.

Throws:

IllegalArgumentException - If there is not enough information at the given map or it is incorrect.