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

Interface PlanePyramidSourceFactory

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ImageIOPlanePyramidSourceFactory, PlanePyramidSourceFactory.Unsupported

public interface PlanePyramidSourceFactory
extends AutoCloseable

Factory allowing to construct PlanePyramidSource instance on the base of the path to an external resource, where the pyramid is stored, and some additional configuration information. This interface should have different implementations for different formats of image pyramids.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PlanePyramidSourceFactory.Unsupported

Method Summary

Modifier and Type	Method	Description
default void	close()	Frees resources, possibly associated with this factory and probably necessary for plane pyramid sources, created by it.
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.

Method Details

newPlanePyramidSource

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

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.

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:

NullPointerException - if one of the arguments is null.

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.

close

default void close()

Frees resources, possibly associated with this factory and probably necessary for plane pyramid sources, created by it. We mention resources, shared between many plane pyramid sources of this type, like cache, service threads etc. — not resources, associated with a specific pyramid (like opened file).

Note: after calling this method, all plane pyramid sources, created by this factory, can work incorrectly!

Default implementation of this method does nothing.

Specified by:

close in interface AutoCloseable