com.esri.core.symbol.advanced
Class MessageHelper

java.lang.Object
  com.esri.core.symbol.advanced.MessageHelper

public class MessageHelper
extends Object

Helper class which provides user-friendly property names and convenient methods to create message.

Since:

1.1

Field Summary

static String	MESSAGE_2525C_CONTROL_POINTS_PROPERTY_NAME The Constant MESSAGE_2525C_CONTROL_POINTS_PROPERTY_NAME.
static String	MESSAGE_ACTION_PROPERTY_NAME The Constant MESSAGE_ACTION_PROPERTY_NAME.
static String	MESSAGE_ACTION_VALUE_REMOVE The Constant MESSAGE_ACTION_VALUE_REMOVE.
static String	MESSAGE_ACTION_VALUE_UPDATE The Constant MESSAGE_ACTION_VALUE_UPDATE.
static String	MESSAGE_ID_PROPERTY_NAME The Constant MESSAGE_ID_PROPERTY_NAME.
static String	MESSAGE_TYPE_PROPERTY_NAME The Constant MESSAGE_TYPE_PROPERTY_NAME.
static String	MESSAGE_WKID_PROPERTY_NAME The Constant MESSAGE_WKID_PROPERTY_NAME.
static String	MESSAGE_WKT_PROPERTY_NAME The Constant MESSAGE_WKT_PROPERTY_NAME.

Constructor Summary

MessageHelper()

Method Summary

static Message	create2525CRemoveMessage(String ID, String messageType) Creates a 2525C message to remove the symbol.
static Message	create2525CUpdateMessage(String ID, Map<String,Object> attributes) Creates a 2525C message to update the symbol with specified properties.
static Message	create2525CUpdateMessage(String ID, String messageType, List<Point> controlPoints, Map<String,Object> attributes) Creates a 2525C message to update the symbol.
static Message	create2525CUpdateMessage(String ID, String messageType, List<Point> controlPoints, Map<String,Object> attributes, int WKID) Creates a 2525C message to create or update the symbol.
static Message	create2525CUpdateMessage(String ID, String messageType, List<Point> controlPoints, Map<String,Object> attributes, String WKT) Creates a 2525C message to create or update the symbol.
static Message	create2525CUpdateMessage(String ID, String propertyName, Object propertyValue) Creates a 2525C message to update the symbol with specified property name and value.

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_ID_PROPERTY_NAME

public static final String MESSAGE_ID_PROPERTY_NAME

The Constant MESSAGE_ID_PROPERTY_NAME.

See Also:

Constant Field Values

MESSAGE_WKID_PROPERTY_NAME

public static final String MESSAGE_WKID_PROPERTY_NAME

The Constant MESSAGE_WKID_PROPERTY_NAME.

See Also:

Constant Field Values

MESSAGE_WKT_PROPERTY_NAME

public static final String MESSAGE_WKT_PROPERTY_NAME

The Constant MESSAGE_WKT_PROPERTY_NAME.

See Also:

Constant Field Values

MESSAGE_ACTION_PROPERTY_NAME

public static final String MESSAGE_ACTION_PROPERTY_NAME

The Constant MESSAGE_ACTION_PROPERTY_NAME.

See Also:

Constant Field Values

MESSAGE_ACTION_VALUE_UPDATE

public static final String MESSAGE_ACTION_VALUE_UPDATE

The Constant MESSAGE_ACTION_VALUE_UPDATE.

See Also:

Constant Field Values

MESSAGE_ACTION_VALUE_REMOVE

public static final String MESSAGE_ACTION_VALUE_REMOVE

The Constant MESSAGE_ACTION_VALUE_REMOVE.

See Also:

Constant Field Values

MESSAGE_TYPE_PROPERTY_NAME

public static final String MESSAGE_TYPE_PROPERTY_NAME

The Constant MESSAGE_TYPE_PROPERTY_NAME.

See Also:

Constant Field Values

MESSAGE_2525C_CONTROL_POINTS_PROPERTY_NAME

public static final String MESSAGE_2525C_CONTROL_POINTS_PROPERTY_NAME

The Constant MESSAGE_2525C_CONTROL_POINTS_PROPERTY_NAME.

See Also:

Constant Field Values

Constructor Detail

MessageHelper

public MessageHelper()

Method Detail

create2525CRemoveMessage

public static Message create2525CRemoveMessage(String ID,
                                               String messageType)

Creates a 2525C message to remove the symbol.

Parameters:

ID - message ID.

messageType - message type.

Returns:

a Message object.

Since:

1.1

create2525CUpdateMessage

public static Message create2525CUpdateMessage(String ID,
                                               String messageType,
                                               List<Point> controlPoints,
                                               Map<String,Object> attributes)

Creates a 2525C message to update the symbol.

Parameters:

ID - message ID.

messageType - message type.

controlPoints - control points.

attributes - attributes map

Returns:

a Message object.

Since:

1.1

create2525CUpdateMessage

public static Message create2525CUpdateMessage(String ID,
                                               String propertyName,
                                               Object propertyValue)

Creates a 2525C message to update the symbol with specified property name and value. It is assumed that a symbol has been created with the same ID when this method is used.

Parameters:

ID - message ID.

propertyName - name of the property to update.

propertyValue - value of the property to update.

Returns:

a Message object.

Since:

1.1

create2525CUpdateMessage

public static Message create2525CUpdateMessage(String ID,
                                               Map<String,Object> attributes)

Creates a 2525C message to update the symbol with specified properties.

Parameters:

ID - message ID.

attributes - attributes as a map.

Returns:

a Message object.

Since:

1.1

create2525CUpdateMessage

public static Message create2525CUpdateMessage(String ID,
                                               String messageType,
                                               List<Point> controlPoints,
                                               Map<String,Object> attributes,
                                               int WKID)

Creates a 2525C message to create or update the symbol. This method is useful for a message aiming to display the symbol very first time.

Parameters:

ID - message ID

messageType - message type as defined in the message type file.

controlPoints - control points.

attributes - attributes as a map

WKID - well-known ID of the spatial reference.

Returns:

a Message object.

Since:

1.1

create2525CUpdateMessage

public static Message create2525CUpdateMessage(String ID,
                                               String messageType,
                                               List<Point> controlPoints,
                                               Map<String,Object> attributes,
                                               String WKT)

Creates a 2525C message to create or update the symbol. This method is useful for a message aiming to display the symbol very first time.

Parameters:

ID - message ID.

messageType - message type as defined in the message type file.

controlPoints - control points.

attributes - attributes as a map.

WKT - well-known text of the spatial reference.

Returns:

a Message object.

Since:

1.1