com.amazonaws.mobileconnectors.amazonmobileanalytics.internal.event

Class EventConstraintDecorator

java.lang.Object

com.amazonaws.mobileconnectors.amazonmobileanalytics.internal.event.EventConstraintDecorator

All Implemented Interfaces:

AnalyticsEvent, JSONSerializable, InternalEvent

public class EventConstraintDecorator
extends java.lang.Object
implements InternalEvent

Constructor Summary

Constructors

Constructor and Description
EventConstraintDecorator(InternalEvent eventToDecorate, int maxAttributesAndMetrics)

Method Summary

Methods

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.
ClientContext	createClientContext(java.lang.String networkType)
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
java.lang.String	getAttribute(java.lang.String name) Returns the value of the attribute with the specified name.
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()
java.lang.Long	getSessionDuration()
java.lang.String	getSessionId()
long	getSessionStart()
java.lang.Long	getSessionStop()
Id	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 EventConstraintDecorator	newInstance(InternalEvent eventToDecorate)
org.json.JSONObject	toJSONObject()
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

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

Constructor Detail

EventConstraintDecorator

public EventConstraintDecorator(InternalEvent eventToDecorate,
                        int maxAttributesAndMetrics)

Method Detail

newInstance

public static EventConstraintDecorator newInstance(InternalEvent eventToDecorate)

addAttribute

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

Description copied from interface: AnalyticsEvent

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.

Specified by:

addAttribute in interface AnalyticsEvent

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)

Description copied from interface: AnalyticsEvent

Determines if this AnalyticsEvent contains a specific attribute

Specified by:

hasAttribute in interface AnalyticsEvent

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)

Description copied from interface: AnalyticsEvent

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.

Specified by:

addMetric in interface AnalyticsEvent

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)

Description copied from interface: AnalyticsEvent

Determines if this AnalyticsEvent contains a specific metric.

Specified by:

hasMetric in interface AnalyticsEvent

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()

Description copied from interface: AnalyticsEvent

Returns the name/type of this AnalyticsEvent

Specified by:

getEventType in interface AnalyticsEvent

Returns:

the name/type of this AnalyticsEvent

getAttribute

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

Description copied from interface: AnalyticsEvent

Returns the value of the attribute with the specified name.

Specified by:

getAttribute in interface AnalyticsEvent

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)

Description copied from interface: AnalyticsEvent

Returns the value of the metric with the specified name.

Specified by:

getMetric in interface AnalyticsEvent

Parameters:

name - The name of the metric to return

Returns:

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

withAttribute

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

Description copied from interface: AnalyticsEvent

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.

Specified by:

withAttribute in interface AnalyticsEvent

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)

Description copied from interface: AnalyticsEvent

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.

Specified by:

withMetric in interface AnalyticsEvent

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()

Description copied from interface: AnalyticsEvent

Returns a map of all attributes contained within this AnalyticsEvent

Specified by:

getAllAttributes in interface 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()

Description copied from interface: AnalyticsEvent

Returns a map of all metrics contained within this AnalyticsEvent

Specified by:

getAllMetrics in interface AnalyticsEvent

Returns:

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

toJSONObject

public org.json.JSONObject toJSONObject()

Specified by:

toJSONObject in interface JSONSerializable

getEventTimestamp

public java.lang.Long getEventTimestamp()

Specified by:

getEventTimestamp in interface InternalEvent

getUniqueId

public Id getUniqueId()

Specified by:

getUniqueId in interface InternalEvent

getSessionId

public java.lang.String getSessionId()

Specified by:

getSessionId in interface InternalEvent

getSessionStart

public long getSessionStart()

Specified by:

getSessionStart in interface InternalEvent

getSessionStop

public java.lang.Long getSessionStop()

Specified by:

getSessionStop in interface InternalEvent

getSessionDuration

public java.lang.Long getSessionDuration()

Specified by:

getSessionDuration in interface InternalEvent

getSdkName

public java.lang.String getSdkName()

Specified by:

getSdkName in interface InternalEvent

getSdkVersion

public java.lang.String getSdkVersion()

Specified by:

getSdkVersion in interface InternalEvent

createClientContext

public ClientContext createClientContext(java.lang.String networkType)

Specified by:

createClientContext in interface InternalEvent