com.dotmarketing.beans
Class Clickstream

java.lang.Object
  com.dotmarketing.beans.Clickstream

All Implemented Interfaces:

java.io.Serializable

public class Clickstream
extends java.lang.Object
implements java.io.Serializable

The actual stream of clicks tracked during a user's navigation through a site.

Author:

Patrick Lightbody

See Also:

Serialized Form

Constructor Summary

Clickstream()

Method Summary

void	addClickstreamRequest(ClickstreamRequest clickstreamRequest)
java.lang.Object	getAttribute(java.lang.String name) Gets an attribute for this clickstream.
java.util.Set	getAttributeNames() Gets the attribute names for this clickstream.
long	getClickstreamId()
java.util.List	getClickstreamRequests()
java.lang.String	getCookieId()
java.lang.String	getHostname() Returns the host name that this clickstream relates to.
java.lang.String	getInitialReferrer() The URL of the initial referer.
java.util.Date	getLastRequest() Returns the last Date that the clickstream was modified.
java.lang.String	getRemoteAddress()
java.util.Date	getStart() Returns the Date when the clickstream began.
java.lang.String	getUserAgent()
java.lang.String	getUserId()
boolean	isBot() Returns the bot status.
void	setAttribute(java.lang.String name, java.lang.Object value) Sets an attribute for this clickstream.
void	setBot(boolean bot)
void	setClickstreamId(long clickstreamId)
void	setClickstreamRequests(java.util.List clickstreamRequests)
void	setCookieId(java.lang.String cookieId)
void	setHostname(java.lang.String hostname)
void	setInitialReferrer(java.lang.String initialReferrer)
void	setLastRequest(java.util.Date lastRequest)
void	setRemoteAddress(java.lang.String remoteAddress)
void	setStart(java.util.Date start)
void	setUserAgent(java.lang.String userAgent)
void	setUserId(java.lang.String userId)

Methods inherited from class java.lang.Object

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

Constructor Detail

Clickstream

public Clickstream()

Method Detail

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Gets an attribute for this clickstream.

Parameters:

name -

getAttributeNames

public java.util.Set getAttributeNames()

Gets the attribute names for this clickstream.

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Sets an attribute for this clickstream.

Parameters:

name -

value -

getHostname

public java.lang.String getHostname()

Returns the host name that this clickstream relates to.

Returns:

the host name that the user clicked through

isBot

public boolean isBot()

Returns the bot status.

Returns:

true if the client is bot or spider

getInitialReferrer

public java.lang.String getInitialReferrer()

The URL of the initial referer. This is useful for determining how the user entered the site.

Returns:

the URL of the initial referer

getStart

public java.util.Date getStart()

Returns the Date when the clickstream began.

Returns:

the Date when the clickstream began

getLastRequest

public java.util.Date getLastRequest()

Returns the last Date that the clickstream was modified.

Returns:

the last Date that the clickstream was modified

getCookieId

public java.lang.String getCookieId()

Returns:

Returns the cookie.

setCookieId

public void setCookieId(java.lang.String cookieId)

Parameters:

cookie - The cookie to set.

getClickstreamId

public long getClickstreamId()

Returns:

Returns the id.

setClickstreamId

public void setClickstreamId(long clickstreamId)

Parameters:

id - The id to set.

getUserId

public java.lang.String getUserId()

Returns:

Returns the userId.

setUserId

public void setUserId(java.lang.String userId)

Parameters:

userId - The userId to set.

setBot

public void setBot(boolean bot)

Parameters:

bot - The bot to set.

setClickstreamRequests

public void setClickstreamRequests(java.util.List clickstreamRequests)

Parameters:

clickstreamRequests - The clickstreamRequests to set.

addClickstreamRequest

public void addClickstreamRequest(ClickstreamRequest clickstreamRequest)

Parameters:

clickstreamRequests - The clickstreamRequests to add.

setHostname

public void setHostname(java.lang.String hostname)

Parameters:

hostname - The hostname to set.

setInitialReferrer

public void setInitialReferrer(java.lang.String initialReferrer)

Parameters:

initialReferrer - The initialReferrer to set.

setLastRequest

public void setLastRequest(java.util.Date lastRequest)

Parameters:

lastRequest - The lastRequest to set.

setStart

public void setStart(java.util.Date start)

Parameters:

start - The start to set.

getClickstreamRequests

public java.util.List getClickstreamRequests()

Returns:

Returns the clickstreamRequests.

getUserAgent

public java.lang.String getUserAgent()

Returns:

Returns the userAgent.

setUserAgent

public void setUserAgent(java.lang.String userAgent)

Parameters:

userAgent - The userAgent to set.

getRemoteAddress

public java.lang.String getRemoteAddress()

Returns:

Returns the remoteAddress.

setRemoteAddress

public void setRemoteAddress(java.lang.String remoteAddress)

Parameters:

remoteAddress - The remoteAddress to set.