• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• DataNode.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

generated.docs.javadoc.org.eclipse.dawnsci.analysis.api.tree.DataNode.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.eclipse.dawnsci.analysis.api.tree
Interface DataNode






All Superinterfaces:
Node


All Known Implementing Classes:
DataNodeImpl




public interface DataNode
extends Node
Node that holds data











Field Summary




Fields inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
ATTRIBUTE, SEPARATOR








Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


long[]
getChunkShape() 


ILazyDataset
getDataset()
Returns the dataset for the data node.



long[]
getMaxShape() 


int
getMaxStringLength()
Get maximum length of any string contained in node when it is encoded as bytes



int
getRank()
Get the rank of the dataset



java.lang.String
getString()
Get a string if this dataset is a string or dataset



java.lang.String
getTypeName() 


ILazyWriteableDataset
getWriteableDataset()
Returns the ILazyWriteableDataset for the data node
 This can return null if the dataset for this datanode is not writeable or is empty



boolean
isAugmented() 


boolean
isString() 


boolean
isSupported() 


boolean
isUnsigned() 


void
setAugmented()
Set state to indicate dataset has been augmented with metadata



void
setChunkShape(long... chunkShape)
Set chunk shape of dataset



void
setDataset(ILazyDataset lazyDataset)
Set given (lazy) dataset



void
setEmpty()
Set dataset to be empty



void
setMaxShape(long... maxShape)
Set maximum shape of dataset



void
setMaxStringLength(int length)
Set maximum length of any string contained in node when it is encoded as bytes



void
setString(java.lang.String text)
Set string



void
setTypeName(java.lang.String name)
Set HDF5 type name



void
setUnsigned(boolean isUnsigned) 






Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isGroupNode, isSymbolicNode














Method Detail





isUnsigned
boolean isUnsigned()

Returns:
true if data is unsigned








setUnsigned
void setUnsigned(boolean isUnsigned)

Parameters:
isUnsigned - 








isString
boolean isString()

Returns:
true if data is string data








getTypeName
java.lang.String getTypeName()

Returns:
HDF5 type name








setTypeName
void setTypeName(java.lang.String name)
Set HDF5 type name

Parameters:
name - 








getMaxShape
long[] getMaxShape()

Returns:
maximum shape (can be null)








setMaxShape
void setMaxShape(long... maxShape)
Set maximum shape of dataset

Parameters:
maxShape - 








getChunkShape
long[] getChunkShape()

Returns:
chunk shape (can be null)








setChunkShape
void setChunkShape(long... chunkShape)
Set chunk shape of dataset

Parameters:
chunkShape - 








getRank
int getRank()
Get the rank of the dataset

Returns:
rank








isSupported
boolean isSupported()

Returns:
true if this dataset is supported








setEmpty
void setEmpty()
Set dataset to be empty







getString
java.lang.String getString()
Get a string if this dataset is a string or dataset

Returns:
string or null








setString
void setString(java.lang.String text)
Set string

Parameters:
text - 








getMaxStringLength
int getMaxStringLength()
Get maximum length of any string contained in node when it is encoded as bytes

Returns:
length in bytes or -1 if not a string








setMaxStringLength
void setMaxStringLength(int length)
Set maximum length of any string contained in node when it is encoded as bytes

Parameters:
length - in bytes








getDataset
ILazyDataset getDataset()
Returns the dataset for the data node.
 This can return null for empty datasets

Returns:
lazy dataset








getWriteableDataset
ILazyWriteableDataset getWriteableDataset()
Returns the ILazyWriteableDataset for the data node
 This can return null if the dataset for this datanode is not writeable or is empty

Returns:
lazy writeable dataset








setDataset
void setDataset(ILazyDataset lazyDataset)
Set given (lazy) dataset

Parameters:
lazyDataset - 








isAugmented
boolean isAugmented()

Returns:
true if dataset has been augmented with metadata








setAugmented
void setAugmented()
Set state to indicate dataset has been augmented with metadata













Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method