eu.dnetlib.data.oai.store

Interface PublisherStore<T extends Cursor>

Type Parameters:

T - class of the object that can be used to iterate results of a bulk request of records from the store.

All Known Implementing Classes:

MongoPublisherStore

public interface PublisherStore<T extends Cursor>

Interface for store used by the publisher. Different back-ends require different implementation.

Author:

alessia

Method Summary

Modifier and Type	Method and Description
int	count() Counts the number of records in this store.
int	count(String queryString) Counts the number of records in this store matching the query.
void	drop() Drops the content of the store.
void	drop(String queryString) Drops the elements matching the query from the store.
void	ensureIndices() Ensures the indices on this store.
int	feed(Iterable<String> records, String source) Feeds the store with the given records.
String	getId() Returns the identifier of this store.
List<eu.dnetlib.data.information.oai.publisher.PublisherField>	getIndices() Gets informaton about the indices available on this store.
String	getInterpretation() Gets the interpretation of this store.
String	getLayout() Gets the layout of this store.
String	getMetadataFormat() Gets the metadata format of this store.
eu.dnetlib.data.information.oai.publisher.info.RecordInfo	getRecord(String recordId) Retrieves the record with the given identifier from this store.
eu.dnetlib.data.information.oai.publisher.info.RecordInfo	getRecord(String recordId, eu.dnetlib.miscutils.functional.UnaryFunction<String,String> unaryFunction) Retrieves the record with the given identifier from this store and apply the given unary function before delivering.
T	getRecords(String queryString, boolean bodyIncluded, int limit) Retrieves the records matching the given query string.
T	getRecords(String queryString, eu.dnetlib.miscutils.functional.UnaryFunction<String,String> unaryFunction, boolean bodyIncluded, int limit) Retrieves the records matching the given query string and apply the given unary function before delivering.

Method Detail

getId

String getId()

Returns the identifier of this store.

Returns:

a String that identifies this store

getMetadataFormat

String getMetadataFormat()

Gets the metadata format of this store.

Returns:

String

getInterpretation

String getInterpretation()

Gets the interpretation of this store.

Returns:

String

getLayout

String getLayout()

Gets the layout of this store.

Returns:

String

getRecord

eu.dnetlib.data.information.oai.publisher.info.RecordInfo getRecord(String recordId)

Retrieves the record with the given identifier from this store.

Parameters:

recordId - identifier of the record to retrieve

Returns:

a RecordInfo instance representing the XML record

getRecord

eu.dnetlib.data.information.oai.publisher.info.RecordInfo getRecord(String recordId,
                                                                    eu.dnetlib.miscutils.functional.UnaryFunction<String,String> unaryFunction)

Retrieves the record with the given identifier from this store and apply the given unary function before delivering.

Parameters:

recordId - identifier of the record to retrieve

unaryFunction - mapping from String to String

Returns:

a RecordInfo instance representing the XML record

getRecords

T getRecords(String queryString,
             boolean bodyIncluded,
             int limit)

Retrieves the records matching the given query string.

Parameters:

queryString - search criterion

bodyIncluded - false to get only identifiers, true to also get the body of records

limit - max number of records to return. 0 means no limit.

Returns:

an instance of T that can be used to iterate over the results.

getRecords

T getRecords(String queryString,
             eu.dnetlib.miscutils.functional.UnaryFunction<String,String> unaryFunction,
             boolean bodyIncluded,
             int limit)

Retrieves the records matching the given query string and apply the given unary function before delivering.

Parameters:

queryString - search criterion

unaryFunction - mapping from String to String

bodyIncluded - false to get only identifiers, true to also get the body of records

limit - max number of records to return. 0 means no limit.

Returns:

an instance of T that can be used to iterate over the results.

getIndices

List<eu.dnetlib.data.information.oai.publisher.PublisherField> getIndices()

Gets informaton about the indices available on this store.

Returns:

a List with information about the indices of this store.

ensureIndices

void ensureIndices()

Ensures the indices on this store.

feed

int feed(Iterable<String> records,
         String source)

Feeds the store with the given records.

Parameters:

records - XML records to store.

source - String that identifies the record source.

Returns:

the number of stored records.

drop

void drop()

Drops the content of the store.

drop

void drop(String queryString)

Drops the elements matching the query from the store.

Parameters:

queryString -

count

int count()

Counts the number of records in this store.

Returns:

the size of the store.

count

int count(String queryString)

Counts the number of records in this store matching the query.

Parameters:

queryString - query

Returns:

the size of the store.