Package org.dspace.statistics.content

Class StatisticsDataVisits

java.lang.Object

org.dspace.statistics.content.StatisticsData

org.dspace.statistics.content.StatisticsDataVisits

public class StatisticsDataVisits
extends StatisticsData

Query factory associated with a DSpaceObject. Encapsulates the raw data, independent of rendering.

To use:

1. Instantiate, passing a reference to the interesting DSO.
2. Add a DatasetDSpaceObjectGenerator for the appropriate object type.
3. Add other generators as required to get the statistic you want.
4. Add filters as required.
5. createDataset(Context) will run the query and return a result matrix. Subsequent calls skip the query and return the same matrix.

Author:

kevinvandevelde at atmire.com Date: 23-feb-2009 Time: 12:25:20

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StatisticsDataVisits.DatasetQuery
class	StatisticsDataVisits.Query

Field Summary

Fields

Modifier and Type	Field	Description
protected BitstreamService	bitstreamService
protected CollectionService	collectionService
protected CommunityService	communityService
protected DSpaceObject	currentDso	Current DSpaceObject for which to generate the statistics.
protected HandleService	handleService
protected ItemService	itemService
protected SolrLoggerService	solrLoggerService

Constructor Summary

Constructors

Constructor	Description
StatisticsDataVisits()	Construct a completely uninitialized query.
StatisticsDataVisits(DSpaceObject dso)	Construct an empty query concerning a given DSpaceObject.
StatisticsDataVisits(DSpaceObject currentDso, Dataset dataset)	Construct an unconfigured query around a given DSO and Dataset.
StatisticsDataVisits(Dataset dataset)	Construct an unconfigured query around a given Dataset.

Method Summary

Modifier and Type	Method	Description
Dataset	createDataset(Context context)	Run the accumulated query and return its results.
protected Map<String,String>	getAttributes(String value, StatisticsDataVisits.DatasetQuery datasetQuery, Context context)
protected String	getResultName(String value, StatisticsDataVisits.DatasetQuery datasetQuery, Context context)	Gets the name of the DSO (example for collection: ((Collection) dso).getname();
protected void	processAxis(Context context, DatasetGenerator datasetGenerator, List<StatisticsDataVisits.DatasetQuery> queries)
protected ObjectCount[]	queryFacetField(StatisticsDataVisits.DatasetQuery dataset, String query, String filterQuery)

Methods inherited from class org.dspace.statistics.content.StatisticsData

addDatasetGenerator, addFilters, getDataset, getDatasetGenerators, getFilters, setDataset

Methods inherited from class java.lang.Object

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

Field Detail

currentDso

protected DSpaceObject currentDso

Current DSpaceObject for which to generate the statistics.

handleService

protected final HandleService handleService

solrLoggerService

protected final SolrLoggerService solrLoggerService

bitstreamService

protected final BitstreamService bitstreamService

itemService

protected final ItemService itemService

collectionService

protected final CollectionService collectionService

communityService

protected final CommunityService communityService

Constructor Detail

StatisticsDataVisits

public StatisticsDataVisits()

Construct a completely uninitialized query.

StatisticsDataVisits

public StatisticsDataVisits(DSpaceObject dso)

Construct an empty query concerning a given DSpaceObject.

Parameters:

dso - the target DSpace object

StatisticsDataVisits

public StatisticsDataVisits(DSpaceObject currentDso,
                            Dataset dataset)

Construct an unconfigured query around a given DSO and Dataset.

Parameters:

currentDso - the target DSpace object

dataset - the target dataset

StatisticsDataVisits

public StatisticsDataVisits(Dataset dataset)

Construct an unconfigured query around a given Dataset.

Parameters:

dataset - the target dataset

Method Detail

createDataset

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

Description copied from class: StatisticsData

Run the accumulated query and return its results.

Specified by:

createDataset in class StatisticsData

Parameters:

context - The relevant DSpace Context.

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.

ParseException - if the dataset cannot be parsed

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

processAxis

protected void processAxis(Context context,
                           DatasetGenerator datasetGenerator,
                           List<StatisticsDataVisits.DatasetQuery> queries)
                    throws SQLException

Throws:

SQLException

getResultName

protected String getResultName(String value,
                               StatisticsDataVisits.DatasetQuery datasetQuery,
                               Context context)
                        throws SQLException

Gets the name of the DSO (example for collection: ((Collection) dso).getname();

Parameters:

value - UUID (or legacy record ID) of the DSO in question.

datasetQuery - FIXME: PLEASE DOCUMENT.

context - The relevant DSpace Context.

Returns:

the name of the given DSO

Throws:

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

getAttributes

protected Map<String,String> getAttributes(String value,
                                                 StatisticsDataVisits.DatasetQuery datasetQuery,
                                                 Context context)
                                          throws SQLException

Throws:

SQLException

queryFacetField

protected ObjectCount[] queryFacetField(StatisticsDataVisits.DatasetQuery dataset,
                                        String query,
                                        String filterQuery)
                                 throws org.apache.solr.client.solrj.SolrServerException,
                                        IOException

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException