com.snowplowanalytics.snowplow.tracker.payload

Class SelfDescribingJson

java.lang.Object

com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson

All Implemented Interfaces:

Payload

public class SelfDescribingJson
extends java.lang.Object
implements Payload

Builds a SelfDescribingJson object. SelfDescribingJson must contain only two fields, schema and data. Schema is the JsonSchema path for this Json. Data is the data.

Constructor Summary

Constructors

Constructor and Description
SelfDescribingJson(java.lang.String schema) Creates a SelfDescribingJson with only a Schema String and an empty data map.
SelfDescribingJson(java.lang.String schema, java.lang.Object data) Creates a SelfDescribingJson with a Schema and a data object.
SelfDescribingJson(java.lang.String schema, SelfDescribingJson data) Creates a SelfDescribingJson with a Schema and a SelfDescribingJson object.
SelfDescribingJson(java.lang.String schema, TrackerPayload data) Creates a SelfDescribingJson with a Schema and a TrackerPayload object.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String key, java.lang.String value) Deprecated.
void	addMap(java.util.Map<java.lang.String,?> map, boolean base64Encoded, java.lang.String typeEncoded, java.lang.String typeNotEncoded) Deprecated.
void	addMap(java.util.Map<java.lang.String,java.lang.String> map) Deprecated.
boolean	equals(java.lang.Object o)
long	getByteSize() Returns the byte size of a payload.
java.util.Map<java.lang.String,java.lang.Object>	getMap() Returns the Payload as a Map.
int	hashCode()
SelfDescribingJson	setData(java.lang.Object data) Adds data to the SelfDescribingJson
SelfDescribingJson	setData(SelfDescribingJson data) Allows us to add data from one SelfDescribingJson into another without copying over the Schema.
SelfDescribingJson	setData(TrackerPayload data) Adds data to the SelfDescribingJson from a TrackerPayload object.
SelfDescribingJson	setSchema(java.lang.String schema) Sets the Schema for the SelfDescribingJson
java.lang.String	toString() Returns the Payload as a string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SelfDescribingJson

public SelfDescribingJson(java.lang.String schema)

Creates a SelfDescribingJson with only a Schema String and an empty data map. Data can be added later using setData() methods.

Parameters:

schema - the schema string

SelfDescribingJson

public SelfDescribingJson(java.lang.String schema,
                          TrackerPayload data)

Creates a SelfDescribingJson with a Schema and a TrackerPayload object. Note that TrackerPayload objects are initialised with an eventId UUID and timestamp (deviceCreatedTimestamp), as they are the basis for sending events. Therefore, your SelfDescribingJson data will contain the keys "eid" and "dtm". This is unlikely to be what you want.

Parameters:

schema - the schema string

data - a TrackerPayload object to be embedded as the data

SelfDescribingJson

public SelfDescribingJson(java.lang.String schema,
                          SelfDescribingJson data)

Creates a SelfDescribingJson with a Schema and a SelfDescribingJson object. This can be used to nest SDJs inside each other.

Parameters:

schema - the schema string

data - a SelfDescribingJson object to be embedded as the data

SelfDescribingJson

public SelfDescribingJson(java.lang.String schema,
                          java.lang.Object data)

Creates a SelfDescribingJson with a Schema and a data object.

Parameters:

schema - the schema string

data - an object to attempt to embed as data

Method Detail

setSchema

public SelfDescribingJson setSchema(java.lang.String schema)

Sets the Schema for the SelfDescribingJson

Parameters:

schema - a valid schema string

Returns:

this SelfDescribingJson

setData

public SelfDescribingJson setData(TrackerPayload data)

Adds data to the SelfDescribingJson from a TrackerPayload object. Note that TrackerPayload objects are initialised with an eventId UUID and timestamp (deviceCreatedTimestamp), as they are the basis for sending events. Therefore, your SelfDescribingJson data will contain the keys "eid" and "dtm". This is unlikely to be what you want.

Parameters:

data - the data to be added to the SelfDescribingJson

Returns:

this SelfDescribingJson

setData

public SelfDescribingJson setData(java.lang.Object data)

Adds data to the SelfDescribingJson

Parameters:

data - the data to be added to the SelfDescribingJson

Returns:

this SelfDescribingJson

setData

public SelfDescribingJson setData(SelfDescribingJson data)

Allows us to add data from one SelfDescribingJson into another without copying over the Schema.

Parameters:

data - the payload to add to the SelfDescribingJson

Returns:

this SelfDescribingJson

add

@Deprecated
public void add(java.lang.String key,
                            java.lang.String value)

Deprecated.

Description copied from interface: Payload

Add a key-value pair to the payload. It checks that neither the key nor value is null or empty.

Specified by:

add in interface Payload

Parameters:

key - The parameter key

value - The parameter value as a String

addMap

@Deprecated
public void addMap(java.util.Map<java.lang.String,java.lang.String> map)

Deprecated.

Description copied from interface: Payload

Add all the mappings from the specified map. The effect is the equivalent to that of calling Payload.add(String, String) for each key value pair.

Specified by:

addMap in interface Payload

Parameters:

map - Key-Value pairs to be stored in this payload

addMap

@Deprecated
public void addMap(java.util.Map<java.lang.String,?> map,
                               boolean base64Encoded,
                               java.lang.String typeEncoded,
                               java.lang.String typeNotEncoded)

Deprecated.

Description copied from interface: Payload

Add a map to the Payload with a key dependent on the base 64 encoding option you choose using the two keys provided.

Specified by:

addMap in interface Payload

Parameters:

map - Map to be converted to a String and stored as a value

base64Encoded - The option you choose to encode the data

typeEncoded - The key that would be set if the encoding option was set to true

typeNotEncoded - They key that would be set if the encoding option was set to false

getMap

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

Returns the Payload as a Map.

Specified by:

getMap in interface Payload

Returns:

A Map of all the key-value entries

getByteSize

public long getByteSize()

Returns the byte size of a payload.

Specified by:

getByteSize in interface Payload

Returns:

A long representing the byte size of the payload.

toString

public java.lang.String toString()

Returns the Payload as a string. This is essentially the toString from the ObjectNode used to store the Payload.

Specified by:

toString in interface Payload

Overrides:

toString in class java.lang.Object

Returns:

A string value of the Payload.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object