Package ddf.catalog.plugin.groomer

Class AbstractMetacardGroomerPlugin

java.lang.Object
ddf.catalog.plugin.groomer.AbstractMetacardGroomerPlugin
All Implemented Interfaces:
ddf.catalog.plugin.PreIngestPlugin
public abstract class AbstractMetacardGroomerPlugin extends Object implements ddf.catalog.plugin.PreIngestPlugin
Abstract class that can be extended to create another rule set for grooming a metacard.
Author:
Ashraf Barakat

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractMetacardGroomerPlugin()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected abstract void
    applyCreatedOperationRules(ddf.catalog.operation.CreateRequest createRequest, ddf.catalog.data.Metacard aMetacard, Date timestamp)
    This method is called on each Metacard in the CreateRequest.
    protected abstract void
    applyUpdateOperationRules(ddf.catalog.operation.UpdateRequest updateRequest, Map.Entry<Serializable,ddf.catalog.data.Metacard> anUpdate, ddf.catalog.data.Metacard aMetacard, Date timestamp)
    This method is called on each Metacard in the UpdateRequest.
    ddf.catalog.operation.CreateRequest
    process(ddf.catalog.operation.CreateRequest input)
     
    ddf.catalog.operation.DeleteRequest
    process(ddf.catalog.operation.DeleteRequest input)
     
    ddf.catalog.operation.UpdateRequest
    process(ddf.catalog.operation.UpdateRequest input)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AbstractMetacardGroomerPlugin

      public AbstractMetacardGroomerPlugin()

  • Method Details

    • process

      public ddf.catalog.operation.CreateRequest process(ddf.catalog.operation.CreateRequest input) throws ddf.catalog.plugin.PluginExecutionException, ddf.catalog.plugin.StopProcessingException
      Specified by:
      process in interface ddf.catalog.plugin.PreIngestPlugin
      Throws:
      ddf.catalog.plugin.PluginExecutionException
      ddf.catalog.plugin.StopProcessingException

    • process

      public ddf.catalog.operation.UpdateRequest process(ddf.catalog.operation.UpdateRequest input) throws ddf.catalog.plugin.PluginExecutionException, ddf.catalog.plugin.StopProcessingException
      Specified by:
      process in interface ddf.catalog.plugin.PreIngestPlugin
      Throws:
      ddf.catalog.plugin.PluginExecutionException
      ddf.catalog.plugin.StopProcessingException

    • process

      public ddf.catalog.operation.DeleteRequest process(ddf.catalog.operation.DeleteRequest input) throws ddf.catalog.plugin.PluginExecutionException, ddf.catalog.plugin.StopProcessingException
      Specified by:
      process in interface ddf.catalog.plugin.PreIngestPlugin
      Throws:
      ddf.catalog.plugin.PluginExecutionException
      ddf.catalog.plugin.StopProcessingException

    • applyCreatedOperationRules

      protected abstract void applyCreatedOperationRules(ddf.catalog.operation.CreateRequest createRequest, ddf.catalog.data.Metacard aMetacard, Date timestamp) throws ddf.catalog.plugin.PluginExecutionException, ddf.catalog.plugin.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:
      ddf.catalog.plugin.PluginExecutionException
      ddf.catalog.plugin.StopProcessingException

    • applyUpdateOperationRules

      protected abstract void applyUpdateOperationRules(ddf.catalog.operation.UpdateRequest updateRequest, Map.Entry<Serializable,ddf.catalog.data.Metacard> anUpdate, ddf.catalog.data.Metacard aMetacard, Date timestamp) throws ddf.catalog.plugin.PluginExecutionException, ddf.catalog.plugin.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:
      ddf.catalog.plugin.PluginExecutionException
      ddf.catalog.plugin.StopProcessingException