org.janelia.saalfeldlab.n5.universe.metadata

Interface N5MetadataParser<T extends N5Metadata>

All Superinterfaces:

BiFunction<org.janelia.saalfeldlab.n5.N5Reader,N5TreeNode,Optional<T>>

All Known Implementing Classes:

AbstractMetadataTemplateParser, CanonicalMetadataParser, DefaultAxisMetadataParser, DefaultDatasetAxisMetadataParser, MultiResolutionSpatialMetadataCanonicalParser, N5CosemMetadataParser, N5CosemMultiScaleMetadata.CosemMultiScaleParser, N5GenericSingleScaleMetadataParser, N5MultiScaleMetadata.MultiScaleParser, N5SingleScaleMetadataParser, N5ViewerMultiscaleMetadataParser, OmeNgffMetadataParser, SpatialMetadataTemplateCanonical, TranslatedTreeMetadataParser

public interface N5MetadataParser<T extends N5Metadata>
extends BiFunction<org.janelia.saalfeldlab.n5.N5Reader,N5TreeNode,Optional<T>>

Interface for reading metadata from N5 containers.

Author:

Caleb Hulbert, John Bogovic

Method Summary

Modifier and Type	Method and Description
default Optional<T>	apply(org.janelia.saalfeldlab.n5.N5Reader n5Reader, N5TreeNode n5TreeNode)
static org.janelia.saalfeldlab.n5.DatasetAttributes	parseDatasetAttributes(org.janelia.saalfeldlab.n5.N5Reader n5, N5TreeNode node)
Optional<T>	parseMetadata(org.janelia.saalfeldlab.n5.N5Reader n5, N5TreeNode node) Called by the N5DatasetDiscoverer while discovering the N5 tree and filling the metadata for datasets or groups.
default Optional<T>	parseMetadata(org.janelia.saalfeldlab.n5.N5Reader n5, String dataset)

Methods inherited from interface java.util.function.BiFunction

andThen

Method Detail

parseDatasetAttributes

static org.janelia.saalfeldlab.n5.DatasetAttributes parseDatasetAttributes(org.janelia.saalfeldlab.n5.N5Reader n5,
                                                                           N5TreeNode node)

parseMetadata

Optional<T> parseMetadata(org.janelia.saalfeldlab.n5.N5Reader n5,
                          N5TreeNode node)

Called by the N5DatasetDiscoverer while discovering the N5 tree and filling the metadata for datasets or groups.

The metadata parsing is done in the bottom-up fashion, so the children of the given node have already been processed and should already contain valid metadata (if any).

Parameters:

n5 - the reader

node - list of tree nodes

Returns:

the metadata

parseMetadata

default Optional<T> parseMetadata(org.janelia.saalfeldlab.n5.N5Reader n5,
                                  String dataset)

apply

default Optional<T> apply(org.janelia.saalfeldlab.n5.N5Reader n5Reader,
                          N5TreeNode n5TreeNode)

Specified by:

apply in interface BiFunction<org.janelia.saalfeldlab.n5.N5Reader,N5TreeNode,Optional<T extends N5Metadata>>