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, SelfDescribing, Structured, Timing

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

Base AbstractEvent class which contains elements that can be set in all events. These are context, trueTimestamp, and Subject. Context is a list of custom SelfDescribingJson entities. TrueTimestamp is a user-defined timestamp. Subject is an event-specific Subject. Its fields will override those of the Tracker-associated Subject, if present.

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 Subject	subject
protected java.lang.Long	trueTimestamp The trueTimestamp 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()
abstract Payload	getPayload()
Subject	getSubject()
java.lang.Long	getTrueTimestamp()
protected TrackerPayload	putTrueTimestamp(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

trueTimestamp

protected java.lang.Long trueTimestamp

The trueTimestamp may be null if none is set.

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

getTrueTimestamp

public java.lang.Long getTrueTimestamp()

Specified by:

getTrueTimestamp in interface Event

Returns:

the event's true timestamp.

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

putTrueTimestamp

protected TrackerPayload putTrueTimestamp(TrackerPayload payload)

Adds the default parameters to a TrackerPayload object.

Parameters:

payload - the payload to add to.

Returns:

the TrackerPayload with appended values.