Package gov.usgs.earthquake.indexer

Interface IndexerModule

All Known Implementing Classes:
DefaultIndexerModule, DYFIIndexerModule, MTIndexerModule, OriginIndexerModule, ShakeMapIndexerModule, TectonicSummaryIndexerModule
public interface IndexerModule
An IndexerModule provides product specific functionality for the Indexer.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    LEVEL_DEFAULT
    A constant used by the default module for every type of product.
    static final int
    LEVEL_SUPPORTED
    A constant to indicate better than default support for a product.
    static final int
    LEVEL_UNSUPPORTED
    A constant to indicate a module does not support a product.

  • Method Summary

    Modifier and Type
    Method
    Description
    ProductSummary
    getProductSummary(Product product)
    Summarize a product.
    int
    getSupportLevel(Product product)
    Determine the support level for a given product.

  • Field Details

    • LEVEL_UNSUPPORTED

      static final int LEVEL_UNSUPPORTED
      A constant to indicate a module does not support a product.
      See Also:

    • LEVEL_DEFAULT

      static final int LEVEL_DEFAULT
      A constant used by the default module for every type of product.
      See Also:

    • LEVEL_SUPPORTED

      static final int LEVEL_SUPPORTED
      A constant to indicate better than default support for a product.
      See Also:

  • Method Details

    • getSupportLevel

      int getSupportLevel(Product product)
      Determine the support level for a given product. The Indexer uses this method to determine which module will be used to summarize a product as it is being processed. Usually, returning one of the LEVEL_ constants will be sufficient.
      Parameters:
      product - The product to get the support level at
      Returns:
      the support level. Should be greater than 0 if a product is supported, larger values indicate better support.

    • getProductSummary

      ProductSummary getProductSummary(Product product) throws Exception
      Summarize a product.
      Parameters:
      product - the product to summarize
      Returns:
      the ProductSummary
      Throws:
      Exception - if error occurs