ddf.catalog.plugin.groomer

Class AbstractMetacardGroomerPlugin

java.lang.Object

ddf.catalog.plugin.groomer.AbstractMetacardGroomerPlugin

All Implemented Interfaces:

PreIngestPlugin

Direct Known Subclasses:

StandardMetacardGroomerPlugin

public abstract class AbstractMetacardGroomerPlugin
extends Object
implements PreIngestPlugin

Abstract class that can be extended to create another rule set for grooming a metacard.

Author:

Ashraf Barakat, ddf.isgs@lmco.com

Constructor Summary

Constructors

Constructor and Description
AbstractMetacardGroomerPlugin()

Method Summary

Modifier and Type	Method and Description
protected abstract void	applyCreatedOperationRules(CreateRequest createRequest, Metacard aMetacard, Date timestamp) This method is called on each Metacard in the CreateRequest.
protected abstract void	applyUpdateOperationRules(UpdateRequest updateRequest, Map.Entry<Serializable,Metacard> anUpdate, Metacard aMetacard, Date timestamp) This method is called on each Metacard in the UpdateRequest.
CreateRequest	process(CreateRequest input) Process a CreateRequest prior to CatalogProvider.create(CreateRequest).
DeleteRequest	process(DeleteRequest input) Processes the DeleteRequest prior to the execution of the update operation.
UpdateRequest	process(UpdateRequest input) Process a UpdateRequest prior to CatalogProvider.update(UpdateRequest).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMetacardGroomerPlugin

public AbstractMetacardGroomerPlugin()

Method Detail

process

public CreateRequest process(CreateRequest input)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PreIngestPlugin

Process a CreateRequest prior to CatalogProvider.create(CreateRequest).

Specified by:

process in interface PreIngestPlugin

Parameters:

input - the CreateRequest to process

Returns:

the value of the processed CreateRequest to pass to the next PreIngestPlugin, or to the CatalogProvider if this is the last PreIngestPlugin to be called

Throws:

PluginExecutionException - if an error in processing occurs

StopProcessingException

process

public UpdateRequest process(UpdateRequest input)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PreIngestPlugin

Process a UpdateRequest prior to CatalogProvider.update(UpdateRequest).

Specified by:

process in interface PreIngestPlugin

Parameters:

input - the UpdateRequest to process

Returns:

the value of the processed UpdateRequest to pass to the next PreIngestPlugin, or to the CatalogProvider if this is the last PreIngestPlugin to be called

Throws:

PluginExecutionException - if an error in processing occurs

StopProcessingException

process

public DeleteRequest process(DeleteRequest input)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PreIngestPlugin

Processes the DeleteRequest prior to the execution of the update operation.

Specified by:

process in interface PreIngestPlugin

Parameters:

input - the DeleteRequest to process

Returns:

the value of the processed DeleteRequest to pass to the next PreIngestPlugin, or if this is the last PreIngestPlugin to be called

Throws:

PluginExecutionException - thrown when an error in processing occurs

StopProcessingException

applyCreatedOperationRules

protected abstract void applyCreatedOperationRules(CreateRequest createRequest,
                                                   Metacard aMetacard,
                                                   Date timestamp)
                                            throws PluginExecutionException,
                                                   StopProcessingException

This method is called on each Metacard in the CreateRequest. It allows for the modification of the Metacard object within the request.

Parameters:

createRequest - the entire CreateRequest object

aMetacard - a Metacard within the request

timestamp - a current Date timestamp to be optionally used to timestamp each Metacard

Throws:

PluginExecutionException

StopProcessingException

applyUpdateOperationRules

protected abstract void applyUpdateOperationRules(UpdateRequest updateRequest,
                                                  Map.Entry<Serializable,Metacard> anUpdate,
                                                  Metacard aMetacard,
                                                  Date timestamp)
                                           throws PluginExecutionException,
                                                  StopProcessingException

This method is called on each Metacard in the UpdateRequest. It allows for modification of the Metacard object within the request.

Parameters:

updateRequest - the entire UpdateRequest object

anUpdate - a single Update within the UpdateRequest

aMetacard - a Metacard within the request

timestamp - a current Date timestamp to be optionally used to timestamp each Metacard, such as stamping each Metacard with the same Metacard.MODIFIED date.

Throws:

PluginExecutionException

StopProcessingException