Placemark (Meridian API)

java.lang.Object
- com.arubanetworks.meridian.editor.Placemark

All Implemented Interfaces:

java.io.Serializable
```
public class Placemark
extends java.lang.Object
implements java.io.Serializable
```
Container for a Meridian Placemark and its related fields

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Placemark()
An empty Placemark constructor.

Constructors
Constructor and Description
`Placemark()` An empty Placemark constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Placemark`	`fromClientLocationDataJSON(org.json.JSONObject json, EditorKey appKey)` Static initializer for creating a Placemark from its json representation with extra location data.
`static java.util.List<Placemark>`	`fromJSONArray(org.json.JSONArray json, java.lang.String locationId)` Static initializer for creating an List of Placemarks from its json representation.
`static Placemark`	`fromJSONObject(org.json.JSONObject json, java.lang.String locationId)` Static initializer for creating a Placemark from its json representation.
`static Placemark`	`fromJSONObjectAndAppKey(org.json.JSONObject json, EditorKey appKey)` Static initializer for creating a Placemark from its json representation.
`Polygon`	`getArea()` The area on its parent Meridian Map that this placemark represents.
`int`	`getColor()` The shading color of this placemark, this is based on its `type` and should be used to color any UI representing this placemark.
`android.location.Location`	`getCoordinates()` Gets Location object containing latitude and longitude of the placemark if available.
`java.lang.String`	`getDescription()` The human readable description of this Placemark
`java.lang.String`	`getEmail()` Returns the email address associated with this placemark.
`java.lang.String`	`getImageURL()` Returns an image representing this placemark.
`EditorKey`	`getKey()` Gets the Meridian EditorKey for this Placemark.
`short`	`getMajor()` If this placemark represents a Beacon this will be the Beacon’s major identifier.
`MapInfo.ZoomLevel`	`getMaxZoomLevel()` The maximum zoom level that this placmark should be visible at on its parent Meridian Map.
`short`	`getMinor()` If this placemark represents a Beacon this will be the Beacon’s minor identifier.
`MapInfo.ZoomLevel`	`getMinZoomLevel()` The minimum zoom level that this placmark should be visible at on its parent Meridian Map.
`java.lang.String`	`getName()` The human readable name of this Placemark (e.g.
`java.lang.String`	`getPhone()` Returns the phone number associated with this placemark.
`EditorKey`	`getRelatedMapKey()` The Meridian Key for a Map that this Placemark is connected to, this will not be the same as the parent key of the `key`.
`double`	`getRSSIOffset()` If this placemark represents a Beacon this will be the Beacon’s RSSI offset.
`java.lang.String`	`getType()` The Meridian Placemark type of this placemark.
`java.lang.String`	`getTypeCategory()` Get the human readable type category of this Meridian placemark type.
`java.lang.String`	`getTypeName()` The Human readable name of this Meridian Placemark type.
`java.lang.String`	`getUID()` A unique identifier to link this placemark to objects outside of the Meridian Editor.
`java.lang.String`	`getUrl()` Returns the url associated with this placemark.
`float`	`getX()` This placemark’s x coordinate on its parent Meridian Map.
`float`	`getY()` This placemark’s y coordinate on its parent Meridian Map.
`boolean`	`isDisabled()` Returns true if the placemark is disabled.
`boolean`	`isFacility()` Returns true if the placemark is a facility.
`boolean`	`isHideOnMap()` Indicates if the placemark should be visible on its parent Meridian Map.
`boolean`	`isInvalid()` Returns true if the placemark does not represent a point on a map.
`java.lang.String`	`majorMinorString()` Gets the major/minor of this placemark if it represents a Beacon.
`void`	`setArea(Polygon area)` Set the area on its parent Meridian Map that this placemark represents.
`void`	`setColor(int color)` Sets the shading color of this placemark.
`void`	`setCoordinates(android.location.Location coordinates)` Set this placemark’s coordinates (latitude & longitude).
`void`	`setDescription(java.lang.String description)` Sets the human readable description of this Placemark
`void`	`setDisabled(boolean disabled)` Sets if the placemark is disabled.
`void`	`setEmail(java.lang.String email)` Sets the email address associated with this placemark.
`void`	`setFacility(boolean facility)` Sets if the placemark is a facility.
`void`	`setHideOnMap(boolean hideOnMap)` Sets if the placemark should be visible on its parent Meridian Map.
`void`	`setImageURL(java.lang.String imageURL)` Sets an image representing this placemark.
`void`	`setKey(EditorKey key)` Sets the Meridian EditorKey for this Placemark.
`void`	`setMajor(short major)` If this placemark represents a Beacon this will set the Beacon’s major identifier.
`void`	`setMaxZoomLevel(MapInfo.ZoomLevel maxZoomLevel)` Sets the maximum zoom level that this placmark should be visible at on its parent Meridian Map.
`void`	`setMinor(short minor)` If this placemark represents a Beacon this will set the Beacon’s minor identifier.
`void`	`setMinZoomLevel(MapInfo.ZoomLevel minZoomLevel)` Sets the minimum zoom level that this placmark should be visible at on its parent Meridian Map.
`void`	`setName(java.lang.String name)` Sets the human readable name of this Placemark (e.g.
`void`	`setPhone(java.lang.String phone)` Sets the phone number associated with this placemark.
`void`	`setRelatedMapKey(EditorKey relatedMapKey)` Sets the Meridian Key for a Map that this Placemark is connected to, this will not be the same as the parent key of the `key`.
`void`	`setType(java.lang.String type)` Sets the Meridian Placemark type of this placemark.
`void`	`setTypeCategory(java.lang.String typeCategory)` Sets the human readable type category of this Meridian placemark type.
`void`	`setTypeName(java.lang.String typeName)` Sets the Human readable name of this Meridian Placemark type.
`void`	`setUrl(java.lang.String url)` Sets the url associated with this placemark.
`void`	`setX(float x)` Set this placemark’s x coordinate on its parent Meridian Map.
`void`	`setY(float y)` Set this placemark’s y coordinate on its parent Meridian Map.
`org.json.JSONObject`	`toClientLocationDataJSONObject()` Converts Placemark to its Client Location Data JSON representation data.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Placemark
```
public Placemark()
```
    An empty Placemark constructor.
- Method Detail
  - getKey
```
public EditorKey getKey()
```
    Gets the Meridian EditorKey for this Placemark.
  - setKey
```
public void setKey(EditorKey key)
```
    Sets the Meridian EditorKey for this Placemark.
  - getRelatedMapKey
```
public EditorKey getRelatedMapKey()
```
    The Meridian Key for a Map that this Placemark is connected to, this will not be the same as the parent key of the key.
  - setRelatedMapKey
```
public void setRelatedMapKey(EditorKey relatedMapKey)
```
    Sets the Meridian Key for a Map that this Placemark is connected to, this will not be the same as the parent key of the key.
  - getName
```
public java.lang.String getName()
```
    The human readable name of this Placemark (e.g. ‘Joe’s Office’, ‘Fountain’)
  - setName
```
public void setName(java.lang.String name)
```
    Sets the human readable name of this Placemark (e.g. ‘Joe’s Office’, ‘Fountain’)
  - getDescription
```
public java.lang.String getDescription()
```
    The human readable description of this Placemark
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the human readable description of this Placemark
  - getType
```
public java.lang.String getType()
```
    The Meridian Placemark type of this placemark. (e.g. ‘shop’, ’lounge)
  - setType
```
public void setType(java.lang.String type)
```
    Sets the Meridian Placemark type of this placemark. (e.g. ‘shop’, ’lounge)
  - getTypeName
```
public java.lang.String getTypeName()
```
    The Human readable name of this Meridian Placemark type.
  - setTypeName
```
public void setTypeName(java.lang.String typeName)
```
    Sets the Human readable name of this Meridian Placemark type.
  - getTypeCategory
```
public java.lang.String getTypeCategory()
```
    Get the human readable type category of this Meridian placemark type.
  - setTypeCategory
```
public void setTypeCategory(java.lang.String typeCategory)
```
    Sets the human readable type category of this Meridian placemark type.
  - getUID
```
public java.lang.String getUID()
```
    A unique identifier to link this placemark to objects outside of the Meridian Editor.
  - getX
```
public float getX()
```
    This placemark’s x coordinate on its parent Meridian Map.
  - setX
```
public void setX(float x)
```
    Set this placemark’s x coordinate on its parent Meridian Map.
  - getY
```
public float getY()
```
    This placemark’s y coordinate on its parent Meridian Map.
  - setY
```
public void setY(float y)
```
    Set this placemark’s y coordinate on its parent Meridian Map.
  - getCoordinates
```
public android.location.Location getCoordinates()
```
    Gets Location object containing latitude and longitude of the placemark if available.
  - setCoordinates
```
public void setCoordinates(android.location.Location coordinates)
```
    Set this placemark’s coordinates (latitude & longitude).
  - getColor
```
public int getColor()
```
    The shading color of this placemark, this is based on its type and should be used to color any UI representing this placemark.
  - setColor
```
public void setColor(int color)
```
    Sets the shading color of this placemark.
  - getMaxZoomLevel
```
public MapInfo.ZoomLevel getMaxZoomLevel()
```
    The maximum zoom level that this placmark should be visible at on its parent Meridian Map.
  - setMaxZoomLevel
```
public void setMaxZoomLevel(MapInfo.ZoomLevel maxZoomLevel)
```
    Sets the maximum zoom level that this placmark should be visible at on its parent Meridian Map.
  - getMinZoomLevel
```
public MapInfo.ZoomLevel getMinZoomLevel()
```
    The minimum zoom level that this placmark should be visible at on its parent Meridian Map.
  - setMinZoomLevel
```
public void setMinZoomLevel(MapInfo.ZoomLevel minZoomLevel)
```
    Sets the minimum zoom level that this placmark should be visible at on its parent Meridian Map.
  - isHideOnMap
```
public boolean isHideOnMap()
```
    Indicates if the placemark should be visible on its parent Meridian Map.
  - setHideOnMap
```
public void setHideOnMap(boolean hideOnMap)
```
    Sets if the placemark should be visible on its parent Meridian Map.
  - getMajor
```
public short getMajor()
```
    If this placemark represents a Beacon this will be the Beacon’s major identifier.
  - setMajor
```
public void setMajor(short major)
```
    If this placemark represents a Beacon this will set the Beacon’s major identifier.
  - getRSSIOffset
```
public double getRSSIOffset()
```
    If this placemark represents a Beacon this will be the Beacon’s RSSI offset.
  - getMinor
```
public short getMinor()
```
    If this placemark represents a Beacon this will be the Beacon’s minor identifier.
  - setMinor
```
public void setMinor(short minor)
```
    If this placemark represents a Beacon this will set the Beacon’s minor identifier.
  - getArea
```
public Polygon getArea()
```
    The area on its parent Meridian Map that this placemark represents.
  - setArea
```
public void setArea(Polygon area)
```
    Set the area on its parent Meridian Map that this placemark represents.
  - isFacility
```
public boolean isFacility()
```
    Returns true if the placemark is a facility.
  - setFacility
```
public void setFacility(boolean facility)
```
    Sets if the placemark is a facility.
  - isDisabled
```
public boolean isDisabled()
```
    Returns true if the placemark is disabled.
  - setDisabled
```
public void setDisabled(boolean disabled)
```
    Sets if the placemark is disabled.
  - getImageURL
```
public java.lang.String getImageURL()
```
    Returns an image representing this placemark.
  - setImageURL
```
public void setImageURL(java.lang.String imageURL)
```
    Sets an image representing this placemark.
  - getUrl
```
public java.lang.String getUrl()
```
    Returns the url associated with this placemark.
  - setUrl
```
public void setUrl(java.lang.String url)
```
    Sets the url associated with this placemark.
  - getEmail
```
public java.lang.String getEmail()
```
    Returns the email address associated with this placemark.
  - setEmail
```
public void setEmail(java.lang.String email)
```
    Sets the email address associated with this placemark.
  - getPhone
```
public java.lang.String getPhone()
```
    Returns the phone number associated with this placemark.
  - setPhone
```
public void setPhone(java.lang.String phone)
```
    Sets the phone number associated with this placemark.
  - fromJSONObjectAndAppKey
```
public static Placemark fromJSONObjectAndAppKey(org.json.JSONObject json,
                                                EditorKey appKey)
                                         throws org.json.JSONException
