com.snowplowanalytics.snowplow.tracker

Class Subject

java.lang.Object

com.snowplowanalytics.snowplow.tracker.Subject

public class Subject
extends java.lang.Object

An object for managing extra event decoration. All the properties are optional. However, the timezone is set by default, to that of the server.

Constructor Summary

Constructors

Constructor and Description
Subject() Creates a Subject instance with default configuration (only the timezone is set).
Subject(Subject subject) Creates a new Subject object based on the map of another Subject object.
Subject(SubjectConfiguration subjectConfig) Creates a Subject instance from a SubjectConfiguration.

Method Summary

Modifier and Type	Method and Description
Subject	colorDepth(int depth) Sets the color depth parameter and returns itself
Subject	domainSessionId(java.lang.String domainSessionId) Sets the user inputted Domain Session ID for the subject and returns itself
Subject	domainUserId(java.lang.String domainUserId) Sets the user inputted Domain User Id for the subject and returns itself
java.util.Map<java.lang.String,java.lang.String>	getSubject() Gets the Subject pairs.
Subject	ipAddress(java.lang.String ipAddress) Sets the user inputted ip address for the subject and returns itself
Subject	language(java.lang.String language) Sets the language parameter and returns itself
Subject	networkUserId(java.lang.String networkUserId) Sets the user inputted Network User ID for the subject and returns itself.
Subject	screenResolution(int width, int height) Sets the screen res parameter and returns itself
void	setColorDepth(int depth) Sets the color depth parameter
void	setDomainSessionId(java.lang.String domainSessionId) User inputted Domain Session ID for the subject.
void	setDomainUserId(java.lang.String domainUserId) User inputted Domain User Id for the subject.
void	setIpAddress(java.lang.String ipAddress) User inputted ip address for the subject.
void	setLanguage(java.lang.String language) Sets the language parameter
void	setNetworkUserId(java.lang.String networkUserId) User inputted Network User ID for the subject.
void	setScreenResolution(int width, int height) Sets the screen res parameter
void	setTimezone(java.lang.String timezone) Sets the timezone parameter.
void	setUseragent(java.lang.String useragent) User inputted useragent for the subject.
void	setUserId(java.lang.String userId) Sets the User ID
void	setViewPort(int width, int height) Sets the view port parameter
Subject	timezone(java.lang.String timezone) Sets the timezone parameter and returns itself.
Subject	useragent(java.lang.String useragent) Sets the user inputted useragent for the subject and returns itself
Subject	userId(java.lang.String userId) Sets the User ID and returns itself
Subject	viewPort(int width, int height) Sets the view port parameter and returns itself

Methods inherited from class java.lang.Object

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

Constructor Detail

Subject

public Subject(SubjectConfiguration subjectConfig)

Creates a Subject instance from a SubjectConfiguration.

Parameters:

subjectConfig - a SubjectConfiguration

Subject

public Subject()

Creates a Subject instance with default configuration (only the timezone is set).

Subject

public Subject(Subject subject)

Creates a new Subject object based on the map of another Subject object.

Parameters:

subject - The subject from which the map is copied.

Method Detail

setUserId

public void setUserId(java.lang.String userId)

Sets the User ID

Parameters:

userId - a user id string

userId

public Subject userId(java.lang.String userId)

Sets the User ID and returns itself

Parameters:

userId - a user id string

Returns:

itself

setScreenResolution

public void setScreenResolution(int width,
                                int height)

Sets the screen res parameter

Parameters:

width - a width integer

height - a height integer

screenResolution

public Subject screenResolution(int width,
                                int height)

Sets the screen res parameter and returns itself

Parameters:

width - a width integer

height - a height integer

Returns:

itself

setViewPort

public void setViewPort(int width,
                        int height)

Sets the view port parameter

Parameters:

width - a width integer

height - a height integer

viewPort

public Subject viewPort(int width,
                        int height)

Sets the view port parameter and returns itself

Parameters:

width - a width integer

height - a height integer

Returns:

itself

setColorDepth

public void setColorDepth(int depth)

Sets the color depth parameter

Parameters:

depth - a color depth integer

colorDepth

public Subject colorDepth(int depth)

Sets the color depth parameter and returns itself

Parameters:

depth - a color depth integer

Returns:

itself

setTimezone

public void setTimezone(java.lang.String timezone)

Sets the timezone parameter. Note that timezone is set by default to the server's timezone (`TimeZone tz = Calendar.getInstance().getTimeZone().getID()`);

Parameters:

timezone - a timezone string

timezone

public Subject timezone(java.lang.String timezone)

Sets the timezone parameter and returns itself. Note that timezone is set by default to the server's timezone (`TimeZone tz = Calendar.getInstance().getTimeZone().getID()`)

Parameters:

timezone - a timezone string

Returns:

itself

setLanguage

public void setLanguage(java.lang.String language)

Sets the language parameter

Parameters:

language - a language string

language

public Subject language(java.lang.String language)

Sets the language parameter and returns itself

Parameters:

language - a language string

Returns:

itself

setIpAddress

public void setIpAddress(java.lang.String ipAddress)

User inputted ip address for the subject.

Parameters:

ipAddress - an ip address

ipAddress

public Subject ipAddress(java.lang.String ipAddress)

Sets the user inputted ip address for the subject and returns itself

Parameters:

ipAddress - a ipAddress string

Returns:

itself

setUseragent

public void setUseragent(java.lang.String useragent)

User inputted useragent for the subject.

Parameters:

useragent - a useragent

useragent

public Subject useragent(java.lang.String useragent)

Sets the user inputted useragent for the subject and returns itself

Parameters:

useragent - a useragent string

Returns:

itself

setDomainUserId

public void setDomainUserId(java.lang.String domainUserId)

User inputted Domain User Id for the subject.

Parameters:

domainUserId - a domain user id

domainUserId

public Subject domainUserId(java.lang.String domainUserId)

Sets the user inputted Domain User Id for the subject and returns itself

Parameters:

domainUserId - a domainUserId string

Returns:

itself

setDomainSessionId

public void setDomainSessionId(java.lang.String domainSessionId)

User inputted Domain Session ID for the subject.

Parameters:

domainSessionId - a domain session id

domainSessionId

public Subject domainSessionId(java.lang.String domainSessionId)

Sets the user inputted Domain Session ID for the subject and returns itself

Parameters:

domainSessionId - a domainSessionId string

Returns:

itself

setNetworkUserId

public void setNetworkUserId(java.lang.String networkUserId)

User inputted Network User ID for the subject. This overrides the network user ID set by the Collector in response Cookies.

Parameters:

networkUserId - a network user id

networkUserId

public Subject networkUserId(java.lang.String networkUserId)

Sets the user inputted Network User ID for the subject and returns itself. This overrides the network user ID set by the Collector in response Cookies.

Parameters:

networkUserId - a networkUserId string

Returns:

itself

getSubject

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

Gets the Subject pairs.

Returns:

the stored k-v pairs