de.innovationgate.webgate.api

Class WGDatabase.SessionStatistic

java.lang.Object

de.innovationgate.webgate.api.WGDatabase.SessionStatistic

All Implemented Interfaces:

java.lang.Comparable

Enclosing class:

WGDatabase

public class WGDatabase.SessionStatistic
extends java.lang.Object
implements java.lang.Comparable

Contains statistics about a WGA session. Session statistics are initially collected in WGSessionContext objects but thrown away with these objects when the session exists. The SessionStatistic object can be used to persist certain intersting statistics beyond the session lifetime.

Constructor Summary

Constructors

Constructor and Description
WGDatabase.SessionStatistic(WGSessionContext context) Constructor that will extract statistics from a session context.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o)
java.util.Date	getCreated() Returns the creation date of the session
java.lang.String	getTask() Returns the task that the session did accomplish
int	getTotalDocsRetrieved() Returns, how many docs the session did retrieve from backend while it was running
boolean	isMaxDocsExceeded() Returns if the "maxdocs"-Property of maximum documents per session was exceeded by this session.

Methods inherited from class java.lang.Object

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

Constructor Detail

WGDatabase.SessionStatistic

public WGDatabase.SessionStatistic(WGSessionContext context)

Constructor that will extract statistics from a session context.

Parameters:

context - The session context that is used for information retrieval

Method Detail

getCreated

public java.util.Date getCreated()

Returns the creation date of the session

isMaxDocsExceeded

public boolean isMaxDocsExceeded()

Returns if the "maxdocs"-Property of maximum documents per session was exceeded by this session. If so, the session did drop it's first retrieved backend documents while processing.

getTask

public java.lang.String getTask()

Returns the task that the session did accomplish

getTotalDocsRetrieved

public int getTotalDocsRetrieved()

Returns, how many docs the session did retrieve from backend while it was running

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable