eu.dnetlib.functionality.index

Interface IndexServerDAO

All Superinterfaces:

IndexBackendDescriptor

All Known Implementing Classes:

AbstractBackendDescriptor

public interface IndexServerDAO
extends IndexBackendDescriptor

The Interface IndexServerDAO.

Field Summary

Fields inherited from interface eu.dnetlib.functionality.index.IndexBackendDescriptor

ADDRESS, ID, PORT

Method Summary

Modifier and Type	Method and Description
void	createIndexCollection(eu.dnetlib.functionality.index.utils.MetadataReference mdref, String fields) Creates the index collection.
eu.dnetlib.functionality.cql.CqlValueTransformerMap	getCqlValueTransformerMap(eu.dnetlib.functionality.index.utils.MetadataReference mdRef) Gets the cql value transformer map.
DocumentMapperFactory	getDocumentMapperFactory() Gets the document mapper factory.
IndexCollection	getIndexCollection(eu.dnetlib.functionality.index.utils.MetadataReference mdRef) Gets the index collection.
eu.dnetlib.functionality.index.query.IndexQueryFactory	getIndexQueryFactory() Gets the index query factory.
Map<String,eu.dnetlib.functionality.index.model.Any.ValueType>	getSchema(eu.dnetlib.functionality.index.utils.MetadataReference mdRef) Gets the schema.
void	shutdown(eu.dnetlib.functionality.index.utils.MetadataReference mdRef) Shutdown the index server.
void	updateIndexCollection(eu.dnetlib.functionality.index.utils.MetadataReference mdRef, org.dom4j.Document fields) Update index collection.

Methods inherited from interface eu.dnetlib.functionality.index.IndexBackendDescriptor

getBackendId, getEndpoint, getServiceProperties

Method Detail

createIndexCollection

void createIndexCollection(eu.dnetlib.functionality.index.utils.MetadataReference mdref,
                           String fields)
                    throws eu.dnetlib.data.provision.index.rmi.IndexServiceException

Creates the index collection.

Parameters:

mdref - the mdref

fields - the fields

Throws:

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

updateIndexCollection

void updateIndexCollection(eu.dnetlib.functionality.index.utils.MetadataReference mdRef,
                           org.dom4j.Document fields)
                    throws eu.dnetlib.data.provision.index.rmi.IndexServiceException

Update index collection.

Parameters:

mdRef - the md ref

fields - the fields

Throws:

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

getIndexCollection

IndexCollection getIndexCollection(eu.dnetlib.functionality.index.utils.MetadataReference mdRef)
                            throws eu.dnetlib.data.provision.index.rmi.IndexServiceException

Gets the index collection.

Parameters:

mdRef - the md ref

Returns:

the index collection

Throws:

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

getSchema

Map<String,eu.dnetlib.functionality.index.model.Any.ValueType> getSchema(eu.dnetlib.functionality.index.utils.MetadataReference mdRef)
                                                                  throws eu.dnetlib.data.provision.index.rmi.IndexServiceException

Gets the schema.

Parameters:

mdRef - the md ref

Returns:

the schema

Throws:

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

getCqlValueTransformerMap

eu.dnetlib.functionality.cql.CqlValueTransformerMap getCqlValueTransformerMap(eu.dnetlib.functionality.index.utils.MetadataReference mdRef)
                                                                       throws eu.dnetlib.data.provision.index.rmi.IndexServiceException

Gets the cql value transformer map.

Parameters:

mdRef - the md ref

Returns:

the cql value transformer map

Throws:

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

getDocumentMapperFactory

DocumentMapperFactory getDocumentMapperFactory()
                                        throws eu.dnetlib.data.provision.index.rmi.IndexServiceException

Gets the document mapper factory.

Returns:

the document mapper factory

Throws:

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

getIndexQueryFactory

eu.dnetlib.functionality.index.query.IndexQueryFactory getIndexQueryFactory()

Gets the index query factory.

Returns:

the index query factory

shutdown

void shutdown(eu.dnetlib.functionality.index.utils.MetadataReference mdRef)
       throws eu.dnetlib.data.provision.index.rmi.IndexServiceException

Shutdown the index server.

Parameters:

mdRef - the md ref

Throws:

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