org.tinfour.demo.utils.cdt

Class ConstraintLoader

java.lang.Object

org.tinfour.demo.utils.cdt.ConstraintLoader

public class ConstraintLoader
extends Object

Provides tools for loading constraints from either a Shapefile or a text file.

Constructor Summary

Constructors

Constructor and Description
ConstraintLoader()

Method Summary

Modifier and Type	Method and Description
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<org.tinfour.common.IConstraint>	readConstraintsFile(File file) Reads the content of a constraints file which may be either a Shapefile or a text file in the supported format.
void	setCoordinateTransform(org.tinfour.utils.loaders.ICoordinateTransform transform) Set a coordinate transform to be applied to the input coordinates.
static void	writeConstraintFile(File file, List<org.tinfour.common.IConstraint> list) Writes a text file representing the content of the specified list of constraints
static void	writeConstraintFile(Path path, List<org.tinfour.common.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

ConstraintLoader

public ConstraintLoader()

Method Detail

readConstraintsFile

public List<org.tinfour.common.IConstraint> readConstraintsFile(File file)
                                                         throws IOException

Reads the content of a constraints file which may be either a Shapefile or a text file in the supported format. Note that not all Shapefile types are supported.

Parameters:

file - a valid file.

Returns:

a valid list of constraint instances.

Throws:

IOException - in the event of a format violation or unrecoverable I/O exception.

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<org.tinfour.common.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<org.tinfour.common.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

setCoordinateTransform

public void setCoordinateTransform(org.tinfour.utils.loaders.ICoordinateTransform transform)

Set a coordinate transform to be applied to the input coordinates.

Parameters:

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