com.mappedin.sdk

Class Location

java.lang.Object

com.mappedin.sdk.Navigatable

com.mappedin.sdk.Location

Direct Known Subclasses:

Vortex

public class Location
extends Navigatable

A location is something like a store or washroom on a map. It has a name and type.

A location can also belong to zero or more Categories (Store, Jewelry Store, etc), and will be linked to zero or more Nodes and Polygons.

A location's nodes can be on multiple maps, or in multiple non-adjacent places on the same map. For example, all washrooms at a given venue could belong to one Location, or a department store could live on multiple floors.

A location can have more properties (typically things like description, externalId, logo, etc). To get access, work with your Mappedin developer relations contact to set up any custom location types you need.

Method Summary

Modifier and Type	Method and Description
Category[]	getCategories() A array of venue-specific categories a Location belongs to (ie.
Coordinate[]	getCoordinates() A collection of coordinate attached to this Location.
java.lang.String	getName() Name of the Location
Coordinate[]	getNavigatableCoordinates()
Polygon[]	getPolygons() A collection of polygons attached to this Location.
java.lang.String	getType() Type of Location (Tenant, Restaurant, etc.
Venue	getVenue() Returns the Venue of this Location

Methods inherited from class com.mappedin.sdk.Navigatable

directionsFrom, directionsFrom, directionsTo, directionsTo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Name of the Location

Returns:

String of location name

getType

public java.lang.String getType()

Type of Location (Tenant, Restaurant, etc. Venue specific)

Returns:

String of location type

getVenue

public Venue getVenue()

Returns the Venue of this Location

getCategories

public Category[] getCategories()

A array of venue-specific categories a Location belongs to (ie. Fashion, Men's Fashion)

Returns:

Array of category

getCoordinates

public Coordinate[] getCoordinates()

A collection of coordinate attached to this Location. Most locations might have one coordinate, but depending on the venue there could be several, and they could be non-adjacent or on different maps.

Returns:

Array of Coordinate

getPolygons

public Polygon[] getPolygons()

A collection of polygons attached to this Location. A many-to-many relationship.

Returns:

Array of polygon

getNavigatableCoordinates

public Coordinate[] getNavigatableCoordinates()

Specified by:

getNavigatableCoordinates in class Navigatable