Package es.situm.sdk.model.cartography

Class Building

java.lang.Object

es.situm.sdk.model.Resource

es.situm.sdk.model.cartography.Building

All Implemented Interfaces:

android.os.Parcelable, MapperInterface, Filterable

public class Building
extends Resource
implements android.os.Parcelable, MapperInterface

A building. Instances are immutable.

See Building.Builder to create an instance and CoordinateConverter to convert between Coordinate and CartesianCoordinate's building coordinate.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Building.Builder	Builder to create a Building instance

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<Building>	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, 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, 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)
java.lang.String	getAddress()	Returns the building address.
Bounds	getBounds()	Compute corners of this building, without rotation, in earth coordinates.
Bounds	getBoundsRotated()	Compute corners of this building, with rotation, in earth coordinates.
Coordinate	getCenter()	Return center of the building's base, as geographical coordinate.
Dimensions	getDimensions()	Returns dimensions of building's base (height and width) in meters.
java.lang.String	getInfoHtml()	Returns additional information about the building, formatted with HTML.
java.lang.String	getName()	Returns the building name that is appropriate for display to the user.
URL	getPictureThumbUrl()	Return the url of the thumbnail building image
URL	getPictureUrl()	Return the url of the building image
Angle	getRotation()	Returns rotation angle of the building's base, relative to the west-east axis, increasing in clockwise, being 0 the west-east axis.
java.lang.String	getUserIdentifier()	Returns unique identifier of the owner user of the building
int	hashCode()
java.util.List<Point>	routePointsForDevice(long deviceID)
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<Building> CREATOR

Method Detail

getUserIdentifier

@NonNull
public java.lang.String getUserIdentifier()

Returns unique identifier of the owner user of the building

Returns:

String

getName

@NonNull
public java.lang.String getName()

Returns the building name that is appropriate for display to the user.

getAddress

@NonNull
public java.lang.String getAddress()

Returns the building address.

getInfoHtml

@NonNull
public java.lang.String getInfoHtml()

Returns additional information about the building, formatted with HTML.

getDimensions

@NonNull
public Dimensions getDimensions()

Returns dimensions of building's base (height and width) in meters.

getCenter

@NonNull
public Coordinate getCenter()

Return center of the building's base, as geographical coordinate.

getRotation

@NonNull
public Angle getRotation()

Returns rotation angle of the building's base, relative to the west-east axis, increasing in clockwise, being 0 the west-east axis.

getPictureUrl

@NonNull
public URL getPictureUrl()

Return the url of the building image

getPictureThumbUrl

@NonNull
public URL getPictureThumbUrl()

Return the url of the thumbnail building image

getBoundsRotated

@NonNull
public Bounds getBoundsRotated()

Compute corners of this building, with rotation, in earth coordinates.

Returns:

Bounds

routePointsForDevice

public java.util.List<Point> routePointsForDevice(long deviceID)

getBounds

@NonNull
public Bounds getBounds()

Compute corners of this building, without rotation, in earth coordinates.

Returns:

Bounds

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

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