org.tinfour.demo.utils

Class VertexLoaderShapefile

java.lang.Object

org.tinfour.demo.utils.VertexLoaderShapefile

All Implemented Interfaces:

Closeable, AutoCloseable

public class VertexLoaderShapefile
extends Object
implements Closeable

A utility for loading vertices from a file for testing

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close()
double	getGeoOffsetX()
double	getGeoOffsetY()
double	getGeoScaleX()
double	getGeoScaleY()
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>	loadVertices(String dbfFieldForZ) Read the records from the Shapefile and use them to populate vertices.

Methods inherited from class java.lang.Object

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

Constructor Detail

VertexLoaderShapefile

public VertexLoaderShapefile(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

getXMin

public double getXMin()

Gets the minimum x coordinate in the sample

Returns:

a valid floating point value

getXMax

public double getXMax()

Gets the maximum x coordinate in the sample

Returns:

a valid floating point value

getYMin

public double getYMin()

Gets the minimum y coordinate in the sample

Returns:

a valid floating point value

getYMax

public double getYMax()

Gets the maximum y coordinate in the sample

Returns:

a valid floating point value

getZMin

public double getZMin()

Gets the minimum z coordinate in the sample

Returns:

a valid floating point value

getZMax

public double getZMax()

Gets the maximum z coordinate in the sample

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

Returns:

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

getGeoScaleX

public double getGeoScaleX()

getGeoScaleY

public double getGeoScaleY()

getGeoOffsetX

public double getGeoOffsetX()

getGeoOffsetY

public double getGeoOffsetY()

loadVertices

public List<Vertex> loadVertices(String dbfFieldForZ)
                          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.

Parameters:

dbfFieldForZ - the name of the DBF field to use as a z value; use a null or empty string to use the z coordinates form the Shapefile.

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