PHP Class LuceneHandler, ojs

Inheritance: extends Handler

Public Methods

Method	Description
__construct ( $request )	Constructor
_getLucenePlugin ( ) : LucenePlugin	Get the lucene plugin object
authorize ( $request, &$args, $roleAssignments )
pullChangedArticles ( $args, $request ) : JSON	If pull-indexing is enabled then this handler returns article metadata in a formate that can be consumed by the Solr data import handler.
pullIndexingCallback ( $articleXml, $batchCount, $numDeleted ) : integer	Return XML with index changes to the Solr server where it will be stored for later processing.
queryAutocomplete ( $args, $request ) : JSONMessage	AJAX request for search query auto-completion.
usageMetricBoost ( $args, $request )	If the "ranking-by-metric" feature is enabled then this handler returns a file with normalized boost data.

Constructor

public __construct ( $request )
$request		Request

Get the lucene plugin object

public _getLucenePlugin ( ) : LucenePlugin
return	LucenePlugin

public authorize ( $request, &$args, $roleAssignments )

If pull-indexing is enabled then this handler returns article metadata in a formate that can be consumed by the Solr data import handler.

public pullChangedArticles ( $args, $request ) : JSON
$args		array
$request		Request
return	JSON	string

Return XML with index changes to the Solr server where it will be stored for later processing.

public pullIndexingCallback ( $articleXml, $batchCount, $numDeleted ) : integer
$articleXml		string The XML with index changes to be transferred to the Solr server.
$batchCount		integer The number of articles in the XML list (i.e. the expected number of documents to be indexed).
$numDeleted		integer The number of articles in the XML list that are marked for deletion.
return	integer	The number of articles processed.

AJAX request for search query auto-completion.

public queryAutocomplete ( $args, $request ) : JSONMessage
$args		array
$request		Request
return	JSONMessage	JSON object

If the "ranking-by-metric" feature is enabled then this handler returns a file with normalized boost data.

public usageMetricBoost ( $args, $request )
$args		array
$request		Request