com.vividsolutions.jump.io

Class ShapefileReader

java.lang.Object

com.vividsolutions.jump.io.AbstractJUMPReader

com.vividsolutions.jump.io.ShapefileReader

All Implemented Interfaces:

JUMPReader

public class ShapefileReader
extends AbstractJUMPReader

ShapefileReader is a JUMPReader specialized to read Shapefiles.

DataProperties for the JUMPReader load(DataProperties) interface:

Parameter	Meaning
InputFile or DefaultValue	File name for the input .shp file
NOTE: The input .dbf is assumed to be 'beside' (in the same directory) as the .shp file.
CompressedFile	File name (.zip or .tgz NOT a .gz) with .shp and .dbf file inside
Uses a modified version of geotools to do the .dbf and .shp file reading. If you are reading from a .zip file, the dbf file will be copied to your temp directory and deleted after being read.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPRESSED_FILE_PROPERTY_KEY
static java.lang.String	DEFAULT_VALUE_PROPERTY_KEY
static java.lang.String	FILE_PROPERTY_KEY

Constructor Summary

Constructors

Constructor and Description
ShapefileReader() Creates new ShapeReader

Method Summary

Methods

Modifier and Type	Method and Description
protected DbfFile	getDbfFile(java.lang.String srcFileName, java.lang.String compressedFname) Get's a DbfFile.
protected DbfFile	getDbfFile(java.lang.String srcFileName, java.lang.String compressedFname, java.nio.charset.Charset charset)
protected Shapefile	getShapefile(java.lang.String shpfileName, java.lang.String compressedFname)
FeatureCollection	read(DriverProperties dp) Main method to read a shapefile.

Methods inherited from class com.vividsolutions.jump.io.AbstractJUMPReader

getExceptions

Methods inherited from class java.lang.Object

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

Field Detail

FILE_PROPERTY_KEY

public static final java.lang.String FILE_PROPERTY_KEY

See Also:

Constant Field Values

DEFAULT_VALUE_PROPERTY_KEY

public static final java.lang.String DEFAULT_VALUE_PROPERTY_KEY

See Also:

Constant Field Values

COMPRESSED_FILE_PROPERTY_KEY

public static final java.lang.String COMPRESSED_FILE_PROPERTY_KEY

See Also:

Constant Field Values

Constructor Detail

ShapefileReader

public ShapefileReader()

Creates new ShapeReader

Method Detail

read

public FeatureCollection read(DriverProperties dp)
                       throws IllegalParametersException,
                              java.lang.Exception

Main method to read a shapefile. Most of the work is done in the org.geotools.* package.

Specified by:

read in interface JUMPReader

Specified by:

read in class AbstractJUMPReader

Parameters:

dp - 'InputFile' or 'DefaultValue' to specify output .shp file.

Returns:

a FeatureCollection created from .shp and .dbf (dbf is optional)

Throws:

IllegalParametersException

java.lang.Exception

getShapefile

protected Shapefile getShapefile(java.lang.String shpfileName,
                     java.lang.String compressedFname)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getDbfFile

protected DbfFile getDbfFile(java.lang.String srcFileName,
                 java.lang.String compressedFname)
                      throws java.lang.Exception

Get's a DbfFile. For compatibilty reasons, this method is a wrapper to the new with Charset functions.

Parameters:

srcFileName - either a pass to a dbf or an archive file (*.zip etc.) accompanied by the compressedFname it contains

compressedFname -

Returns:

a DbfFile object for the dbf file named FileName

Throws:

java.lang.Exception

getDbfFile

protected DbfFile getDbfFile(java.lang.String srcFileName,
                 java.lang.String compressedFname,
                 java.nio.charset.Charset charset)
                      throws java.lang.Exception

Throws:

java.lang.Exception