org.dspace.app.xmlui.aspect.statisticsElasticSearch
Class ElasticSearchStatsViewer

java.lang.Object
  org.apache.cocoon.util.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.xml.AbstractXMLPipe
              org.apache.cocoon.transformation.AbstractTransformer
                  org.dspace.app.xmlui.wing.AbstractWingTransformer
                      org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer
                          org.dspace.app.xmlui.aspect.statisticsElasticSearch.ElasticSearchStatsViewer

All Implemented Interfaces:

org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.cocoon.sitemap.SitemapModelComponent, org.apache.cocoon.transformation.Transformer, org.apache.cocoon.xml.XMLPipe, org.apache.cocoon.xml.XMLProducer, org.apache.excalibur.xml.sax.XMLConsumer, DSpaceTransformer, WingTransformer, ContentHandler, LexicalHandler

public class ElasticSearchStatsViewer
extends AbstractDSpaceTransformer

Usage Statistics viewer, powered by Elastic Search. Allows for the user to dig deeper into the statistics for topDownloads, topCountries, etc.

Author:

Peter Dietz (pdietz84@gmail.com)

Field Summary

static String	elasticStatisticsPath
protected static org.elasticsearch.search.facet.AbstractFacetBuilder	facetMonthlyDownloads
protected static org.elasticsearch.search.facet.AbstractFacetBuilder	facetTopBitstreamsAllTime
protected static org.elasticsearch.search.facet.AbstractFacetBuilder	facetTopCountries
protected static org.elasticsearch.search.facet.AbstractFacetBuilder	facetTopTypes
protected static org.elasticsearch.search.facet.AbstractFacetBuilder	facetTopUniqueIP
protected static org.elasticsearch.search.facet.AbstractFacetBuilder	facetTopUSCities
protected static org.elasticsearch.index.query.TermFilterBuilder	justOriginals

Fields inherited from class org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

context, contextPath, eperson, knot, objectModel, parameters, servletPath, sitemapURI, url

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.transformation.Transformer

ROLE

Constructor Summary

ElasticSearchStatsViewer()

ElasticSearchStatsViewer(DSpaceObject dso, Date dateStart, Date dateEnd)

Method Summary

void	addBody(Body body) What to add at the end of the body
void	addPageMeta(PageMeta pageMeta) What page metadata to add to the document
org.elasticsearch.client.action.search.SearchRequestBuilder	facetedQueryBuilder(org.elasticsearch.search.facet.AbstractFacetBuilder... facets)
org.elasticsearch.client.action.search.SearchRequestBuilder	facetedQueryBuilder(org.elasticsearch.search.facet.AbstractFacetBuilder facet)
org.elasticsearch.client.action.search.SearchRequestBuilder	facetedQueryBuilder(List<org.elasticsearch.search.facet.AbstractFacetBuilder> facetList)
org.elasticsearch.search.facet.AbstractFacetBuilder	facetTopBitstreamsLastMonth()
String	getLastMonthString()
org.elasticsearch.action.search.SearchResponse	searchResponseToDRI(org.elasticsearch.client.action.search.SearchRequestBuilder searchRequestBuilder)
void	showAllReports()

Methods inherited from class org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

addOptions, addUserMeta, decodeFromURL, dispose, encodeForURL, generateURL, getComponentName, getObjectManager, handleException, recycle, setup

Methods inherited from class org.dspace.app.xmlui.wing.AbstractWingTransformer

createWingDocument, endDocument, endElement, endPrefixMapping, getDefaultMessageCatalogue, message, message, setupWing, startDocument, startElement, startPrefixMapping

Methods inherited from class org.apache.cocoon.xml.AbstractXMLPipe

characters, comment, endCDATA, endDTD, endEntity, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDTD, startEntity

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

characters, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity

Methods inherited from interface org.xml.sax.ext.LexicalHandler

comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

elasticStatisticsPath

public static final String elasticStatisticsPath

See Also:

Constant Field Values

justOriginals

protected static org.elasticsearch.index.query.TermFilterBuilder justOriginals

facetTopCountries

protected static org.elasticsearch.search.facet.AbstractFacetBuilder facetTopCountries

facetMonthlyDownloads

protected static org.elasticsearch.search.facet.AbstractFacetBuilder facetMonthlyDownloads

facetTopBitstreamsAllTime

protected static org.elasticsearch.search.facet.AbstractFacetBuilder facetTopBitstreamsAllTime

facetTopUSCities

protected static org.elasticsearch.search.facet.AbstractFacetBuilder facetTopUSCities

facetTopUniqueIP

protected static org.elasticsearch.search.facet.AbstractFacetBuilder facetTopUniqueIP

facetTopTypes

protected static org.elasticsearch.search.facet.AbstractFacetBuilder facetTopTypes

Constructor Detail

ElasticSearchStatsViewer

public ElasticSearchStatsViewer()

ElasticSearchStatsViewer

public ElasticSearchStatsViewer(DSpaceObject dso,
                                Date dateStart,
                                Date dateEnd)

Method Detail

addPageMeta

public void addPageMeta(PageMeta pageMeta)
                 throws WingException,
                        SQLException

Description copied from class: AbstractDSpaceTransformer

What page metadata to add to the document

Specified by:

addPageMeta in interface DSpaceTransformer

Specified by:

addPageMeta in interface WingTransformer

Overrides:

addPageMeta in class AbstractDSpaceTransformer

Throws:

WingException

SQLException

addBody

public void addBody(Body body)
             throws WingException,
                    SQLException

Description copied from class: AbstractDSpaceTransformer

What to add at the end of the body

Specified by:

addBody in interface DSpaceTransformer

Specified by:

addBody in interface WingTransformer

Overrides:

addBody in class AbstractDSpaceTransformer

Throws:

WingException

SQLException

showAllReports

public void showAllReports()
                    throws WingException,
                           SQLException

Throws:

WingException

SQLException

facetTopBitstreamsLastMonth

public org.elasticsearch.search.facet.AbstractFacetBuilder facetTopBitstreamsLastMonth()

getLastMonthString

public String getLastMonthString()

facetedQueryBuilder

public org.elasticsearch.client.action.search.SearchRequestBuilder facetedQueryBuilder(org.elasticsearch.search.facet.AbstractFacetBuilder facet)
                                                                                throws WingException

Throws:

WingException

facetedQueryBuilder

public org.elasticsearch.client.action.search.SearchRequestBuilder facetedQueryBuilder(org.elasticsearch.search.facet.AbstractFacetBuilder... facets)
                                                                                throws WingException

Throws:

WingException

facetedQueryBuilder

public org.elasticsearch.client.action.search.SearchRequestBuilder facetedQueryBuilder(List<org.elasticsearch.search.facet.AbstractFacetBuilder> facetList)

searchResponseToDRI

public org.elasticsearch.action.search.SearchResponse searchResponseToDRI(org.elasticsearch.client.action.search.SearchRequestBuilder searchRequestBuilder)
                                                                   throws WingException

Throws:

WingException