org.janelia.saalfeldlab.n5.universe.metadata

Class N5CosemMetadataParser

java.lang.Object

org.janelia.saalfeldlab.n5.universe.metadata.N5CosemMetadataParser

All Implemented Interfaces:

BiFunction<org.janelia.saalfeldlab.n5.N5Reader,N5TreeNode,Optional<N5CosemMetadata>>, N5MetadataParser<N5CosemMetadata>, N5MetadataWriter<N5CosemMetadata>

public class N5CosemMetadataParser
extends Object
implements N5MetadataParser<N5CosemMetadata>, N5MetadataWriter<N5CosemMetadata>

The N5MetadataParser for N5CosemMetadata.

Author:

John Bogovic

See Also:

https://www.janelia.org/project-team/cosem

Constructor Summary

Constructors

Constructor and Description
N5CosemMetadataParser()

Method Summary

Modifier and Type	Method and Description
Optional<N5CosemMetadata>	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.
void	writeMetadata(N5CosemMetadata t, org.janelia.saalfeldlab.n5.N5Writer n5, String group) Writes metadata to a dataset or group in an N5 container.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.janelia.saalfeldlab.n5.universe.metadata.N5MetadataParser

apply, parseDatasetAttributes, parseMetadata

Methods inherited from interface java.util.function.BiFunction

andThen

Constructor Detail

N5CosemMetadataParser

public N5CosemMetadataParser()

Method Detail

parseMetadata

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

Description copied from interface: N5MetadataParser

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).

Specified by:

parseMetadata in interface N5MetadataParser<N5CosemMetadata>

Parameters:

n5 - the reader

node - list of tree nodes

Returns:

the metadata

writeMetadata

public void writeMetadata(N5CosemMetadata t,
                          org.janelia.saalfeldlab.n5.N5Writer n5,
                          String group)
                   throws Exception

Description copied from interface: N5MetadataWriter

Writes metadata to a dataset or group in an N5 container.

Specified by:

writeMetadata in interface N5MetadataWriter<N5CosemMetadata>

Parameters:

t - metadata

n5 - the n5 writer

group - the path relative to the container root of the group or dataset

Throws:

Exception - the exception