org.gcube.indexmanagement.common
Interface IndexStatistics

All Known Implementing Classes:

LuceneStatistics

public interface IndexStatistics

Interface for Index Statistic Generating Wrapper Classes.

Method Summary

void	close() Releases reserved resources.
String	createMergedStatistics(List<String> statisticsFileIDs) Creates a new statistics file, and merges additional statistics files into it.
String	createStatistics() Creates a statistics file.
void	openIndex(String baseIndexDir, String indexName) Opens the index for the statistics operation.
void	updateIndex() Updates the index.

Method Detail

openIndex

void openIndex(String baseIndexDir,
               String indexName)
               throws IndexException

Opens the index for the statistics operation.

Parameters:

baseIndexDir - the base index storage directory

indexName - name of the index

Throws:

IndexException - - an error opening the index

updateIndex

void updateIndex()
                 throws IndexException

Updates the index.

Throws:

IndexException - - an error updating the index

createStatistics

String createStatistics()
                        throws IndexException

Creates a statistics file.

Returns:

String CMS ID of the statistics file

Throws:

IndexException - - an error creating statistics

createMergedStatistics

String createMergedStatistics(List<String> statisticsFileIDs)
                              throws IndexException

Creates a new statistics file, and merges additional statistics files into it.

Parameters:

statisticsFileIDs - of identifiers for the statistics to merge into newly created statistics

Returns:

String CMS ID of the merged statistics file

Throws:

IndexException - - an error creating merged statistics

close

void close()
           throws IndexException

Releases reserved resources.

Throws:

IndexException - - an error closing the IndexStatistics isntance