org.tinfour.gis.utils

Class ConstraintReaderShapefile

java.lang.Object

org.tinfour.gis.utils.ConstraintReaderShapefile

All Implemented Interfaces:

Closeable, AutoCloseable

public class ConstraintReaderShapefile
extends Object
implements Closeable

Provides tools for reading constraints from either a Shapefile

Constructor Summary

Constructors

Constructor and Description
ConstraintReaderShapefile(File file) Constructs an instance tied to the specified file.

Method Summary

Modifier and Type	Method and Description
void	close()
ICoordinateTransform	getCoordinateTransform() Gets the coordinate transform associated with this instance.
int	getTotalPointCount() Gets the total number of points read from the constraint file; or zero if the content of the constraint file hasn't been read.
List<IConstraint>	read() Read constraints from a Shapefile.
void	setCoordinateTransform(ICoordinateTransform transform) Sets a coordinate transform to be used for mapping values from the source file to vertex coordinates.
void	setDbfFieldForAppData(String dbfFieldForAppData) Sets the name of the field in the DBF file to use as a source for application data when creating constraints.
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).
static void	writeConstraintFile(File file, List<IConstraint> list) Writes a text file representing the content of the specified list of constraints
static void	writeConstraintFile(Path path, List<IConstraint> list) Writes a text file representing the content of the specified list of constraints

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstraintReaderShapefile

public ConstraintReaderShapefile(File file)
                          throws IOException

Constructs an instance tied to the specified file.

Parameters:

file - a valid file reference pointing to a Shapefile.

Throws:

IOException - if the specified Shapefile cannot be accessed.

Method Detail

read

public List<IConstraint> read()
                       throws IOException

Read constraints from a Shapefile. Values for the Z coordinate will be read from either the Shapefile geometry or from the DBF file if a field name was specified. Application data for the constraints will be either the Shapefile record number, or will be read from the DBF file if an application-data field name was specified.

Returns:

a valid, potentially empty list

Throws:

IOException - in the event of an unrecoverable IO condition.

getTotalPointCount

public int getTotalPointCount()

Gets the total number of points read from the constraint file; or zero if the content of the constraint file hasn't been read.

Returns:

a positive integer.

writeConstraintFile

public static void writeConstraintFile(File file,
                                       List<IConstraint> list)
                                throws IOException

Writes a text file representing the content of the specified list of constraints

Parameters:

file - the output file reference

list - a valid list of constraints

Throws:

IOException - in the event of a non-recoverable I/O condition

writeConstraintFile

public static void writeConstraintFile(Path path,
                                       List<IConstraint> list)
                                throws IOException

Writes a text file representing the content of the specified list of constraints

Parameters:

path - the path for writing the file

list - a valid list of constraints

Throws:

IOException - in the event of a non-recoverable I/O condition

getCoordinateTransform

public ICoordinateTransform getCoordinateTransform()

Gets the coordinate transform associated with this instance. May be null if no coordinate transform was set.

Returns:

a valid transform or a null if none was set.

setCoordinateTransform

public void setCoordinateTransform(ICoordinateTransform transform)

Sets a coordinate transform to be used for mapping values from the source file to vertex coordinates.

Parameters:

transform - a valid transform or a null if none is to be applied.

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.

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).

setDbfFieldForAppData

public void setDbfFieldForAppData(String dbfFieldForAppData)

Sets the name of the field in the DBF file to use as a source for application data when creating constraints.

Parameters:

dbfFieldForAppData - a valid string, or a null to use the the Shapefile record number as the application data.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException