com.opensymphony.clickstream
Class Clickstream

java.lang.Object
  com.opensymphony.clickstream.Clickstream

All Implemented Interfaces:

Serializable

public class Clickstream

extends Object

implements 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	addRequest(HttpServletRequest request) Adds a new request to the stream of clicks.
Object	getAttribute(String name) Gets an attribute for this clickstream.
Set	getAttributeNames() Gets the attribute names for this clickstream.
String	getHostname() Returns the host name that this clickstream relates to.
String	getInitialReferrer() The URL of the initial referer.
Date	getLastRequest() Returns the last Date that the clickstream was modified.
HttpSession	getSession() Returns the HttpSession associated with this clickstream.
Date	getStart() Returns the Date when the clickstream began.
List	getStream() Returns the actual List of ClickstreamRequest objects.
boolean	isBot() Returns the bot status.
void	setAttribute(String name, Object value) Sets an attribute for this clickstream.

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

addRequest

public void addRequest(HttpServletRequest request)

Adds a new request to the stream of clicks. The HttpServletRequest is converted to a ClickstreamRequest object and added to the clickstream.

Parameters:

request - The serlvet request to be added to the clickstream

getAttribute

public Object getAttribute(String name)

Gets an attribute for this clickstream.

Parameters:

name -

getAttributeNames

public Set getAttributeNames()

Gets the attribute names for this clickstream.

setAttribute

public void setAttribute(String name,
                         Object value)

Sets an attribute for this clickstream.

Parameters:

name -

value -

getHostname

public 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

getSession

public HttpSession getSession()

Returns the HttpSession associated with this clickstream.

Returns:

the HttpSession associated with this clickstream

getInitialReferrer

public 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 Date getStart()

Returns the Date when the clickstream began.

Returns:

the Date when the clickstream began

getLastRequest

public Date getLastRequest()

Returns the last Date that the clickstream was modified.

Returns:

the last Date that the clickstream was modified

getStream

public List getStream()

Returns the actual List of ClickstreamRequest objects.

Returns:

the actual List of ClickstreamRequest objects