Package net.algart.matrices.maps.pyramids.io.api.sources

Class ImageIOPlanePyramidSourceFactory

java.lang.Object

net.algart.matrices.maps.pyramids.io.api.sources.ImageIOPlanePyramidSourceFactory

All Implemented Interfaces:

AutoCloseable, PlanePyramidSourceFactory

public class ImageIOPlanePyramidSourceFactory
extends Object
implements PlanePyramidSourceFactory

Nested Class Summary

Nested classes/interfaces inherited from interface net.algart.matrices.maps.pyramids.io.api.PlanePyramidSourceFactory

PlanePyramidSourceFactory.Unsupported

Constructor Summary

Constructors

Constructor	Description
ImageIOPlanePyramidSourceFactory()

Method Summary

Modifier and Type	Method	Description
PlanePyramidSource	newPlanePyramidSource(String pyramidPath, String pyramidConfiguration, String renderingConfiguration)	Creates new plane pyramid source, providing access to the pyramid, stored in the given place, with possible using additional recommendations, described in pyramidConfiguration and renderingConfiguration arguments.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.algart.matrices.maps.pyramids.io.api.PlanePyramidSourceFactory

close

Constructor Details

ImageIOPlanePyramidSourceFactory

public ImageIOPlanePyramidSourceFactory()

Method Details

newPlanePyramidSource

public PlanePyramidSource newPlanePyramidSource(String pyramidPath,
 String pyramidConfiguration,
 String renderingConfiguration)
                                         throws IOException

Description copied from interface: PlanePyramidSourceFactory

Creates new plane pyramid source, providing access to the pyramid, stored in the given place, with possible using additional recommendations, described in pyramidConfiguration and renderingConfiguration arguments.

The pyramidPath can be any specifier of some external resource, like URL, but usually it is a path to some disk file or subdirectory (for example, a path to .TIFF file).

The pyramidConfiguration and renderingConfiguration arguments can use any format, but we recommend to use JSON format for this string. Most existing implementations expect correct JSON format here. Syntax errors in this file should be ignored or lead to IOException, like format errors in the data file.

Specified by:

newPlanePyramidSource in interface PlanePyramidSourceFactory

Parameters:

pyramidPath - path to an external resource, where the pyramid is stored; usually a disk path to some directory.

pyramidConfiguration - some additional information, describing the pyramid and necessary behaviour of the resulting pyramid source, which relates to the given data and cannot be changed dynamically.

renderingConfiguration - some additional information for customizing behaviour of the resulting pyramid source, which can vary in future for the same data file.

Returns:

new pyramid source, providing access to the pyramid at the specified path.

Throws:

IOException - if some I/O problems occur while opening pyramid, and also in a case of invalid format of the files containing the pyramid or of the passed renderingConfiguration description.