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.
`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.
`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`.
`java.lang.String`	`getType()` The Meridian Placemark type of this placemark.
`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.
`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`	`isFacility()`
`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)` The area on its parent Meridian Map that this placemark represents.
`void`	`setColor(int color)` The shading color of this placemark, this is based on its `type` and should be used to color any UI representing this placemark.
`void`	`setFacility(boolean facility)`
`void`	`setHideOnMap(boolean hideOnMap)` Indicates if the placemark should be visible on its parent Meridian Map.
`void`	`setKey(EditorKey key)` Sets the Meridian EditorKey for this Placemark.
`void`	`setMajor(short major)` If this placemark represents a Beacon this will be the Beacon’s major identifier.
`void`	`setMaxZoomLevel(MapInfo.ZoomLevel maxZoomLevel)` 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 be the Beacon’s minor identifier.
`void`	`setMinZoomLevel(MapInfo.ZoomLevel minZoomLevel)` The minimum zoom level that this placmark should be visible at on its parent Meridian Map.
`void`	`setName(java.lang.String name)` The human readable name of this Placemark (e.g.
`void`	`setRelatedMapKey(EditorKey relatedMapKey)` 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)` The Meridian Placemark type of this placemark.
`void`	`setTypeName(java.lang.String typeName)` The Human readable name of this Meridian Placemark type.
`void`	`setX(float x)` This placemark’s x coordinate on its parent Meridian Map.
`void`	`setY(float y)` This placemark’s y coordinate on its parent Meridian Map.
`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)
```
    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)
```
    The human readable name of this Placemark (e.g. ‘Joe’s Office’, ‘Fountain’)
  - 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)
```
    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)
```
    The Human readable name 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)
```
    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)
```
    This placemark’s y coordinate on its parent Meridian Map.
  - 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)
```
    The shading color of this placemark, this is based on its type and should be used to color any UI representing 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)
```
    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)
```
    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)
```
    Indicates 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 be the Beacon’s major identifier.
  - 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 be 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)
```
    The area on its parent Meridian Map that this placemark represents.
  - isFacility
```
public boolean isFacility()
```
  - setFacility
```
public void setFacility(boolean facility)
```
  - 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)
  - 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
```
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

getType

setType

getTypeName

setTypeName

getUID

getX

setX

getY

setY

getColor

setColor

getMaxZoomLevel

setMaxZoomLevel

getMinZoomLevel

setMinZoomLevel

isHideOnMap

setHideOnMap

getMajor

setMajor

getMinor

setMinor

getArea

setArea

isFacility

setFacility

fromJSONObjectAndAppKey

fromJSONObject

fromClientLocationDataJSON

fromJSONArray

majorMinorString

isInvalid

toString