org.opensha.commons.eq.cat.io
Interface CatalogReader

All Known Implementing Classes:
AbstractReader, Reader_ANSS, Reader_Basic, Reader_LSH, Reader_NC_PARK, Reader_NC_USGS, Reader_NC_WALDHAUSER, Reader_NCEDC, Reader_SCEDC, Reader_SCSN, Reader_SHLK, Reader_TW_RELOC, STP_Reader

public interface CatalogReader

Interface implemented by classes that can process text files into earthquake data for a Catalog.

Version:
$Id: CatalogReader.java 7478 2011-02-15 04:56:25Z pmpowers $
Author:
Peter Powers

Method Summary
 java.lang.String description()
          Returns a general description of this catalog reader and/or the types of files it operates on.
 void process(java.io.File file, Catalog catalog)
          Reads data from a given file into a specified catalog
 

Method Detail

process

void process(java.io.File file,
             Catalog catalog)
             throws java.io.IOException
Reads data from a given file into a specified catalog

Parameters:
file - to process
catalog - for file data
Throws:
java.io.IOException - if IO or data reading problem encountered
java.lang.NullPointerException - if file or catalog are null

description

java.lang.String description()
Returns a general description of this catalog reader and/or the types of files it operates on.

Returns:
the description of this reader