```
    Static initializer for creating a Placemark from its json representation.
    
    Parameters:
    
    json - A known json representation of the Placemark to be initialized.
    
    appKey - A known Meridian App key for the initialized placemark.
    
    Returns:
    
    The initialized Placemark.
    
    Throws:
    
    org.json.JSONException - on JSON parsing error
    
    See Also:
    
    fromJSONArray(org.json.JSONArray, String), fromJSONObject(org.json.JSONObject, String), fromClientLocationDataJSON(org.json.JSONObject, EditorKey)
  - fromJSONObject
```
public static Placemark fromJSONObject(org.json.JSONObject json,
                                       java.lang.String locationId)
                                throws org.json.JSONException
```
    Static initializer for creating a Placemark from its json representation.
    
    Parameters:
    
    json - A known json representation of the Placemark to be initialized.
    
    locationId - A known Meridian location id for the initialized placemark.
    
    Returns:
    
    The initialized Placemark.
    
    Throws:
    
    org.json.JSONException - on JSON parsing error
    
    See Also:
    
    fromJSONArray(org.json.JSONArray, String), fromJSONObjectAndAppKey(org.json.JSONObject, EditorKey), fromClientLocationDataJSON(org.json.JSONObject, EditorKey)
  - fromClientLocationDataJSON
```
public static Placemark fromClientLocationDataJSON(org.json.JSONObject json,
                                                   EditorKey appKey)
                                            throws org.json.JSONException
```
    Static initializer for creating a Placemark from its json representation with extra location data.
    
    Parameters:
    
    json - A known json representation of the Placemark to be initialized.
    
    appKey - A known Meridian App key for the initialized placemark.
    
    Returns:
    
    The initialized Placemark.
    
    Throws:
    
    org.json.JSONException - on JSON parsing error
    
    See Also:
    
    fromJSONArray(org.json.JSONArray, String), fromJSONObject(org.json.JSONObject, String), fromJSONObjectAndAppKey(org.json.JSONObject, EditorKey)
  - toClientLocationDataJSONObject
```
public org.json.JSONObject toClientLocationDataJSONObject()
                                                   throws org.json.JSONException
```
    Converts Placemark to its Client Location Data JSON representation data.
    
    Returns:
    
    The JSON representation.
    
    Throws:
    
    org.json.JSONException - on JSON encoding error
  - fromJSONArray
```
public static java.util.List<Placemark> fromJSONArray(org.json.JSONArray json,
                                                      java.lang.String locationId)
                                               throws org.json.JSONException
```
    Static initializer for creating an List of Placemarks from its json representation.
    
    Parameters:
    
    json - A json representation of the Placemark List.
    
    locationId - A known Meridian location id for the placemarks in the list.
    
    Returns:
    
    An initialized List of Placemarks.
    
    Throws:
    
    org.json.JSONException - on JSON parsing error
    
    See Also:
    
    fromClientLocationDataJSON(org.json.JSONObject, EditorKey), fromJSONObject(org.json.JSONObject, String), fromJSONObjectAndAppKey(org.json.JSONObject, EditorKey)
  - majorMinorString
```
public java.lang.String majorMinorString()
```
    Gets the major/minor of this placemark if it represents a Beacon.
  - isInvalid
```
public boolean isInvalid()
```
    Returns true if the placemark does not represent a point on a map.
  - toString
```
@NonNull
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Placemark

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Placemark

Method Detail

getKey

setKey

getRelatedMapKey

setRelatedMapKey

getName

setName

getDescription

setDescription

getType

setType

getTypeName

setTypeName

getTypeCategory

setTypeCategory

getUID

getX

setX

getY

setY

getCoordinates

setCoordinates

getColor

setColor

getMaxZoomLevel

setMaxZoomLevel

getMinZoomLevel

setMinZoomLevel

isHideOnMap

setHideOnMap

getMajor

setMajor

getRSSIOffset

getMinor

setMinor

getArea

setArea

isFacility

setFacility

isDisabled

setDisabled

getImageURL

setImageURL

getUrl

setUrl

getEmail

setEmail

getPhone

setPhone

fromJSONObjectAndAppKey

fromJSONObject

fromClientLocationDataJSON

toClientLocationDataJSONObject

fromJSONArray

majorMinorString

isInvalid

toString