Package qupath.lib.images.servers

Class JsonImageServerBuilder

java.lang.Object

qupath.lib.images.servers.JsonImageServerBuilder

All Implemented Interfaces:

ImageServerBuilder<BufferedImage>

public class JsonImageServerBuilder
extends Object
implements ImageServerBuilder<BufferedImage>

ImageServerBuilder that constructs an ImageServer from a JSON representation.

Author:

Pete Bankhead

Nested Class Summary

Nested classes/interfaces inherited from interface qupath.lib.images.servers.ImageServerBuilder

ImageServerBuilder.AbstractServerBuilder<T>, ImageServerBuilder.DefaultImageServerBuilder<T>, ImageServerBuilder.ServerBuilder<T>, ImageServerBuilder.UriImageSupport<T>

Constructor Summary

Constructors

Constructor	Description
JsonImageServerBuilder()

Method Summary

Modifier and Type	Method	Description
ImageServer<BufferedImage>	buildServer(URI uri, String... args)	Attempt to create ImageServer<T> from the specified path.
ImageServerBuilder.UriImageSupport<BufferedImage>	checkImageSupport(URI uri, String... args)	Check whether a URI is supported by this builder.
String	getDescription()	Get a short, human-readable description for display in a GUI.
Class<BufferedImage>	getImageType()	Returns the base class for the images supported by this server.
String	getName()	Get a human-readable name for the kind of ImageServer this builds.

Methods inherited from class java.lang.Object

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

Methods inherited from interface qupath.lib.images.servers.ImageServerBuilder

matchClassName

Constructor Details

JsonImageServerBuilder

public JsonImageServerBuilder()

Method Details

checkImageSupport

public ImageServerBuilder.UriImageSupport<BufferedImage> checkImageSupport(URI uri,
 String... args)

Description copied from interface: ImageServerBuilder

Check whether a URI is supported by this builder.

This can be used to gain an estimate of how well the format is supported, and the number of images found.

Specified by:

checkImageSupport in interface ImageServerBuilder<BufferedImage>

Parameters:

uri -

args - optional String args (may be ignored)

Returns:

buildServer

public ImageServer<BufferedImage> buildServer(URI uri,
 String... args)
                                       throws Exception

Description copied from interface: ImageServerBuilder

Attempt to create ImageServer<T> from the specified path.

Specified by:

buildServer in interface ImageServerBuilder<BufferedImage>

Parameters:

uri -

args - optional String arguments that may be used by the builder.

Returns:

Throws:

Exception

getName

public String getName()

Description copied from interface: ImageServerBuilder

Get a human-readable name for the kind of ImageServer this builds.

Specified by:

getName in interface ImageServerBuilder<BufferedImage>

Returns:

getDescription

public String getDescription()

Description copied from interface: ImageServerBuilder

Get a short, human-readable description for display in a GUI.

Specified by:

getDescription in interface ImageServerBuilder<BufferedImage>

Returns:

getImageType

public Class<BufferedImage> getImageType()

Description copied from interface: ImageServerBuilder

Returns the base class for the images supported by this server. Typically this is BufferedImage.class.

Specified by:

getImageType in interface ImageServerBuilder<BufferedImage>

Returns: