org.tinfour.gis.utils

Class VertexReaderShapefile

java.lang.Object

org.tinfour.gis.utils.VertexReaderShapefile

All Implemented Interfaces:

Closeable, AutoCloseable, IVertexReader

public class VertexReaderShapefile
extends Object
implements IVertexReader, Closeable

A utility for loading vertices from a file for testing

Constructor Summary

Constructors

Constructor and Description
VertexReaderShapefile(File file) Construct an instance for the specified Shapefile

Method Summary

Modifier and Type	Method and Description
void	close()
ICoordinateTransform	getCoordinateTransform()
LinearUnits	getLinearUnits() Gets the linear units for the horizontal coordinate system from the Shapefile.
double	getTimeForLoad() Gets the total time to load a file (including the time required for pre-sort if enabled).
double	getXMax() Gets the maximum x coordinate in the sample
double	getXMin() Gets the minimum x coordinate in the sample
double	getYMax() Gets the maximum y coordinate in the sample
double	getYMin() Gets the minimum y coordinate in the sample
double	getZMax() Gets the maximum z coordinate in the sample
double	getZMin() Gets the minimum z coordinate in the sample
boolean	isSourceInGeographicCoordinates() Indicates whether the source data was in geographic coordinates
List<Vertex>	read(IMonitorWithCancellation monitor) Read the records from the Shapefile and use them to populate vertices.
void	setCoordinateTransform(ICoordinateTransform transform)
void	setDbfFieldForZ(String dbfFieldForZ) Sets the name of the field in the DBF file to use as a source for Z coordinates for data.
void	setVerticalCoordinateTransform(IVerticalCoordinateTransform verticalTransform) Sets the vertical coordinate transform to be used when reading the file (if any).

Methods inherited from class java.lang.Object

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

Constructor Detail

VertexReaderShapefile

public VertexReaderShapefile(File file)
                      throws IOException

Construct an instance for the specified Shapefile

Parameters:

file - a Shapefile reference

Throws:

IOException - in the event of an unrecoverable I/O condition

Method Detail

setDbfFieldForZ

public void setDbfFieldForZ(String dbfFieldForZ)

Sets the name of the field in the DBF file to use as a source for Z coordinates for data.

Parameters:

dbfFieldForZ - a valid string, or a null to use the Z coordinates from the Shapefile geometry file (the 0shp file).

setVerticalCoordinateTransform

public void setVerticalCoordinateTransform(IVerticalCoordinateTransform verticalTransform)

Sets the vertical coordinate transform to be used when reading the file (if any).

Parameters:

verticalTransform - a valid instance if a transform is to be applies; a null reference if no transform is required.

getXMin

public double getXMin()

Gets the minimum x coordinate in the sample

Specified by:

getXMin in interface IVertexReader

Returns:

a valid floating point value

getXMax

public double getXMax()

Gets the maximum x coordinate in the sample

Specified by:

getXMax in interface IVertexReader

Returns:

a valid floating point value

getYMin

public double getYMin()

Gets the minimum y coordinate in the sample

Specified by:

getYMin in interface IVertexReader

Returns:

a valid floating point value

getYMax

public double getYMax()

Gets the maximum y coordinate in the sample

Specified by:

getYMax in interface IVertexReader

Returns:

a valid floating point value

getZMin

public double getZMin()

Gets the minimum z coordinate in the sample

Specified by:

getZMin in interface IVertexReader

Returns:

a valid floating point value

getZMax

public double getZMax()

Gets the maximum z coordinate in the sample

Specified by:

getZMax in interface IVertexReader

Returns:

a valid floating point value

getTimeForLoad

public double getTimeForLoad()

Gets the total time to load a file (including the time required for pre-sort if enabled).

Returns:

a time in milliseconds

isSourceInGeographicCoordinates

public boolean isSourceInGeographicCoordinates()

Indicates whether the source data was in geographic coordinates

Specified by:

isSourceInGeographicCoordinates in interface IVertexReader

Returns:

true if the source data used geographic coordinates; otherwise, false.

read

public List<Vertex> read(IMonitorWithCancellation monitor)
                  throws IOException

Read the records from the Shapefile and use them to populate vertices. The loader has the option of loading the z coordinate from either the main Shapefile itself (the SHP file) or from the associated DBF file. If you wish to use a field in the DBF file as a z coordinate, specify the name of the field as an argument. If you wish to use the z coordinate from the Shapefile, specify a null or empty string. If a null or empty string is specified, and the Shapefile does not contain a feature type that provides z coordinates, the z coordinates will be uniformly populated with zeroes.

The index of the vertex is set to be the Shapefile record number. Thus many vertices may be assigned with the same record number, particularly if the input is a polygon or line feature.

Specified by:

read in interface IVertexReader

Parameters:

monitor - an optional progress monitor, or null if not required.

Returns:

a valid, potentially empty list of vertices

Throws:

IOException - in the event of an unrecoverable I/O condition

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getCoordinateTransform

public ICoordinateTransform getCoordinateTransform()

Specified by:

getCoordinateTransform in interface IVertexReader

setCoordinateTransform

public void setCoordinateTransform(ICoordinateTransform transform)

Specified by:

setCoordinateTransform in interface IVertexReader

getLinearUnits

public LinearUnits getLinearUnits()

Gets the linear units for the horizontal coordinate system from the Shapefile. This value is typically obtained from the PRJ file associated with the Shapefile.

Returns:

a valid enumeration instance