com.snowplowanalytics.snowplow.tracker.events

Class AbstractEvent

java.lang.Object

com.snowplowanalytics.snowplow.tracker.events.AbstractEvent

All Implemented Interfaces:

Event

Direct Known Subclasses:

EcommerceTransaction, EcommerceTransactionItem, PageView, ScreenView, Structured, Timing, Unstructured

public abstract class AbstractEvent
extends java.lang.Object
implements Event

Base AbstractEvent class which contains common elements to all events: - Custom Context: list of custom contexts or null - Timestamp: user defined event timestamp or 0 - Event Id: a unique id for the event - Subject: a unique Subject for the event

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractEvent.Builder<T extends AbstractEvent.Builder<T>>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<SelfDescribingJson>	context
protected long	deviceCreatedTimestamp
protected java.lang.String	eventId
protected Subject	subject
protected java.lang.Long	trueTimestamp The true timestamp may be null if none is set.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEvent(AbstractEvent.Builder<?> builder)

Method Summary

Modifier and Type	Method and Description
static AbstractEvent.Builder<?>	builder()
java.util.List<SelfDescribingJson>	getContext()
long	getDeviceCreatedTimestamp()
java.lang.String	getEventId()
abstract Payload	getPayload()
Subject	getSubject()
long	getTimestamp() Deprecated. Use getTrueTimestamp() or getDeviceCreatedTimestamp()
java.lang.Long	getTrueTimestamp()
protected TrackerPayload	putDefaultParams(TrackerPayload payload) Adds the default parameters to a TrackerPayload object.

Methods inherited from class java.lang.Object

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

Field Detail

context

protected final java.util.List<SelfDescribingJson> context

deviceCreatedTimestamp

protected long deviceCreatedTimestamp

trueTimestamp

protected java.lang.Long trueTimestamp

The true timestamp may be null if none is set.

eventId

protected final java.lang.String eventId

subject

protected final Subject subject

Constructor Detail

AbstractEvent

protected AbstractEvent(AbstractEvent.Builder<?> builder)

Method Detail

builder

public static AbstractEvent.Builder<?> builder()

getContext

public java.util.List<SelfDescribingJson> getContext()

Specified by:

getContext in interface Event

Returns:

the events custom context

getTimestamp

public long getTimestamp()

Deprecated. Use getTrueTimestamp() or getDeviceCreatedTimestamp()

Specified by:

getTimestamp in interface Event

Returns:

the event's timestamp

getDeviceCreatedTimestamp

public long getDeviceCreatedTimestamp()

Specified by:

getDeviceCreatedTimestamp in interface Event

Returns:

the event's device created timestamp.

getTrueTimestamp

public java.lang.Long getTrueTimestamp()

Specified by:

getTrueTimestamp in interface Event

Returns:

the event's true timestamp.

getEventId

public java.lang.String getEventId()

Specified by:

getEventId in interface Event

Returns:

the event id

getSubject

public Subject getSubject()

Specified by:

getSubject in interface Event

Returns:

the event subject

getPayload

public abstract Payload getPayload()

Specified by:

getPayload in interface Event

Returns:

the event payload

putDefaultParams

protected TrackerPayload putDefaultParams(TrackerPayload payload)

Adds the default parameters to a TrackerPayload object.

Parameters:

payload - the payload to add too.

Returns:

the TrackerPayload with appended values.