eu.dnetlib.data.oai.store

Interface PublisherStoreDAO<X extends PublisherStore<T>,T extends Cursor>

All Known Implementing Classes:

MongoPublisherStoreDAO

public interface PublisherStoreDAO<X extends PublisherStore<T>,T extends Cursor>

Method Summary

Modifier and Type	Method and Description
X	createStore(String mdfName, String mdfInterpretation, String mdfLayout, String dbName) Create a PublisherStore with the given properties.
boolean	deleteFromStore(String storeId, String dbName, String set) Deletes from the store with the given identifier the records belonging to the given set.
boolean	deleteFromStore(String mdfName, String mdfInterpretation, String mdfLayout, String dbName, String set) Deletes from the store with the given identifier the records belonging to the given set.
boolean	deleteStore(String storeId, String dbName) Deletes the store with the given identifier.
boolean	deleteStore(String mdfName, String mdfInterpretation, String mdfLayout, String dbName) Deletes the store with the given properties.
X	getStore(String storeId, String dbName) Gets the store with the given identifier.
X	getStore(String mdfName, String mdfInterpretation, String mdfLayout, String dbName) Gets the store with the given properties.
X	getStoreFor(String targetMetadataPrefix, String dbName) Gets the store to be used as source to deliver records with the given metadata prefix.
List<X>	listPublisherStores(String dbName) Lists all PublisherStore.

Method Detail

listPublisherStores

List<X> listPublisherStores(String dbName)

Lists all PublisherStore.

Parameters:

dbName - name of the target database

Returns:

a List of PublisherStore instances.

getStore

X getStore(String storeId,
           String dbName)

Gets the store with the given identifier.

Parameters:

dbName - name of the target database

storeId - identifier of the store to retrieve

Returns:

a PublisherStore instance or null if there is no store with the given id.

getStore

X getStore(String mdfName,
           String mdfInterpretation,
           String mdfLayout,
           String dbName)

Gets the store with the given properties.

Parameters:

mdfName - name of the metadata format

mdfInterpretation - name of the metadata interpretation

mdfLayout - name of the metadata layout

dbName - name of the target database

Returns:

a PublisherStore instance or null if there is no store with the given properties.

getStoreFor

X getStoreFor(String targetMetadataPrefix,
              String dbName)

Gets the store to be used as source to deliver records with the given metadata prefix.

Parameters:

targetMetadataPrefix - prefix of the metadata format deliverable through this store

dbName - name of the target database

Returns:

a PublisherStore instance or null if there is no store serving the given metadata prefix.

createStore

X createStore(String mdfName,
              String mdfInterpretation,
              String mdfLayout,
              String dbName)
       throws eu.dnetlib.data.information.oai.publisher.OaiPublisherException

Create a PublisherStore with the given properties.

Parameters:

mdfName - name of the metadata format

mdfInterpretation - name of the metadata interpretation

mdfLayout - name of the metadata layout

dbName - name of the target database

Returns:

a PublisherStore instance whose identifier is automatically generated.

Throws:

eu.dnetlib.data.information.oai.publisher.OaiPublisherException - if there is already another PublisherStore with the given metadata format name, layout and interpretation.

deleteStore

boolean deleteStore(String storeId,
                    String dbName)

Deletes the store with the given identifier.

Parameters:

storeId - id of the store to delete

dbName - name of the target database

Returns:

true if the store was deleted successfully, false otherwise (e.g., a store with the given id does not exist).

deleteFromStore

boolean deleteFromStore(String storeId,
                        String dbName,
                        String set)

Deletes from the store with the given identifier the records belonging to the given set.

Parameters:

storeId - id of the store to delete

dbName - name of the target database

set - name of the set

Returns:

true if the records were deleted successfully, false otherwise (e.g., a store with the given id does not exist).

deleteFromStore

boolean deleteFromStore(String mdfName,
                        String mdfInterpretation,
                        String mdfLayout,
                        String dbName,
                        String set)

Deletes from the store with the given identifier the records belonging to the given set.

Parameters:

mdfName - name of the metadata format

mdfInterpretation - name of the metadata interpretation

mdfLayout - name of the metadata layout

dbName - name of the target database

set - name of the set

Returns:

true if the records were deleted successfully, false otherwise (e.g., a store with the given id does not exist).

deleteStore

boolean deleteStore(String mdfName,
                    String mdfInterpretation,
                    String mdfLayout,
                    String dbName)

Deletes the store with the given properties.

Parameters:

mdfName - name of the metadata format

mdfInterpretation - name of the metadata interpretation

mdfLayout - name of the metadata layout

dbName - name of the target database

Returns:

true if the store was deleted successfully, false otherwise (e.g., a store with the given properties does not exist).