eu.dnetlib.data.oai.store.mongo

Class MongoPublisherStore

java.lang.Object

eu.dnetlib.data.oai.store.mongo.MongoPublisherStore

All Implemented Interfaces:

PublisherStore<DNetOAIMongoCursor>

public class MongoPublisherStore
extends Object
implements PublisherStore<DNetOAIMongoCursor>

Constructor Summary

Constructors

Constructor and Description
MongoPublisherStore()
MongoPublisherStore(String id, String metadataFormat, String interpretation, String layout, com.mongodb.client.MongoCollection<com.mongodb.DBObject> collection, List<eu.dnetlib.data.information.oai.publisher.PublisherField> mongoFields, RecordInfoGenerator recordInfoGenerator, String idScheme, String idNamespace, MetadataExtractor metadataExtractor, RecordChangeDetector recordChangeDetector, boolean alwaysNewRecord, com.mongodb.client.MongoDatabase mongodb)

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	createCompoundIndex(List<String> fieldNames) Creates a compound index over the specified fields on the given store.
org.bson.types.Binary	createCompressRecord(String record)
void	drop() Drops the content of the store.
void	drop(String queryString) Drops the elements matching the query from the store.
void	ensureIndices() Ensure indices on the configuration-defined fields and on the system fields DATESTAMP_FIELD and LAST_COLLECTION_DATE_FIELD.
boolean	equals(Object obj)
int	feed(Iterable<String> records, String source) Feeds the store with the given records.
com.mongodb.client.MongoCollection<com.mongodb.DBObject>	getCollection()
com.mongodb.client.MongoCollection<com.mongodb.DBObject>	getDiscardedCollection()
List<String>	getDistinctSetNamesFromRecords()
String	getId() Returns the identifier of this store.
String	getIdNamespace()
String	getIdScheme()
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.
MetadataExtractor	getMetadataExtractor()
String	getMetadataFormat() Gets the metadata format of this store.
List<eu.dnetlib.data.information.oai.publisher.PublisherField>	getMongoFields()
MongoSetCollection	getMongoSetCollection()
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.
RecordChangeDetector	getRecordChangeDetector()
RecordInfoGenerator	getRecordInfoGenerator()
DNetOAIMongoCursor	getRecords(String queryString, boolean bodyIncluded, int limit) Retrieves the records matching the given query string.
DNetOAIMongoCursor	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.
int	hashCode()
boolean	isAlwaysNewRecord()
void	setAlwaysNewRecord(boolean alwaysNewRecord)
void	setCollection(com.mongodb.client.MongoCollection<com.mongodb.DBObject> collection)
void	setDiscardedCollection(com.mongodb.client.MongoCollection<com.mongodb.DBObject> discardedCollection)
void	setId(String id)
void	setIdNamespace(String idNamespace)
void	setIdScheme(String idScheme)
void	setInterpretation(String interpretation)
void	setLayout(String layout)
void	setMetadataExtractor(MetadataExtractor metadataExtractor)
void	setMetadataFormat(String metadataFormat)
void	setMongoFields(List<eu.dnetlib.data.information.oai.publisher.PublisherField> mongoFields)
void	setMongoSetCollection(MongoSetCollection mongoSetCollection)
void	setRecordChangeDetector(RecordChangeDetector recordChangeDetector)
void	setRecordInfoGenerator(RecordInfoGenerator recordInfoGenerator)
String	toString()
void	upsertSets(Iterable<String> setNames)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MongoPublisherStore

public MongoPublisherStore()

MongoPublisherStore

public MongoPublisherStore(String id,
                           String metadataFormat,
                           String interpretation,
                           String layout,
                           com.mongodb.client.MongoCollection<com.mongodb.DBObject> collection,
                           List<eu.dnetlib.data.information.oai.publisher.PublisherField> mongoFields,
                           RecordInfoGenerator recordInfoGenerator,
                           String idScheme,
                           String idNamespace,
                           MetadataExtractor metadataExtractor,
                           RecordChangeDetector recordChangeDetector,
                           boolean alwaysNewRecord,
                           com.mongodb.client.MongoDatabase mongodb)

Method Detail

getRecord

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

Description copied from interface: PublisherStore

Retrieves the record with the given identifier from this store.

Specified by:

getRecord in interface PublisherStore<DNetOAIMongoCursor>

Parameters:

recordId - identifier of the record to retrieve

Returns:

a RecordInfo instance representing the XML record

getRecord

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

Description copied from interface: PublisherStore

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

Specified by:

getRecord in interface PublisherStore<DNetOAIMongoCursor>

Parameters:

recordId - identifier of the record to retrieve

unaryFunction - mapping from String to String

Returns:

a RecordInfo instance representing the XML record

getRecords

public DNetOAIMongoCursor getRecords(String queryString,
                                     boolean bodyIncluded,
                                     int limit)

Description copied from interface: PublisherStore

Retrieves the records matching the given query string.

Specified by:

getRecords in interface PublisherStore<DNetOAIMongoCursor>

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

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

Description copied from interface: PublisherStore

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

Specified by:

getRecords in interface PublisherStore<DNetOAIMongoCursor>

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

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

