org.janelia.saalfeldlab.n5.universe

Class N5TreeNode

java.lang.Object

org.janelia.saalfeldlab.n5.universe.N5TreeNode

public class N5TreeNode
extends Object

A node representing a dataset or group in an N5 container, and stores its corresponding N5Metadata, and child nodes if any exist.

Author:

Caleb Hulbert, John Bogovic

Constructor Summary

Constructors

Constructor and Description
N5TreeNode(String path)

Method Summary

Modifier and Type	Method and Description
void	add(N5TreeNode child) Adds a node as a child of this node.
N5TreeNode	addPath(String path) Adds a node at the specified full path and any parent nodes along the path, if they do not already exist.
N5TreeNode	addPath(String path, Function<String,N5TreeNode> constructor) Adds a node at the specified full path and any parent nodes along the path, if they do not already exist.
Optional<N5TreeNode>	child(String name)
List<N5TreeNode>	childrenList()
static Stream<N5TreeNode>	flattenN5Tree(N5TreeNode root)
static void	fromFlatList(N5TreeNode root, String[] pathList, String groupSeparator) Generates a tree based on the output of N5Reader.deepList(java.lang.String, java.util.function.Predicate<java.lang.String>), returning the root node.
static N5TreeNode	fromFlatList(String base, String[] pathList, String groupSeparator) Generates a tree based on the output of N5Reader.deepList(java.lang.String, java.util.function.Predicate<java.lang.String>), returning the root node.
Optional<N5TreeNode>	getDescendant(String path)
Stream<N5TreeNode>	getDescendants(Predicate<N5TreeNode> filter)
N5Metadata	getMetadata()
String	getNodeName()
String	getParentPath()
String	getPath()
boolean	isDataset()
String	printRecursive()
void	remove(N5TreeNode child)
void	removeAllChildren()
protected static String	removeLeadingSlash(String pathName) Removes the leading slash from a given path and returns the corrected path.
void	setMetadata(N5Metadata metadata)
boolean	structureEquals(N5TreeNode other)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

N5TreeNode

public N5TreeNode(String path)

Method Detail

flattenN5Tree

public static Stream<N5TreeNode> flattenN5Tree(N5TreeNode root)

getNodeName

public String getNodeName()

getParentPath

public String getParentPath()

add

public void add(N5TreeNode child)

Adds a node as a child of this node.

Parameters:

child - the child node

remove

public void remove(N5TreeNode child)

removeAllChildren

public void removeAllChildren()

childrenList

public List<N5TreeNode> childrenList()

child

public Optional<N5TreeNode> child(String name)

getDescendant

public Optional<N5TreeNode> getDescendant(String path)

addPath

public N5TreeNode addPath(String path)

Adds a node at the specified full path and any parent nodes along the path, if they do not already exist. Returns the node at the specified path.

Parameters:

path - the full path to node

Returns:

the node

addPath

public N5TreeNode addPath(String path,
                          Function<String,N5TreeNode> constructor)

Adds a node at the specified full path and any parent nodes along the path, if they do not already exist. Returns the node at the specified path.

Parameters:

path - the full path to node

constructor - function creating a node from a path

Returns:

the node

getDescendants

public Stream<N5TreeNode> getDescendants(Predicate<N5TreeNode> filter)

isDataset

public boolean isDataset()

setMetadata

public void setMetadata(N5Metadata metadata)

getMetadata

public N5Metadata getMetadata()

getPath

public String getPath()

toString

public String toString()

Overrides:

toString in class Object

structureEquals

public boolean structureEquals(N5TreeNode other)

printRecursive

public String printRecursive()

fromFlatList

public static N5TreeNode fromFlatList(String base,
                                      String[] pathList,
                                      String groupSeparator)

Generates a tree based on the output of N5Reader.deepList(java.lang.String, java.util.function.Predicate<java.lang.String>), returning the root node.

Parameters:

base - the path used to call deepList

pathList - the output of deepList

groupSeparator - the n5 group separator

Returns:

the root node

fromFlatList

public static void fromFlatList(N5TreeNode root,
                                String[] pathList,
                                String groupSeparator)

Generates a tree based on the output of N5Reader.deepList(java.lang.String, java.util.function.Predicate<java.lang.String>), returning the root node.

Parameters:

root - the root node corresponding to the base

pathList - the output of deepList

groupSeparator - the n5 group separator

removeLeadingSlash

protected static String removeLeadingSlash(String pathName)

Removes the leading slash from a given path and returns the corrected path. It ensures correctness on both Unix and Windows, otherwise pathName is treated as UNC path on Windows, and Paths.get(pathName, ...) fails with InvalidPathException.

Parameters:

pathName - the path

Returns:

the corrected path