Package ddf.catalog.source

Interface CatalogProvider

All Superinterfaces:

Describable, org.codice.ddf.platform.services.common.Describable, Maskable, Source

public interface CatalogProvider
extends Source, Maskable

External facing (outside of CatalogFramework) API used to interact with providers of data such as a file system or database. The basic premise of a CatalogProvider is to allow query, create, update, and delete operations.

The provider performs a translation between DDF objects and its native format. The key functions of the CatalogProvider can be found in the Source and Metacard interfaces.

Method Summary

Modifier and Type	Method	Description
CreateResponse	create(CreateRequest createRequest)	Publishes a list of Metacard objects into the catalog.
DeleteResponse	delete(DeleteRequest deleteRequest)	Deletes records specified by a list of attribute values such as an id attribute.
UpdateResponse	update(UpdateRequest updateRequest)	Updates a list of Metacard records.

Methods inherited from interface ddf.catalog.util.Describable

getDescription, getId, getOrganization, getTitle, getVersion

Methods inherited from interface ddf.catalog.util.Maskable

maskId

Methods inherited from interface ddf.catalog.source.Source

getContentTypes, getSecurityAttributes, isAvailable, isAvailable, query

Method Details

create

CreateResponse create(CreateRequest createRequest)
               throws IngestException

Publishes a list of Metacard objects into the catalog.

Parameters:

createRequest - - the CreateRequest that includes a List of Metacard objects to be stored in a Source. The ID of the Metacard object will be ignored and populated / generated by the CatalogProvider when the record has been stored.

Returns:

the CreateResponse containing a List of fully populated metacards. This should be similar to the parameter list of Metacard objects but it must have the ddf.catalog.data.Metacard ID populated.

Throws:

IngestException - if any problem occurs when storing the metacards

update

UpdateResponse update(UpdateRequest updateRequest)
               throws IngestException

Updates a list of Metacard records. Metacard records that are not in the Catalog will not be created.

Parameters:

updateRequest - - the UpdateRequest that includes updates to Metacard records that have been previously stored in a Source. A given Attribute name-value pair in this request must uniquely identify zero metacards or one metacard in the Source, otherwise an IngestException will be thrown.

Returns:

the UpdateResponse containing a List of Update objects that represent the new (updated) and old (previous) Metacard records.

Throws:

IngestException - if an issue occurs during the update such as multiple records were matched for a single update entry

delete

DeleteResponse delete(DeleteRequest deleteRequest)
               throws IngestException

Deletes records specified by a list of attribute values such as an id attribute.

Parameters:

deleteRequest - - the DeleteRequest containing the attribute values associated with Metacards to delete

Returns:

a DeleteResponse with Metacards that were deleted. These Metacards are fully populated in preparation for any processing services.

Throws:

IngestException - if an issue occurs during the delete