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, Filterable

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

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 Object>, android.os.Parcelable.Creator<T extends 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 android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method	Description
int	describeContents()
boolean	equals(Object o)
String	getBuildingIdentifier()	Returns identifier of building to which the POI belongs.
CartesianCoordinate	getCartesianCoordinate()	Returns cartesian coordinate of this position, relative to building Bounds).
PoiCategory	getCategory()	Returns category of the POI
Coordinate	getCoordinate()	Return geographical coordinate of this position
String	getFloorIdentifier()	If this POI is outside the building (isOutdoor() == true), this field has no meaning.
String	getInfoHtml()	Returns additional information about POI, in HTML.
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.
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 String getName()

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

getInfoHtml

@NonNull
public String getInfoHtml()

Returns additional information about POI, in HTML.

getCategory

@NonNull
public PoiCategory getCategory()

Returns category of the POI

getBuildingIdentifier

@NonNull
public String getBuildingIdentifier()

Returns identifier of building to which the POI belongs.

Specified by:

getBuildingIdentifier in interface BuildingResource

getFloorIdentifier

@NonNull
public 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.

equals

public boolean equals(Object o)

Overrides:

equals in class Resource

hashCode

public int hashCode()

Overrides:

hashCode in class Resource

toString

public 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