Package com.funnelback.publicui.search.model.log

Class InteractionLog

java.lang.Object

com.funnelback.publicui.search.model.log.Log

com.funnelback.publicui.search.model.log.InteractionLog

public class InteractionLog
extends Log

User interaction (query completion) log

Field Summary

Fields

Modifier and Type	Field	Description
static org.apache.commons.lang3.time.FastDateFormat	DATE_FORMAT	Date format used in the logs
private java.lang.String	logType	Type of log, unconstrained to permit future types
private java.util.Map<java.lang.String,java.lang.String[]>	parameters	Log event parameters
private java.net.URL	referer	URL of the search page where the interaction occurred

Fields inherited from class com.funnelback.publicui.search.model.log.Log

collection, date, profile, REQUEST_ID_NOTHING, requestId, USER_ID_NOTHING, userId, XML_DATE_FORMAT

Constructor Summary

Constructors

Constructor	Description
InteractionLog(java.util.Date date, Collection collection, Profile profile, java.lang.String requestId, java.lang.String logType, java.net.URL referer, java.util.Map<java.lang.String,java.lang.String[]> parameters, java.lang.String userId)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getLogType()	Type of log, unconstrained to permit future types
java.util.Map<java.lang.String,java.lang.String[]>	getParameters()	Log event parameters
java.net.URL	getReferer()	URL of the search page where the interaction occurred
java.lang.String	toString()

Methods inherited from class com.funnelback.publicui.search.model.log.Log

getCollection, getDate, getProfile, getRequestId, getUserId

Methods inherited from class java.lang.Object

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

Field Detail

DATE_FORMAT

public static final org.apache.commons.lang3.time.FastDateFormat DATE_FORMAT

Date format used in the logs

logType

private final java.lang.String logType

Type of log, unconstrained to permit future types

referer

private final java.net.URL referer

URL of the search page where the interaction occurred

parameters

private final java.util.Map<java.lang.String,java.lang.String[]> parameters

Log event parameters

Constructor Detail

InteractionLog

public InteractionLog(java.util.Date date,
                      Collection collection,
                      Profile profile,
                      java.lang.String requestId,
                      java.lang.String logType,
                      java.net.URL referer,
                      java.util.Map<java.lang.String,java.lang.String[]> parameters,
                      java.lang.String userId)

Parameters:

date - Date of the event

collection - Collection

profile - Profile

requestId - Request identifier (IP, hash, '-')

logType - Type of log

referer - URL of the search page

parameters - log event parameters

userId - User identifier, may be null

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLogType

public java.lang.String getLogType()

Type of log, unconstrained to permit future types

getReferer

public java.net.URL getReferer()

URL of the search page where the interaction occurred

getParameters

public java.util.Map<java.lang.String,java.lang.String[]> getParameters()

Log event parameters