com.amazonaws.mobileconnectors.pinpoint.analytics

Class AnalyticsEvent

java.lang.Object

com.amazonaws.mobileconnectors.pinpoint.analytics.AnalyticsEvent

All Implemented Interfaces:

com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable

public class AnalyticsEvent
extends java.lang.Object
implements com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable

Represents an AnalyticsEvent

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String name, java.lang.String value) Adds an attribute to this AnalyticsEvent with the specified key.
void	addMetric(java.lang.String name, java.lang.Double value) Adds a metric to this AnalyticsEvent with the specified key.
com.amazonaws.mobileconnectors.pinpoint.internal.event.ClientContext	createClientContext(java.lang.String networkType) Creates a ClientContext object
static AnalyticsEvent	createFromEvent(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context, java.lang.String sessionId, long timestamp, AnalyticsEvent copyEvent) Creates a copy of an event with specified parameters
java.util.Map<java.lang.String,java.lang.String>	getAllAttributes() Returns a map of all attributes contained within this AnalyticsEvent
java.util.Map<java.lang.String,java.lang.Double>	getAllMetrics() Returns a map of all metrics contained within this AnalyticsEvent
com.amazonaws.mobileconnectors.pinpoint.internal.core.system.AndroidAppDetails	getAppDetails() Returns the App specific information
java.lang.String	getAttribute(java.lang.String name) Returns the value of the attribute with the specified name.
java.lang.String	getEventId() Returns the eventId
java.lang.Long	getEventTimestamp()
java.lang.String	getEventType() Returns the name/type of this AnalyticsEvent
java.lang.Double	getMetric(java.lang.String name) Returns the value of the metric with the specified name.
java.lang.String	getSdkName()
java.lang.String	getSdkVersion()
PinpointSession	getSession()
java.lang.String	getUniqueId()
boolean	hasAttribute(java.lang.String attributeName) Determines if this AnalyticsEvent contains a specific attribute
boolean	hasMetric(java.lang.String metricName) Determines if this AnalyticsEvent contains a specific metric.
static AnalyticsEvent	newInstance(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context, java.lang.String sessionId, java.lang.Long sessionStart, java.lang.Long sessionEnd, java.lang.Long duration, long timestamp, java.lang.String eventType) Creates a new instance of an AnalyticsEvent
static AnalyticsEvent	newInstance(java.lang.String eventId, java.lang.String eventType, java.util.Map<java.lang.String,java.lang.String> attributes, java.util.Map<java.lang.String,java.lang.Double> metrics, com.amazonaws.mobileconnectors.pinpoint.internal.core.util.SDKInfo sdkInfo, java.lang.String sessionId, java.lang.Long sessionStart, java.lang.Long sessionStop, java.lang.Long sessionDuration, long timestamp, java.lang.String uniqueId, com.amazonaws.mobileconnectors.pinpoint.internal.core.system.AndroidAppDetails appDetails, com.amazonaws.mobileconnectors.pinpoint.internal.core.system.AndroidDeviceDetails deviceDetails) Creates a new instance of an AnalyticsEvent
org.json.JSONObject	toJSONObject()
java.lang.String	toString()
static org.json.JSONObject	translateFromEvent(AnalyticsEvent source) Translates an event to a JSONObject
static AnalyticsEvent	translateToEvent(org.json.JSONObject source) Transforms a JSONObject into an event
AnalyticsEvent	withAttribute(java.lang.String name, java.lang.String value) Adds an attribute to this AnalyticsEvent with the specified key.
AnalyticsEvent	withMetric(java.lang.String name, java.lang.Double value) Adds a metric to this AnalyticsEvent with the specified key.

Methods inherited from class java.lang.Object

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

Method Detail

createFromEvent

public static AnalyticsEvent createFromEvent(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context,
                                             java.lang.String sessionId,
                                             long timestamp,
                                             AnalyticsEvent copyEvent)

Creates a copy of an event with specified parameters

Parameters:

context - The Pinpoint context

sessionId - The SessionId of the new event

timestamp - The timestamp of the new event

copyEvent - The event to be copied

Returns:

An instance of an AnalyticsEvent object

newInstance

public static AnalyticsEvent newInstance(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context,
                                         java.lang.String sessionId,
                                         java.lang.Long sessionStart,
                                         java.lang.Long sessionEnd,
                                         java.lang.Long duration,
                                         long timestamp,
                                         java.lang.String eventType)

Creates a new instance of an AnalyticsEvent

Parameters:

context - The Pinpoint context

sessionId - The SessionId of the new event

sessionStart - The sessionStart of the new event

sessionEnd - The sessionEnd of the new event

duration - The session duration of the new event

timestamp - The timestamp of the new event

eventType - The eventType of the new event

Returns:

An instance of an AnalyticsEvent object

newInstance

public static AnalyticsEvent newInstance(java.lang.String eventId,
                                         java.lang.String eventType,
                                         java.util.Map<java.lang.String,java.lang.String> attributes,
                                         java.util.Map<java.lang.String,java.lang.Double> metrics,
                                         com.amazonaws.mobileconnectors.pinpoint.internal.core.util.SDKInfo sdkInfo,
                                         java.lang.String sessionId,
                                         java.lang.Long sessionStart,
                                         java.lang.Long sessionStop,
                                         java.lang.Long sessionDuration,
                                         long timestamp,
                                         java.lang.String uniqueId,
                                         com.amazonaws.mobileconnectors.pinpoint.internal.core.system.AndroidAppDetails appDetails,
                                         com.amazonaws.mobileconnectors.pinpoint.internal.core.system.AndroidDeviceDetails deviceDetails)

