Package gov.usgs.earthquake.dyfi

Class DYFIIndexerModule

java.lang.Object

gov.usgs.util.DefaultConfigurable

gov.usgs.earthquake.indexer.DefaultIndexerModule

gov.usgs.earthquake.dyfi.DYFIIndexerModule

All Implemented Interfaces:

IndexerModule, Configurable

public class DYFIIndexerModule
extends DefaultIndexerModule

DYFI Indexer Module. Uses DYFIProduct class to summarize product.

Field Summary

Fields inherited from class gov.usgs.earthquake.indexer.DefaultIndexerModule

ANSS_CONTRIBUTOR_WEIGHT, AUTHORITATIVE_EVENT_WEIGHT, AUTHORITATIVE_WEIGHT, DEFAULT_PREFERRED_WEIGHT, IGNORE_REGIONS_PROPERTY, NEIC_CONTRIBUTOR_WEIGHT, SAME_SOURCE_WEIGHT

Fields inherited from interface gov.usgs.earthquake.indexer.IndexerModule

LEVEL_DEFAULT, LEVEL_SUPPORTED, LEVEL_UNSUPPORTED

Constructor Summary

Constructors

Constructor	Description
DYFIIndexerModule()

Method Summary

Modifier and Type	Method	Description
ProductSummary	getProductSummary(Product product)	Create a ProductSummary from a Product.
int	getSupportLevel(Product product)	This module provides a default level of support for any type of product.

Methods inherited from class gov.usgs.earthquake.indexer.DefaultIndexerModule

configure, getBaseProductType, getIgnoreRegions, getPreferredWeight, getSignatureVerifier, setSignatureVerifier

Methods inherited from class gov.usgs.util.DefaultConfigurable

getName, setName, shutdown, startup

Methods inherited from class java.lang.Object

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

Constructor Details

DYFIIndexerModule

public DYFIIndexerModule()

Method Details

getSupportLevel

public int getSupportLevel(Product product)

Description copied from class: DefaultIndexerModule

This module provides a default level of support for any type of product.

Specified by:

getSupportLevel in interface IndexerModule

Overrides:

getSupportLevel in class DefaultIndexerModule

Parameters:

product - the product to test.

Returns:

IndexerModule.LEVEL_DEFAULT.

getProductSummary

public ProductSummary getProductSummary(Product product)
                                 throws Exception

Description copied from class: DefaultIndexerModule

Create a ProductSummary from a Product. Uses the ProductSummary(Product) constructor, which copies product information. Checks whether product is within its authoritative region, and if so boosts preferredWeight by AUTHORITATIVE_WEIGHT.

Specified by:

getProductSummary in interface IndexerModule

Overrides:

getProductSummary in class DefaultIndexerModule

Parameters:

product - the product to summarize.

Returns:

ProductSummary for Product object.

Throws:

Exception - if error occurs