EsriShapefile (Unidata IDV API v6.3)

java.lang.Object
- ucar.unidata.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

Author:

Russ Rew

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.EsriPointZ` Class description
`class`	`EsriShapefile.EsriPolygon` Represents a Polygon in an ESRI shapefile as a List of GisParts.
`class`	`EsriShapefile.EsriPolygonZ` Represents a PolygonZ in an ESRI shapefile as a List of GisParts.
`class`	`EsriShapefile.EsriPolyline` Represents a Polyline in an ESRI shapefile as a List of GisParts.
`class`	`EsriShapefile.EsriPolylineZ` Class description

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MULTIPATCH` muti patch
`static int`	`MULTIPOINT` multipoint shape
`static int`	`MULTIPOINTM` Measured multi point
`static int`	`MULTIPOINTZ` multipoint with z
`static int`	`NULL` null shape
`static int`	`POINT` point shape
`static int`	`POINTM` Measured point
`static int`	`POINTZ` point with Z
`static int`	`POLYGON` polygon shape
`static int`	`POLYGONM` Measured polygon
`static int`	`POLYGONZ` polygon with z
`static int`	`POLYLINE` polyline shape
`static int`	`POLYLINEM` Measured polyline
`static int`	`POLYLINEZ` polyline with z
`static int`	`SHAPEFILE_CODE` shapefile magic number

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 Deprecated Methods
Modifier and Type	Method and Description
`java.awt.geom.Rectangle2D`	`getBoundingBox()` Get bounding box, according to file (not computed from features)
`DbaseFile`	`getDbFile()` Get the Dbase file object
`java.util.List`	`getFeatures()` Get a List of all the GisFeatures in the shapefile.
`java.util.List`	`getFeatures(java.awt.geom.Rectangle2D bBox)` Get a List of all the features in the shapefile that intersect the specified bounding box.
`int`	`getFeatureType()` Get the feature type
`int`	`getNumFeatures()`
`ProjFile`	`getProjFile()` Get the projection file
`int`	`getVersion()` Returns shapefile format version (currently 1000)
`static void`	`main(java.lang.String[] args)` The main method.
`int`	`numShapes()` Deprecated.
`double`	`percentRead()` Return percent of file read, so far.

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

- Field Detail
  - SHAPEFILE_CODE
```
public static final int SHAPEFILE_CODE
```
    shapefile magic number
    
    See Also:
    
    Constant Field Values
  - NULL
```
public static final int NULL
```
    null shape
    
    See Also:
    
    Constant Field Values
  - POINT
```
public static final int POINT
```
    point shape
    
    See Also:
    
    Constant Field Values
  - POLYLINE
```
public static final int POLYLINE
```
    polyline shape
    
    See Also:
    
    Constant Field Values
  - POLYGON
```
public static final int POLYGON
```
    polygon shape
    
    See Also:
    
    Constant Field Values
  - MULTIPOINT
```
public static final int MULTIPOINT
```
    multipoint shape
    
    See Also:
    
    Constant Field Values
  - POINTZ
```
public static final int POINTZ
```
    point with Z
    
    See Also:
    
    Constant Field Values
  - POLYLINEZ
```
public static final int POLYLINEZ
```
    polyline with z
    
    See Also:
    
    Constant Field Values
  - POLYGONZ
```
public static final int POLYGONZ
```
    polygon with z
    
    See Also:
    
    Constant Field Values
  - MULTIPOINTZ
```
public static final int MULTIPOINTZ
```
    multipoint with z
    
    See Also:
    
    Constant Field Values
  - POINTM
```
public static final int POINTM
```
    Measured point
    
    See Also:
    
    Constant Field Values
  - POLYLINEM
```
public static final int POLYLINEM
```
    Measured polyline
    
    See Also:
    
    Constant Field Values
  - POLYGONM
```
public static final int POLYGONM
```
    Measured polygon
    
    See Also:
    
    Constant Field Values
  - MULTIPOINTM
```
public static final int MULTIPOINTM
```
    Measured multi point
    
    See Also:
    
    Constant Field Values
  - MULTIPATCH
```
public static final int MULTIPATCH
```
    muti patch
    
    See Also:
    
    Constant Field Values
- 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 - Signals that an I/O exception has occurred.
  - 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 - Signals that an I/O exception has occurred.
  - 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 - Signals that an I/O exception has occurred.
  - 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 - Signals that an I/O exception has occurred.
  - 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 - Signals that an I/O exception has occurred.
  - 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 - Signals that an I/O exception has occurred.
  - 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 - Signals that an I/O exception has occurred.
  - 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 - Signals that an I/O exception has occurred.
  - 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
    
    coarseness - the coarseness
    
    Throws:
    
    java.io.IOException - Signals that an I/O exception has occurred.
- Method Detail
  - getDbFile
```
public DbaseFile getDbFile()
```
    Get the Dbase file object
    
    Returns:
    
    the DbaseFile object; may be null
  - getProjFile
```
public ProjFile getProjFile()
```
    Get the projection file
    
    Returns:
    
    the projection file; may be null
  - 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
  - numShapes
```
public int numShapes()
```
    Deprecated.
    
    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 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.
  - getFeatureType
```
public int getFeatureType()
```
    Get the feature type
    
    Returns:
    
    the type
  - main
```
public static void main(java.lang.String[] args)
                 throws java.io.IOException
```
    The main method.
    
    Parameters:
    
    args - the arguments
    
    Throws:
    
    java.io.IOException - Signals that an I/O exception has occurred.

Class EsriShapefile

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SHAPEFILE_CODE

NULL

POINT

POLYLINE

POLYGON

MULTIPOINT

POINTZ

POLYLINEZ

POLYGONZ

MULTIPOINTZ

POINTM

POLYLINEM

POLYGONM

MULTIPOINTM

MULTIPATCH

Constructor Detail

EsriShapefile

EsriShapefile

EsriShapefile

EsriShapefile

EsriShapefile

EsriShapefile

EsriShapefile

EsriShapefile

EsriShapefile

Method Detail

getDbFile

getProjFile

percentRead

getNumFeatures

numShapes

getVersion

getBoundingBox

getFeatures

getFeatures

getFeatureType

main