Package org.tinfour.utils.loaders

Interface IVertexReader

  • All Known Implementing Classes:
    VertexReaderText
    public interface IVertexReader
    Defines methods to be used for reading a set of vertices from various input sources.

    • Method Detail

      • getCoordinateTransform

        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.

      • getXMax

        double getXMax()
        Gets the maximum x coordinate in the sample
        Returns:
        a valid floating point value

      • getXMin

        double getXMin()
        Gets the minimum x coordinate in the sample
        Returns:
        a valid floating point value

      • getYMax

        double getYMax()
        Gets the maximum y coordinate in the sample
        Returns:
        a valid floating point value

      • getYMin

        double getYMin()
        Gets the minimum y coordinate in the sample
        Returns:
        a valid floating point value

      • getZMax

        double getZMax()
        Gets the maximum z coordinate in the sample
        Returns:
        a valid floating point value

      • getZMin

        double getZMin()
        Gets the minimum z coordinate in the sample
        Returns:
        a valid floating point value

      • isSourceInGeographicCoordinates

        boolean isSourceInGeographicCoordinates()
        Indicates whether the source data was in geographic coordinates
        Returns:
        true if the source data used geographic coordinates; otherwise, false.

      • read

        List<Vertex> read​(IMonitorWithCancellation monitor)
           throws IOException
        Read a collection of vertices from the data source associated with the current implementation and instance.

        Monitoring Progress of the Read Because some input sources can produce quite a large number of vertices and may require several seconds for load operations, this interface supports an optional monitor object. Implementation classes are not required to support monitors, but should do so if it is feasible. The Tinfour monitor is intended to support two operations. First, it provides a read operation a mechanism for advising the calling application on the status of its progress. Second, it provides the calling application a mechanism for canceling a read operation. These operations are generally used in support of a user interface, but may have other applications.

        All implementations are expected to implement logic to handle a null monitor reference.

        Parameters:
        monitor - a valid instance or a null if no monitoring is desired.
        Returns:
        a valid, potentially list
        Throws:
        IOException - in the event of unreadable data or I/O access exceptions.

      • setCoordinateTransform

        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.