Creates a new instance of an AnalyticsEvent

Parameters:

eventId - The eventId of the new event

eventType - The eventType of the new event

attributes - A list of attributes of the new event

metrics - A list of metrics of the new event

sdkInfo - The SDKInfo of the new event

sessionId - The SessionId of the new event

sessionStart - The sessionStart of the new event

sessionStop - The sessionStop of the new event

sessionDuration - The sessionDuration of the new event

timestamp - The timestamp of the new event

uniqueId - The uniqueId of the new event

appDetails - The AndroidAppDetails of the new event

deviceDetails - The AndroidDeviceDetails of the new event

Returns:

An instance of an AnalyticsEvent object

translateFromEvent

public static org.json.JSONObject translateFromEvent(AnalyticsEvent source)

Translates an event to a JSONObject

Parameters:

source - The event to transform

Returns:

A JSONObject

translateToEvent

public static AnalyticsEvent translateToEvent(org.json.JSONObject source)
                                       throws org.json.JSONException

Transforms a JSONObject into an event

Parameters:

source - The event as a JSONObject

Returns:

An AnalyticsEvent

Throws:

org.json.JSONException

getEventId

public java.lang.String getEventId()

Returns the eventId

Returns:

the eventId

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.String value)

Adds an attribute to this AnalyticsEvent with the specified key. Only 40 attributes/metrics are allowed to be added to an Event. If 40 attribute/metrics already exist on this Event, the call may be ignored.

Parameters:

name - The name of the attribute. The name will be truncated if it exceeds 50 characters.

value - The value of the attribute. The value will be truncated if it exceeds 200 characters.

hasAttribute

public boolean hasAttribute(java.lang.String attributeName)

Determines if this AnalyticsEvent contains a specific attribute

Parameters:

attributeName - The name of the attribute

Returns:

true if this AnalyticsEvent has an attribute with the specified name, false otherwise

addMetric

public void addMetric(java.lang.String name,
                      java.lang.Double value)

Adds a metric to this AnalyticsEvent with the specified key. Only 40 attributes/metrics are allowed to be added to an Event. If 50 attribute/metrics already exist on this Event, the call may be ignored.

Parameters:

name - The name of the metric. The name will be truncated if it exceeds 50 characters.

value - The value of the metric.

hasMetric

public boolean hasMetric(java.lang.String metricName)

Determines if this AnalyticsEvent contains a specific metric.

Parameters:

metricName - The name of the metric

Returns:

true if this AnalyticsEvent has a metric with the specified name, false otherwise

getEventType

public java.lang.String getEventType()

Returns the name/type of this AnalyticsEvent

Returns:

the name/type of this AnalyticsEvent

getAttribute

public java.lang.String getAttribute(java.lang.String name)

Returns the value of the attribute with the specified name.

Parameters:

name - The name of the attribute to return

Returns:

The attribute with the specified name, or null if attribute does not exist

getMetric

public java.lang.Double getMetric(java.lang.String name)

Returns the value of the metric with the specified name.

Parameters:

name - The name of the metric to return

Returns:

The metric with the specified name, or null if metric does not exist

getSession

public PinpointSession getSession()

getEventTimestamp

public java.lang.Long getEventTimestamp()

getUniqueId

public java.lang.String getUniqueId()

getSdkName

public java.lang.String getSdkName()

getSdkVersion

public java.lang.String getSdkVersion()

withAttribute

public AnalyticsEvent withAttribute(java.lang.String name,
                                    java.lang.String value)

Adds an attribute to this AnalyticsEvent with the specified key. Only 40 attributes/metrics are allowed to be added to an AnalyticsEvent. If 40 attribute/metrics already exist on this AnalyticsEvent, the call may be ignored.

Parameters:

name - The name of the attribute. The name will be truncated if it exceeds 50 characters.

value - The value of the attribute. The value will be truncated if it exceeds 200 characters.

Returns:

The same AnalyticsEvent instance is returned to allow for method chaining.

withMetric

public AnalyticsEvent withMetric(java.lang.String name,
                                 java.lang.Double value)

Adds a metric to this AnalyticsEvent with the specified key. Only 40 attributes/metrics are allowed to be added to an AnalyticsEvent. If 40 attribute/metrics already exist on this AnalyticsEvent, the call may be ignored.

Parameters:

name - The name of the metric. The name will be truncated if it exceeds 50 characters.

value - The value of the metric.

Returns:

The same AnalyticsEvent instance is returned to allow for method chaining.

getAllAttributes

public java.util.Map<java.lang.String,java.lang.String> getAllAttributes()

Returns a map of all attributes contained within this AnalyticsEvent

Returns:

a map of all attributes, where the attribute names are the keys and the attribute values are the values

getAllMetrics

public java.util.Map<java.lang.String,java.lang.Double> getAllMetrics()

Returns a map of all metrics contained within this AnalyticsEvent

Returns:

a map of all metrics, where the metric names are the keys and the metric values are the values

getAppDetails

public com.amazonaws.mobileconnectors.pinpoint.internal.core.system.AndroidAppDetails getAppDetails()

Returns the App specific information

Returns:

the App specific information

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toJSONObject

public org.json.JSONObject toJSONObject()

Specified by:

toJSONObject in interface com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable

createClientContext

public com.amazonaws.mobileconnectors.pinpoint.internal.event.ClientContext createClientContext(java.lang.String networkType)

Creates a ClientContext object

Parameters:

networkType - The network type from the Pinpoint Context

Returns:

Returns a ClientContext object