EsriShapefile (All javadoc for netcdf-java version 4.6.22-SNAPSHOT)

java.lang.Object
- ucar.nc2.ui.gis.shapefile.EsriShapefile

```
public class EsriShapefile
extends java.lang.Object
```
EsriShapefile.java
Encapsulates details of ESRI Shapefile format, documented at http://www.esri.com/library/whitepapers/pdfs/shapefile.pdf

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`EsriShapefile.EsriFeature` EsriFeature.java Created: Sat Feb 20 17:19:53 1999
`class`	`EsriShapefile.EsriMultipoint` Represents a Multipoint in an ESRI shapefile.
`class`	`EsriShapefile.EsriNull` A NULL shape in an ESRI shapefile.
`class`	`EsriShapefile.EsriPoint` Represents a single point in an ESRI shapefile.
`class`	`EsriShapefile.EsriPolygon` Represents a Polygon in an ESRI shapefile as a List of GisParts.
`class`	`EsriShapefile.EsriPolyline` Represents a Polyline in an ESRI shapefile as a List of GisParts.

Constructor Summary

Constructors
Constructor and Description
`EsriShapefile(java.io.InputStream iStream, java.awt.geom.Rectangle2D bBox, double coarseness)` Read an ESRI shapefile and extract the subset of features that have bounding boxes that intersect a specified bounding box, with control of time versus resolution.
`EsriShapefile(java.lang.String filename)` Read an ESRI shapefile and extract all features into an in-memory structure.
`EsriShapefile(java.lang.String filename, double coarseness)` Read an ESRI shapefile and extract all features into an in-memory structure, with control of time versus resolution.
`EsriShapefile(java.lang.String filename, java.awt.geom.Rectangle2D bBox)` Read an ESRI shapefile and extract the subset of features that have bounding boxes that intersect a specified bounding box.
`EsriShapefile(java.lang.String filename, java.awt.geom.Rectangle2D bBox, double coarseness)` Read an ESRI shapefile and extract all features into an in-memory structure, with control of time versus resolution.
`EsriShapefile(java.net.URL url)` Read an ESRI shapefile from a URL and extract all features into an in-memory structure.
`EsriShapefile(java.net.URL url, double coarseness)` Read an ESRI shapefile from a URL and extract all features into an in-memory structure, with control of time versus resolution.
`EsriShapefile(java.net.URL url, java.awt.geom.Rectangle2D bBox)` Read an ESRI shapefile and extract the subset of features that have bounding boxes that intersect a specified bounding box
`EsriShapefile(java.net.URL url, java.awt.geom.Rectangle2D bBox, double coarseness)` Read an ESRI shapefile and extract the subset of features that have bounding boxes that intersect a specified bounding box

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.awt.geom.Rectangle2D`	`getBoundingBox()` Get bounding box, according to file (not computed from features)
`java.util.List`	`getFeatures()` Get a List of all the GisFeatures in the shapefile.
`java.util.List<EsriShapefile.EsriFeature>`	`getFeatures(java.awt.geom.Rectangle2D bBox)` Get a List of all the features in the shapefile that intersect the specified bounding box.
`int`	`getNumFeatures()`
`int`	`getVersion()` Returns shapefile format version (currently 1000)
`static void`	`main(java.lang.String[] args)`
`double`	`percentRead()` Return percent of file read, so far.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EsriShapefile
```
public EsriShapefile(java.lang.String filename)
              throws java.io.IOException
```
    Read an ESRI shapefile and extract all features into an in-memory structure.
    
    Parameters:
    
    filename - name of ESRI shapefile (typically has ".shp" extension)
    
    Throws:
    
    java.io.IOException
  - EsriShapefile
```
public EsriShapefile(java.net.URL url)
              throws java.io.IOException
```
    Read an ESRI shapefile from a URL and extract all features into an in-memory structure.
    
    Parameters:
    
    url - URL of ESRI shapefile
    
    Throws:
    
    java.io.IOException
  - EsriShapefile
```
public EsriShapefile(java.lang.String filename,
                     double coarseness)
              throws java.io.IOException
```
    Read an ESRI shapefile and extract all features into an in-memory structure, with control of time versus resolution.
    
    Parameters:
    
    filename - name of ESRI shapefile (typically has ".shp" extension)
    
    coarseness - to tradeoff plot quality versus speed.
    
    Throws:
    
    java.io.IOException
  - EsriShapefile
```
public EsriShapefile(java.net.URL url,
                     double coarseness)
              throws java.io.IOException
