Package gov.usgs.earthquake.indexer

The Indexer builds a catalog of Products.

Indexer stores ProductSummaries and Events in a ProductIndex.

Data Objects

ProductSummary

The Indexer uses IndexerModules to summarize Products.

Event

The Indexer Associates related products into Events.

IndexerEvent

Represents one or more IndexerChanges made in response to processing an incoming product.

Indexer Listeners

Listeners receive IndexerEvents whenever changes are made to the index

DefaultIndexerListener

Base class to process IndexerEvents in a separate thread.

ExternalIndexerListener

Executes an external process for each IndexerEvent.

Archive Policies

By default events and products are kept forever. Configure archive policies to periodically remove old information.

ArchivePolicy

When to remove events from the ProductIndex. When events are removed, any associated products are also removed.

ProductArchivePolicy

When to remove products from the ProductIndex, for example old versions or products that did not associate to any events.

Interface Summary

Interface	Description
Associator	Implement event association logic used by the indexer.
IndexerListener	Listen for notifications that the index has changed.
IndexerModule	An IndexerModule provides product specific functionality for the Indexer.
ProductIndex	An index of products.

Class Summary

Class	Description
ArchivePolicy	A policy for the Indexer to clean up Events in its ProductIndex.
DefaultAssociator	Utilities for associating events.
DefaultIndexerListener	DefaultIndexerListener provides a starting point from which all IndexerListeners may extend.
DefaultIndexerModule	Default implementation of the IndexerModule interface, implements ANSS Authoritative Region logic.
Event	An event is a group of products that are nearby in space and time.
EventDetailQuery	Search for one event.
EventsSummaryQuery	Search for multiple Events.
EventSummary	Summary of an Event and its products.
ExtentIndex	ExtentIndex is a type of JDBCProductIndex that can also send updates to the extentSummary table.
ExtentIndexerListener	ExtentIndexerListener is an extension of the ReliableIndexerListener.
ExtentSummary	Stores ExtentSummary information for products.
ExternalIndexerListener	ExternalIndexerListener triggers external, non-Java listener processes.
ExternalPreferredListener	(Experimental) Notify external processes when preferred product change within events.
Indexer	The indexer receives products from Distribution, and adds them to the EventIndex.
IndexerChange	Description of a specific change to a ProductIndex.
IndexerEvent	A description of a change to a ProductIndex.
IndexerListenerCallable	A Callable object for deferred indexer listener notification.
JDBCProductIndex	JDBC Implementation of ProductIndex.
ProductArchivePolicy	An archive policy for products, instead of events.
ProductDetailQuery	Search for one product.
ProductIndexQuery	Criteria for finding events.
ProductsSummaryQuery	Search for multiple products.
ProductSummary	A ProductSummary is essentially a product without its contents.
ReliableIndexerListener	ReliableIndexerListener listens for product changes by the indexer, then handles the new products independently in a background thread.
SearchCLI	Command line interface for search socket.
SearchQuery	A search to execute against a ProductIndex, or ProductStorage.
SearchRequest	A search request, which is one or more SearchQuerys.
SearchRequestParser	Parser for SearchXML request.
SearchResponse	Results from a SearchRequest.
SearchResponseParser	Parser for SearchXML response.
SearchResponseXmlProductSource	Used by SearchResponseParser to store products during parsing.
SearchServerSocket	Server side of socket search interface.
SearchSocket	Client side of search socket interface.
SearchXML	Formatter for Search XML.

Enum Summary

Enum	Description
ExternalPreferredListener.PreferredAction	Types of preferred product actions.
IndexerChange.IndexerChangeType	Enumeration of indexer event types.
SearchMethod	Different types of searches that are supported.