gov.usgs.earthquake.nshmp.calc

Class Sites

java.lang.Object

gov.usgs.earthquake.nshmp.calc.Sites

All Implemented Interfaces:

Iterable<Site>

public abstract class Sites
extends Object
implements Iterable<Site>

Iterable Site container. Factory methods support creating instances from different input formats.

Author:

Peter Powers

Constructor Summary

Constructors

Constructor and Description
Sites()

Method Summary

Modifier and Type	Method and Description
static Sites	fromCsv(Path path, CalcConfig defaults) Create an unmodifiable Iterable<Site> from the comma-delimted site file designated by path.
static Sites	fromCsv(Path path, CalcConfig defaults, boolean lenient)
static Sites	fromJson(Path path, CalcConfig defaults) Create an unmodifiable Iterable<Site> from the GeoJSON site file designated by path.
static Sites	fromString(String s, CalcConfig defaults) Create an unmodifiable singleton Iterable<Site> from the supplied string.
abstract Optional<Bounds>	mapBounds() An optional Bounds that is used to specify rectangular map extents, which may differ from the range spanned by the sites in this.
abstract Optional<Double>	mapSpacing() An optional spacing value that reflects the spacing of sites within an attendant mapBounds().
abstract int	size() The number of Sites this contains.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

Sites

public Sites()

Method Detail

fromCsv

public static Sites fromCsv(Path path,
                            CalcConfig defaults)
                     throws IOException

Create an unmodifiable Iterable<Site> from the comma-delimted site file designated by path.

Parameters:

path - to comma-delimited site data file

Throws:

IOException - if a problem is encountered

fromCsv

public static Sites fromCsv(Path path,
                            CalcConfig defaults,
                            boolean lenient)
                     throws IOException

Throws:

IOException

fromJson

public static Sites fromJson(Path path,
                             CalcConfig defaults)
                      throws IOException

Create an unmodifiable Iterable<Site> from the GeoJSON site file designated by path.

Parameters:

path - to GeoJson site data file

Throws:

IOException - if a problem is encountered

fromString

public static Sites fromString(String s,
                               CalcConfig defaults)

Create an unmodifiable singleton Iterable<Site> from the supplied string. String is expected to have the form:

"name,lon,lat[,vs30,vsInf[,z1p0,z2p5]]"

Although the latter 4 fields are optional, if vs30 is defined, so too must vsInf. Likewise, if z1p0 is defined, so too must z2p5.

Parameters:

s - String to parse

toString

public String toString()

Overrides:

toString in class Object

size

public abstract int size()

The number of Sites this contains.

mapBounds

public abstract Optional<Bounds> mapBounds()

An optional Bounds that is used to specify rectangular map extents, which may differ from the range spanned by the sites in this. Presently only containers initialized with GeoJSON that includes an 'Extents' polygon will return an Optional where Optional.isPresent() == true.

mapSpacing

public abstract Optional<Double> mapSpacing()

An optional spacing value that reflects the spacing of sites within an attendant mapBounds().