Package org.dspace.statistics.content

Class StatisticsData

java.lang.Object

org.dspace.statistics.content.StatisticsData

Direct Known Subclasses:

StatisticsDataSearches, StatisticsDataVisits, StatisticsDataWorkflow

public abstract class StatisticsData
extends Object

Abstract "factory" for statistical queries.

Author:

kevinvandevelde at atmire.com Date: 23-feb-2009 Time: 12:37:04

Field Summary

Fields

Modifier and Type	Field	Description
protected SolrLoggerService	solrLoggerService

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StatisticsData()	Construct a blank query factory.
protected	StatisticsData(Dataset dataset)	Wrap an existing Dataset in an unconfigured query factory.

Method Summary

Modifier and Type	Method	Description
void	addDatasetGenerator(DatasetGenerator set)	Augment the list of facets (generators).
void	addFilters(StatisticsFilter filter)	Augment the list of filters.
abstract Dataset	createDataset(Context context, int facetMinCount)	Run the accumulated query and return its results.
Dataset	getDataset()	Return the existing query result if there is one.
List<DatasetGenerator>	getDatasetGenerators()	Return the current list of generators.
List<StatisticsFilter>	getFilters()	Return the current list of filters.
void	setDataset(Dataset dataset)	Jam an existing query result in.

Methods inherited from class java.lang.Object

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

Field Detail

solrLoggerService

protected final SolrLoggerService solrLoggerService

Constructor Detail

StatisticsData

protected StatisticsData()

Construct a blank query factory.

StatisticsData

protected StatisticsData(Dataset dataset)

Wrap an existing Dataset in an unconfigured query factory.

Parameters:

dataset - statistics dataset

Method Detail

addDatasetGenerator

public void addDatasetGenerator(DatasetGenerator set)

Augment the list of facets (generators).

Parameters:

set - generator of statistics datasets

addFilters

public void addFilters(StatisticsFilter filter)

Augment the list of filters.

Parameters:

filter - statistics filter

getDatasetGenerators

public List<DatasetGenerator> getDatasetGenerators()

Return the current list of generators.

Returns:

list of dataset generators

getFilters

public List<StatisticsFilter> getFilters()

Return the current list of filters.

Returns:

list of dataset filters

getDataset

public Dataset getDataset()

Return the existing query result if there is one.

Returns:

dataset existing query result dataset

setDataset

public void setDataset(Dataset dataset)

Jam an existing query result in.

Parameters:

dataset - statistics dataset

createDataset

public abstract Dataset createDataset(Context context,
                                      int facetMinCount)
                               throws SQLException,
                                      org.apache.solr.client.solrj.SolrServerException,
                                      IOException,
                                      ParseException

Run the accumulated query and return its results.

Parameters:

context - The relevant DSpace Context.

facetMinCount - Minimum count of results facet must have to return a result

Returns:

accumulated query results

Throws:

SQLException - An exception that provides information on a database access error or other errors.

org.apache.solr.client.solrj.SolrServerException - Exception from the Solr server to the solrj Java client.

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

ParseException - if the dataset cannot be parsed