Description copied from interface: PublisherStore

Gets informaton about the indices available on this store.

Specified by:

getIndices in interface PublisherStore<DNetOAIMongoCursor>

Returns:

a List with information about the indices of this store.

ensureIndices

public void ensureIndices()

Ensure indices on the configuration-defined fields and on the system fields DATESTAMP_FIELD and LAST_COLLECTION_DATE_FIELD.

Note that by default ID_FIELD, SET_FIELD, DELETED_FIELD, BODY_FIELD, UPDATED_FIELD are not indexed. If you want an index on those, then you have to specify it in the configuration file of the OAI Publisher:

Ensures the indices on this store.

Specified by:

ensureIndices in interface PublisherStore<DNetOAIMongoCursor>

createCompoundIndex

public void createCompoundIndex(List<String> fieldNames)

Creates a compound index over the specified fields on the given store.

The creation is performed on the background

Parameters:

fieldNames - List of fields to be included in the compound index

feed

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

Description copied from interface: PublisherStore

Feeds the store with the given records.

Specified by:

feed in interface PublisherStore<DNetOAIMongoCursor>

Parameters:

records - XML records to store.

source - String that identifies the record source.

Returns:

the number of stored records.

drop

public void drop()

Description copied from interface: PublisherStore

Drops the content of the store.

Specified by:

drop in interface PublisherStore<DNetOAIMongoCursor>

drop

public void drop(String queryString)

Description copied from interface: PublisherStore

Drops the elements matching the query from the store.

Specified by:

drop in interface PublisherStore<DNetOAIMongoCursor>

count

public int count()

Description copied from interface: PublisherStore

Counts the number of records in this store.

Specified by:

count in interface PublisherStore<DNetOAIMongoCursor>

Returns:

the size of the store.

count

public int count(String queryString)

Description copied from interface: PublisherStore

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

Specified by:

count in interface PublisherStore<DNetOAIMongoCursor>

Parameters:

queryString - query

Returns:

the size of the store.

getDistinctSetNamesFromRecords

public List<String> getDistinctSetNamesFromRecords()

createCompressRecord

public org.bson.types.Binary createCompressRecord(String record)
                                           throws IOException

Parameters:

record -

Throws:

IOException

upsertSets

public void upsertSets(Iterable<String> setNames)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getCollection

public com.mongodb.client.MongoCollection<com.mongodb.DBObject> getCollection()

setCollection

public void setCollection(com.mongodb.client.MongoCollection<com.mongodb.DBObject> collection)

getDiscardedCollection

public com.mongodb.client.MongoCollection<com.mongodb.DBObject> getDiscardedCollection()

setDiscardedCollection

public void setDiscardedCollection(com.mongodb.client.MongoCollection<com.mongodb.DBObject> discardedCollection)

getIdScheme

public String getIdScheme()

setIdScheme

public void setIdScheme(String idScheme)

getIdNamespace

public String getIdNamespace()

setIdNamespace

public void setIdNamespace(String idNamespace)

getRecordInfoGenerator

public RecordInfoGenerator getRecordInfoGenerator()

setRecordInfoGenerator

public void setRecordInfoGenerator(RecordInfoGenerator recordInfoGenerator)

getMetadataExtractor

public MetadataExtractor getMetadataExtractor()

setMetadataExtractor

public void setMetadataExtractor(MetadataExtractor metadataExtractor)

getRecordChangeDetector

public RecordChangeDetector getRecordChangeDetector()

setRecordChangeDetector

public void setRecordChangeDetector(RecordChangeDetector recordChangeDetector)

getId

public String getId()

Description copied from interface: PublisherStore

Returns the identifier of this store.

Specified by:

getId in interface PublisherStore<DNetOAIMongoCursor>

Returns:

a String that identifies this store

setId

public void setId(String id)

getMetadataFormat

public String getMetadataFormat()

Description copied from interface: PublisherStore

Gets the metadata format of this store.

Specified by:

getMetadataFormat in interface PublisherStore<DNetOAIMongoCursor>

Returns:

String

setMetadataFormat

public void setMetadataFormat(String metadataFormat)

getInterpretation

public String getInterpretation()

Description copied from interface: PublisherStore

Gets the interpretation of this store.

Specified by:

getInterpretation in interface PublisherStore<DNetOAIMongoCursor>

Returns:

String

setInterpretation

public void setInterpretation(String interpretation)

getLayout

public String getLayout()

Description copied from interface: PublisherStore

Gets the layout of this store.

Specified by:

getLayout in interface PublisherStore<DNetOAIMongoCursor>

Returns:

String

setLayout

public void setLayout(String layout)

getMongoSetCollection

public MongoSetCollection getMongoSetCollection()

setMongoSetCollection

public void setMongoSetCollection(MongoSetCollection mongoSetCollection)

getMongoFields

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

setMongoFields

public void setMongoFields(List<eu.dnetlib.data.information.oai.publisher.PublisherField> mongoFields)

isAlwaysNewRecord

public boolean isAlwaysNewRecord()

setAlwaysNewRecord

public void setAlwaysNewRecord(boolean alwaysNewRecord)