eu.dnetlib.functionality.index

Interface IndexCollection

public interface IndexCollection

The Interface IndexCollection.

Method Summary

Modifier and Type	Method and Description
boolean	add(eu.dnetlib.functionality.index.model.document.IndexDocument doc) Adds an input Document to the index.
boolean	addAll(Collection<eu.dnetlib.functionality.index.model.document.IndexDocument> docs) Adds the all.
boolean	addAll(Iterator<eu.dnetlib.functionality.index.model.document.IndexDocument> docs) Adds all the documents to the index giving an iterator of input documents.
boolean	commit() Commit the data.
boolean	deleteByQuery(String query, String dsId) Delete data from the index by query.
boolean	deleteIndex(String dsId) Delete index.
void	shutdown() Releases resources and closes connections.

Method Detail

add

boolean add(eu.dnetlib.functionality.index.model.document.IndexDocument doc)
     throws eu.dnetlib.data.provision.index.rmi.IndexServiceException

Adds an input Document to the index.

Parameters:

doc - the doc

Returns:

the solr update response

Throws:

eu.dnetlib.data.provision.index.rmi.IndexServiceException - the index service exception

addAll

boolean addAll(Iterator<eu.dnetlib.functionality.index.model.document.IndexDocument> docs)
        throws eu.dnetlib.data.provision.index.rmi.IndexServiceException

Adds all the documents to the index giving an iterator of input documents.

Parameters:

docs - the iterator of input documents

Returns:

the solr update response

Throws:

eu.dnetlib.data.provision.index.rmi.IndexServiceException - the index service exception

addAll

boolean addAll(Collection<eu.dnetlib.functionality.index.model.document.IndexDocument> docs)
        throws eu.dnetlib.data.provision.index.rmi.IndexServiceException

Adds the all.

Parameters:

docs - the docs

Returns:

the update response

Throws:

eu.dnetlib.data.provision.index.rmi.IndexServiceException - the index service exception

deleteIndex

boolean deleteIndex(String dsId)
             throws eu.dnetlib.data.provision.index.rmi.IndexServiceException

Delete index.

Parameters:

dsId - the ds id

Returns:

true, if successful

Throws:

eu.dnetlib.data.provision.index.rmi.IndexServiceException - the index service exception

deleteByQuery

boolean deleteByQuery(String query,
                      String dsId)
               throws eu.dnetlib.data.provision.index.rmi.IndexServiceException

Delete data from the index by query.

Parameters:

query - the query

dsId - the ds id

Returns:

true, if successful

Throws:

eu.dnetlib.data.provision.index.rmi.IndexServiceException - the index service exception

commit

boolean commit()
        throws eu.dnetlib.data.provision.index.rmi.IndexServiceException

Commit the data.

Returns:

true, if successful

Throws:

eu.dnetlib.data.provision.index.rmi.IndexServiceException - the index service exception

shutdown

void shutdown()

Releases resources and closes connections.