org.janelia.saalfeldlab.n5.universe.translation

Class TranslatedTreeMetadataParser

java.lang.Object

org.janelia.saalfeldlab.n5.universe.metadata.canonical.CanonicalMetadataParser

org.janelia.saalfeldlab.n5.universe.translation.TranslatedTreeMetadataParser

All Implemented Interfaces:

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

public class TranslatedTreeMetadataParser
extends CanonicalMetadataParser

A parser for metadata that are translated into the "canonical" dialect.

Author:

John Bogovic

Field Summary

Fields inherited from class org.janelia.saalfeldlab.n5.universe.metadata.canonical.CanonicalMetadataParser

filter, gson, root

Constructor Summary

Constructors

Constructor and Description
TranslatedTreeMetadataParser(org.janelia.saalfeldlab.n5.N5Reader n5, String n5Tree, String translation)
TranslatedTreeMetadataParser(String translation)
TranslatedTreeMetadataParser(String translation, Predicate<CanonicalMetadata> filter)

Method Summary

Modifier and Type	Method and Description
CanonicalMetadata	canonicalMetadata(HashMap<String,com.google.gson.JsonElement> attrMap)
Optional<CanonicalMetadata>	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.
Optional<CanonicalMetadata>	parseMetadata(org.janelia.saalfeldlab.n5.N5Reader n5, String dataset)
Optional<CanonicalMetadata>	parseMetadata(N5TreeNode node, String groupSep)
Optional<CanonicalMetadata>	parseMetadata(String dataset, String groupSep)
protected void	setup(org.janelia.saalfeldlab.n5.N5Reader n5)
boolean	validTranslation()

Methods inherited from class org.janelia.saalfeldlab.n5.universe.metadata.canonical.CanonicalMetadataParser

buildRootScope, datasetAttributes, getGson, setFilter, setGson

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

Methods inherited from interface java.util.function.BiFunction

andThen

Constructor Detail

TranslatedTreeMetadataParser

public TranslatedTreeMetadataParser(String translation)

TranslatedTreeMetadataParser

public TranslatedTreeMetadataParser(String translation,
                                    Predicate<CanonicalMetadata> filter)

TranslatedTreeMetadataParser

public TranslatedTreeMetadataParser(org.janelia.saalfeldlab.n5.N5Reader n5,
                                    String n5Tree,
                                    String translation)

Method Detail

validTranslation

public boolean validTranslation()

setup

protected void setup(org.janelia.saalfeldlab.n5.N5Reader n5)

Overrides:

setup in class CanonicalMetadataParser

parseMetadata

public Optional<CanonicalMetadata> 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<CanonicalMetadata>

Overrides:

parseMetadata in class CanonicalMetadataParser

Parameters:

n5 - the reader

node - list of tree nodes

Returns:

the metadata

parseMetadata

public Optional<CanonicalMetadata> parseMetadata(org.janelia.saalfeldlab.n5.N5Reader n5,
                                                 String dataset)

parseMetadata

public Optional<CanonicalMetadata> parseMetadata(String dataset,
                                                 String groupSep)

Overrides:

parseMetadata in class CanonicalMetadataParser

parseMetadata

public Optional<CanonicalMetadata> parseMetadata(N5TreeNode node,
                                                 String groupSep)

Overrides:

parseMetadata in class CanonicalMetadataParser

canonicalMetadata

public CanonicalMetadata canonicalMetadata(HashMap<String,com.google.gson.JsonElement> attrMap)

Overrides:

canonicalMetadata in class CanonicalMetadataParser