com.tealium.collect.visitor

Class VisitorProfile

java.lang.Object

com.tealium.collect.visitor.VisitorProfile

public final class VisitorProfile
extends java.lang.Object

An immutable representation of this visitor's AudienceStream profile.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VisitorProfile.Builder Convenience class useful in creating a VisitorProfile instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Determine whether this instance equals another profile.
static VisitorProfile	fromJSON(java.lang.String json) Creates a VisitorProfile instance from a JSON string.
AttributeGroup<AudienceAttribute>	getAudiences()
AttributeGroup<BadgeAttribute>	getBadges()
long	getCreationTimestamp()
CurrentVisit	getCurrentVisit()
AttributeGroup<DateAttribute>	getDates()
AttributeGroup<FlagAttribute>	getFlags()
AttributeGroup<MetricAttribute>	getMetrics()
AttributeGroup<PropertyAttribute>	getProperties()
java.lang.String	getSource() Get the source that generated this profile (a JSON-formatted string) it may be null.
int	hashCode()
boolean	isNewVisitor()
java.lang.String	toString() Produces a human-readable representation of this visitor profile's values.

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(java.lang.Object o)

Determine whether this instance equals another profile.

Parameters:

o - another profile to compare against.

Returns:

true if this profile equals the given profile.

hashCode

public int hashCode()

toString

public java.lang.String toString()

Produces a human-readable representation of this visitor profile's values.

Overrides:

toString in class java.lang.Object

Returns:

a descriptions of the contents of this visitor profile.

getAudiences

public AttributeGroup<AudienceAttribute> getAudiences()

Returns:

get the Audiences this visitor is a member of.

getBadges

public AttributeGroup<BadgeAttribute> getBadges()

Returns:

get the Badges this visitor holds.

isNewVisitor

public boolean isNewVisitor()

Returns:

whether this visitor is new.

getCurrentVisit

public CurrentVisit getCurrentVisit()

Returns:

information for this current visit.

getSource

public java.lang.String getSource()

Get the source that generated this profile (a JSON-formatted string) it may be null.

fromJSON

public static VisitorProfile fromJSON(java.lang.String json)
                               throws org.json.JSONException

Creates a VisitorProfile instance from a JSON string. If given a malformed json string, a warning will appear in LogCat.

Parameters:

json - a JSON formatted string.

Returns:

VisitorProfile instance if valid JSON was provided. Null if null.

Throws:

org.json.JSONException - if malformed json is provided

getCreationTimestamp

public final long getCreationTimestamp()

Returns:

the creation date.

getFlags

public final AttributeGroup<FlagAttribute> getFlags()

Returns:

the flags associated for this visitor.

getMetrics

public final AttributeGroup<MetricAttribute> getMetrics()

Returns:

the metrics associated for this visitor.

getProperties

public final AttributeGroup<PropertyAttribute> getProperties()

Returns:

the properties (traits) associated for this visitor.

getDates

public final AttributeGroup<DateAttribute> getDates()

Returns:

the dates associated for this visitor.