Package com.arubanetworks.meridian.editor

Class Placemark

java.lang.Object
com.arubanetworks.meridian.editor.Placemark
All Implemented Interfaces:
Serializable
public class Placemark extends Object implements Serializable
Container for a Meridian Placemark and its related fields
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    LAYOUT_FULL_PAGE
     
    static final String
    LAYOUT_WIDESCREEN
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Placemark()
    An empty Placemark constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Placemark
    fromClientLocationDataJSON(JSONObject json, EditorKey appKey)
    Static initializer for creating a Placemark from its json representation with extra location data.
    static List<Placemark>
    fromJSONArray(JSONArray json, String locationId)
    Static initializer for creating an List of Placemarks from its json representation.
    static Placemark
    fromJSONObject(JSONObject json, String locationId)
    Static initializer for creating a Placemark from its json representation.
    static Placemark
    fromJSONObjectAndAppKey(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.
    Location
    getCoordinates()
    Gets Location object containing latitude and longitude of the placemark if available.
    String
    getCustom1()
    Returns the first custom field associated with this placemark.
    String
    getCustom2()
    Returns the second custom field associated with this placemark.
    String
    getCustom3()
    Returns the third custom field associated with this placemark.
    String
    getCustom4()
    Returns the fourth custom field associated with this placemark.
    String
    getDescription()
    The human readable description of this Placemark
    String
    getEmail()
    Returns the email address associated with this placemark.
    String
    getImageLayout()
     
    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.
    String
    getName()
    The human readable name of this Placemark (e.g.
    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.
    String
    getType()
    The Meridian Placemark type of this placemark.
    String
    getTypeCategory()
    Get the human readable type category of this Meridian placemark type.
    String
    getTypeName()
    The Human readable name of this Meridian Placemark type.
    String
    getUID()
    A unique identifier to link this placemark to objects outside of the Meridian Editor.
    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.
    boolean
    isSearchable()
    Indicates if the placemark should be returned in search results.
    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(Location coordinates)
    Set this placemark’s coordinates (latitude & longitude).
    void
    setCustom1(String custom1)
    Sets the first custom field associated with this placemark.
    void
    setCustom2(String custom2)
    Sets the second custom field associated with this placemark.
    void
    setCustom3(String custom3)
    Sets the third custom field associated with this placemark.
    void
    setCustom4(String custom4)
    Sets the fourth custom field associated with this placemark.
    void
    setDescription(String description)
    Sets the human readable description of this Placemark
    void
    setDisabled(boolean disabled)
    Sets if the placemark is disabled.
    void
    setEmail(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
    setImageLayout(String imageLayout)
     
    void
    setImageURL(String imageURL)
    Sets an image representing this placemark.
    void
    setIsSearchable(boolean isSearchable)
    Sets if the placemark should be returned in search results.
    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(String name)
    Sets the human readable name of this Placemark (e.g.
    void
    setPhone(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(String type)
    Sets the Meridian Placemark type of this placemark.
    void
    setTypeCategory(String typeCategory)
    Sets the human readable type category of this Meridian placemark type.
    void
    setTypeName(String typeName)
    Sets the Human readable name of this Meridian Placemark type.
    void
    setUrl(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.
    JSONObject
    toClientLocationDataJSONObject()
    Converts Placemark to its Client Location Data JSON representation data.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • Placemark

      public Placemark()
      An empty Placemark constructor.

  • Method Details

    • 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 String getName()
      The human readable name of this Placemark (e.g.

      ‘Joe’s Office’, ‘Fountain’)

    • setName

      public void setName(String name)
      Sets the human readable name of this Placemark (e.g.

      ‘Joe’s Office’, ‘Fountain’)

    • getDescription

      public String getDescription()
      The human readable description of this Placemark

    • setDescription

      public void setDescription(String description)
      Sets the human readable description of this Placemark

    • getType

      public String getType()
      The Meridian Placemark type of this placemark.

      (e.g. ‘shop’, ’lounge)

    • setType

      public void setType(String type)
      Sets the Meridian Placemark type of this placemark.

      (e.g. ‘shop’, ’lounge)

    • getTypeName

      public String getTypeName()
      The Human readable name of this Meridian Placemark type.

    • setTypeName

      public void setTypeName(String typeName)
      Sets the Human readable name of this Meridian Placemark type.

    • getTypeCategory

      public String getTypeCategory()
      Get the human readable type category of this Meridian placemark type.

    • setTypeCategory

      public void setTypeCategory(String typeCategory)
      Sets the human readable type category of this Meridian placemark type.

    • getUID

      public 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 Location getCoordinates()
      Gets Location object containing latitude and longitude of the placemark if available.

    • setCoordinates

      public void setCoordinates(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.

    • isSearchable

      public boolean isSearchable()
      Indicates if the placemark should be returned in search results.

    • setIsSearchable

      public void setIsSearchable(boolean isSearchable)
      Sets if the placemark should be returned in search results.

    • 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 String getImageURL()
      Returns an image representing this placemark.

    • setImageURL

      public void setImageURL(String imageURL)
      Sets an image representing this placemark.

    • getImageLayout

      public String getImageLayout()

    • setImageLayout

      public void setImageLayout(String imageLayout)

    • getUrl

      public String getUrl()
      Returns the url associated with this placemark.

    • setUrl

      public void setUrl(String url)
      Sets the url associated with this placemark.

    • getEmail

      public String getEmail()
      Returns the email address associated with this placemark.

    • setEmail

      public void setEmail(String email)
      Sets the email address associated with this placemark.

    • getPhone

      public String getPhone()
      Returns the phone number associated with this placemark.

    • setPhone

      public void setPhone(String phone)
      Sets the phone number associated with this placemark.

    • getCustom1

      public String getCustom1()
      Returns the first custom field associated with this placemark.

    • setCustom1

      public void setCustom1(String custom1)
      Sets the first custom field associated with this placemark.

    • getCustom2

      public String getCustom2()
      Returns the second custom field associated with this placemark.

    • setCustom2

      public void setCustom2(String custom2)
      Sets the second custom field associated with this placemark.

    • getCustom3

      public String getCustom3()
      Returns the third custom field associated with this placemark.

    • setCustom3

      public void setCustom3(String custom3)
      Sets the third custom field associated with this placemark.

    • getCustom4

      public String getCustom4()
      Returns the fourth custom field associated with this placemark.

    • setCustom4

      public void setCustom4(String custom4)
      Sets the fourth custom field associated with this placemark.

    • fromJSONObjectAndAppKey

      public static Placemark fromJSONObjectAndAppKey(JSONObject json, EditorKey appKey) throws 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:
      JSONException - on JSON parsing error
      See Also:

    • fromJSONObject

      public static Placemark fromJSONObject(JSONObject json, String locationId) throws 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:
      JSONException - on JSON parsing error
      See Also:

    • fromClientLocationDataJSON

      public static Placemark fromClientLocationDataJSON(JSONObject json, EditorKey appKey) throws 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:
      JSONException - on JSON parsing error
      See Also:

    • toClientLocationDataJSONObject

      public JSONObject toClientLocationDataJSONObject() throws JSONException
      Converts Placemark to its Client Location Data JSON representation data.
      Returns:
      The JSON representation.
      Throws:
      JSONException - on JSON encoding error

    • fromJSONArray

      public static List<Placemark> fromJSONArray(JSONArray json, String locationId) throws 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:
      JSONException - on JSON parsing error
      See Also:

    • majorMinorString

      public 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 String toString()
      Overrides:
      toString in class Object