```
    Read an ESRI shapefile from a URL and extract all features into an in-memory structure, with control of time versus resolution.
    
    Parameters:
    
    url - URL of ESRI shapefile
    
    coarseness - to tradeoff plot quality versus speed.
    
    Throws:
    
    java.io.IOException
  - EsriShapefile
```
public EsriShapefile(java.net.URL url,
                     java.awt.geom.Rectangle2D bBox,
                     double coarseness)
              throws java.io.IOException
```
    Read an ESRI shapefile and extract the subset of features that have bounding boxes that intersect a specified bounding box
    
    Parameters:
    
    url - URL of ESRI shapefile
    
    bBox - bounding box specifying which features to select, namely those whose bounding boxes intersect this one. If null, bounding box of whole shapefile is used
    
    coarseness - to tradeoff plot quality versus speed.
    
    Throws:
    
    java.io.IOException
  - EsriShapefile
```
public EsriShapefile(java.lang.String filename,
                     java.awt.geom.Rectangle2D bBox,
                     double coarseness)
              throws java.io.IOException
```
    Read an ESRI shapefile and extract all features into an in-memory structure, with control of time versus resolution.
    
    Parameters:
    
    filename - name of ESRI shapefile
    
    bBox - bounding box specifying which features to select, namely those whose bounding boxes intersect this one. If null, bounding box of whole shapefile is used
    
    coarseness - to tradeoff plot quality versus speed.
    
    Throws:
    
    java.io.IOException
  - EsriShapefile
```
public EsriShapefile(java.net.URL url,
                     java.awt.geom.Rectangle2D bBox)
              throws java.io.IOException
```
    Read an ESRI shapefile and extract the subset of features that have bounding boxes that intersect a specified bounding box
    
    Parameters:
    
    url - URL of ESRI shapefile
    
    bBox - bounding box specifying which features to select, namely those whose bounding boxes intersect this one. If null, bounding box of whole shapefile is used
    
    Throws:
    
    java.io.IOException
  - EsriShapefile
```
public EsriShapefile(java.lang.String filename,
                     java.awt.geom.Rectangle2D bBox)
              throws java.io.IOException
```
    Read an ESRI shapefile and extract the subset of features that have bounding boxes that intersect a specified bounding box.
    
    Parameters:
    
    filename - name of ESRI shapefile
    
    bBox - bounding box specifying which features to select, namely those whose bounding boxes intersect this one. If null, bounding box of whole shapefile is used
    
    Throws:
    
    java.io.IOException
  - EsriShapefile
```
public EsriShapefile(java.io.InputStream iStream,
                     java.awt.geom.Rectangle2D bBox,
                     double coarseness)
              throws java.io.IOException
```
    Read an ESRI shapefile and extract the subset of features that have bounding boxes that intersect a specified bounding box, with control of time versus resolution.
    
    Parameters:
    
    iStream - input from which to read
    
    bBox - bounding box specifying which features to select, namely those whose bounding boxes intersect this one. If null, bounding box of whole shapefile is used
    
    Throws:
    
    java.io.IOException
- Method Detail
  - percentRead
```
public double percentRead()
```
    Return percent of file read, so far.
    
    Returns:
    
    percent of file read, so far.
  - getNumFeatures
```
public int getNumFeatures()
```
    Returns:
    
    number of features in shapefile
  - getVersion
```
public int getVersion()
```
    Returns shapefile format version (currently 1000)
    
    Returns:
    
    version, as stored in shapefile.
  - getBoundingBox
```
public java.awt.geom.Rectangle2D getBoundingBox()
```
    Get bounding box, according to file (not computed from features)
    
    Returns:
    
    bounding box for shapefilew, as stored in header.
  - getFeatures
```
public java.util.List getFeatures()
```
    Get a List of all the GisFeatures in the shapefile. This is very fast after the constructor has been called, since it is created during construction.
    
    Returns:
    
    a List of features
  - getFeatures
```
public java.util.List<EsriShapefile.EsriFeature> getFeatures(java.awt.geom.Rectangle2D bBox)
```
    Get a List of all the features in the shapefile that intersect the specified bounding box. This requires testing every feature in the List created at construction, so it's faster to just give a bounding box o the constructor if you will only do this once.
    
    Parameters:
    
    bBox - specifying the bounding box with which all the returned features bounding boxes have a non-empty intersection.
    
    Returns:
    
    a new list of features in the shapefile whose bounding boxes intersect the specified bounding box.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - main
```
public static void main(java.lang.String[] args)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException

Class EsriShapefile

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EsriShapefile

EsriShapefile

EsriShapefile

EsriShapefile

EsriShapefile

EsriShapefile

EsriShapefile

EsriShapefile

EsriShapefile

Method Detail

percentRead

getNumFeatures

getVersion

getBoundingBox

getFeatures

getFeatures

toString

main