• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXrootImpl.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.nexus.impl.NXrootImpl.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.nexus.impl
Class NXrootImpl



java.lang.Object


org.eclipse.dawnsci.analysis.tree.impl.NodeImpl


org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl


org.eclipse.dawnsci.nexus.impl.NXobjectImpl


org.eclipse.dawnsci.nexus.impl.NXrootImpl













All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXobject, NXroot




public class NXrootImpl
extends NXobjectImpl
implements NXroot
Definition of the root NeXus group.

See Also:
Serialized Form












Field Summary

Fields 

Modifier and Type
Field and Description


static java.util.Set<NexusBaseClass>
PERMITTED_CHILD_GROUP_CLASSES 






Fields inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
NX_CLASS





Fields inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
attributes, id, INDENT





Fields inherited from interface org.eclipse.dawnsci.nexus.NXroot
NX_ATTRIBUTE_CREATOR, NX_ATTRIBUTE_DEFAULT, NX_ATTRIBUTE_FILE_NAME, NX_ATTRIBUTE_FILE_TIME, NX_ATTRIBUTE_FILE_UPDATE_TIME, NX_ATTRIBUTE_H5PY_VERSION, NX_ATTRIBUTE_HDF_VERSION, NX_ATTRIBUTE_HDF5_VERSION, NX_ATTRIBUTE_NEXUS_VERSION, NX_ATTRIBUTE_NX_CLASS, NX_ATTRIBUTE_XML_VERSION





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








Constructor Summary

Constructors 

Constructor and Description


NXrootImpl() 


NXrootImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


java.util.Map<java.lang.String,NXentry>
getAllEntry()
Get all NXentry nodes:
 
 
 entries
 



java.lang.String
getAttributeCreator()
facility or program where file originated



java.lang.String
getAttributeDefault()
..



java.lang.String
getAttributeFile_name()
File name of original NeXus file



java.lang.String
getAttributeFile_time()
Date and time file was originally created



java.lang.String
getAttributeFile_update_time()
Date and time of last file change at close



java.lang.String
getAttributeH5py_version()
Version of h5py Python package used in writing the file



java.lang.String
getAttributeHDF_version()
Version of HDF (version 4) library used in writing the file



java.lang.String
getAttributeHDF5_Version()
Version of HDF5 library used in writing the file.



java.lang.String
getAttributeNeXus_version()
Version of NeXus API used in writing the file.



java.lang.String
getAttributeNX_class()
The root of any NeXus data file is an ``NXroot`` class
 (no other choice is allowed for a valid NeXus data file).



java.lang.String
getAttributeXML_version()
Version of XML support library used in writing the XML file



NXentry
getEntry()
entries



NXentry
getEntry(java.lang.String name)
Get a NXentry node by name:
 
 
 entries
 



NexusBaseClass
getNexusBaseClass()
Enum constant from NexusBaseClass for this base class, e.g.



java.lang.Class<? extends NXobject>
getNXclass()
Java Class object of the interface for this base class, e.g.



java.util.Set<NexusBaseClass>
getPermittedChildGroupClasses()
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.



void
setAllEntry(java.util.Map<java.lang.String,NXentry> entry)
Set multiple child nodes of a particular type.



void
setAttributeCreator(java.lang.String creator)
facility or program where file originated



void
setAttributeDefault(java.lang.String default_)
..



void
setAttributeFile_name(java.lang.String file_name)
File name of original NeXus file



void
setAttributeFile_time(java.lang.String file_time)
Date and time file was originally created



void
setAttributeFile_update_time(java.lang.String file_update_time)
Date and time of last file change at close



void
setAttributeH5py_version(java.lang.String h5py_version)
Version of h5py Python package used in writing the file



void
setAttributeHDF_version(java.lang.String HDF_version)
Version of HDF (version 4) library used in writing the file



void
setAttributeHDF5_Version(java.lang.String HDF5_Version)
Version of HDF5 library used in writing the file.



void
setAttributeNeXus_version(java.lang.String NeXus_version)
Version of NeXus API used in writing the file.



void
setAttributeNX_class(java.lang.String NX_class)
The root of any NeXus data file is an ``NXroot`` class
 (no other choice is allowed for a valid NeXus data file).



void
setAttributeXML_version(java.lang.String XML_version)
Version of XML support library used in writing the XML file



void
setEntry(NXentry entry)
entries



void
setEntry(java.lang.String name,
        NXentry entry)
Set a NXentry node by name:
 
 
 entries
 







Methods inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
addExternalLink, appendNodeString, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setDate, setField, setString





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, createNodeLink, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isGroupNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool, toString





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isSymbolicNode





Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait





Methods inherited from interface org.eclipse.dawnsci.nexus.NXobject
addExternalLink, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setField





Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.GroupNode
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool





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





Methods inherited from interface java.lang.Iterable
forEach, spliterator














Field Detail





PERMITTED_CHILD_GROUP_CLASSES
public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES









Constructor Detail





NXrootImpl
public NXrootImpl()







NXrootImpl
public NXrootImpl(long oid)









Method Detail





getNXclass
public java.lang.Class<? extends NXobject> getNXclass()
Description copied from interface: NXobject
Java Class object of the interface for this base class, e.g. NXsample.class.

Specified by:
getNXclass in interface NXobject
Returns:
name of Nexus class








getNexusBaseClass
public NexusBaseClass getNexusBaseClass()
Description copied from interface: NXobject
Enum constant from NexusBaseClass for this base class, e.g. NexusBaseClass.NX_SAMPLE.

Specified by:
getNexusBaseClass in interface NXobject
Returns:
NexusBaseClass enum constant for this class








getPermittedChildGroupClasses
public java.util.Set<NexusBaseClass> getPermittedChildGroupClasses()
Description copied from interface: NXobject
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.

Specified by:
getPermittedChildGroupClasses in interface NXobject
Returns:
NexusBaseClass constants for permitted child groups








getAttributeNX_class
public java.lang.String getAttributeNX_class()
Description copied from interface: NXroot
The root of any NeXus data file is an ``NXroot`` class
 (no other choice is allowed for a valid NeXus data file).
 This attribute cements that definition.
 

 
Enumeration:

 
NXroot 

 


Specified by:
getAttributeNX_class in interface NXroot
Returns:
the value.








setAttributeNX_class
public void setAttributeNX_class(java.lang.String NX_class)
Description copied from interface: NXroot
The root of any NeXus data file is an ``NXroot`` class
 (no other choice is allowed for a valid NeXus data file).
 This attribute cements that definition.
 

 
Enumeration:

 
NXroot 

 


Specified by:
setAttributeNX_class in interface NXroot
Parameters:
NX_class - the NX_class








getAttributeFile_time
public java.lang.String getAttributeFile_time()
Description copied from interface: NXroot
Date and time file was originally created

Specified by:
getAttributeFile_time in interface NXroot
Returns:
the value.








setAttributeFile_time
public void setAttributeFile_time(java.lang.String file_time)
Description copied from interface: NXroot
Date and time file was originally created

Specified by:
setAttributeFile_time in interface NXroot
Parameters:
file_time - the file_time








getAttributeFile_name
public java.lang.String getAttributeFile_name()
Description copied from interface: NXroot
File name of original NeXus file

Specified by:
getAttributeFile_name in interface NXroot
Returns:
the value.








setAttributeFile_name
public void setAttributeFile_name(java.lang.String file_name)
Description copied from interface: NXroot
File name of original NeXus file

Specified by:
setAttributeFile_name in interface NXroot
Parameters:
file_name - the file_name








getAttributeFile_update_time
public java.lang.String getAttributeFile_update_time()
Description copied from interface: NXroot
Date and time of last file change at close

Specified by:
getAttributeFile_update_time in interface NXroot
Returns:
the value.








setAttributeFile_update_time
public void setAttributeFile_update_time(java.lang.String file_update_time)
Description copied from interface: NXroot
Date and time of last file change at close

Specified by:
setAttributeFile_update_time in interface NXroot
Parameters:
file_update_time - the file_update_time








getAttributeNeXus_version
public java.lang.String getAttributeNeXus_version()
Description copied from interface: NXroot
Version of NeXus API used in writing the file.
 Only used when the NAPI has written the file.
 Note that this is different from the version of the
 base class or application definition version number.

Specified by:
getAttributeNeXus_version in interface NXroot
Returns:
the value.








setAttributeNeXus_version
public void setAttributeNeXus_version(java.lang.String NeXus_version)
Description copied from interface: NXroot
Version of NeXus API used in writing the file.
 Only used when the NAPI has written the file.
 Note that this is different from the version of the
 base class or application definition version number.

Specified by:
setAttributeNeXus_version in interface NXroot
Parameters:
NeXus_version - the NeXus_version








getAttributeHDF_version
public java.lang.String getAttributeHDF_version()
Description copied from interface: NXroot
Version of HDF (version 4) library used in writing the file

Specified by:
getAttributeHDF_version in interface NXroot
Returns:
the value.








setAttributeHDF_version
public void setAttributeHDF_version(java.lang.String HDF_version)
Description copied from interface: NXroot
Version of HDF (version 4) library used in writing the file

Specified by:
setAttributeHDF_version in interface NXroot
Parameters:
HDF_version - the HDF_version








getAttributeHDF5_Version
public java.lang.String getAttributeHDF5_Version()
Description copied from interface: NXroot
Version of HDF5 library used in writing the file.
 Note this attribute is spelled with uppercase "V",
 different than other version attributes.

Specified by:
getAttributeHDF5_Version in interface NXroot
Returns:
the value.








setAttributeHDF5_Version
public void setAttributeHDF5_Version(java.lang.String HDF5_Version)
Description copied from interface: NXroot
Version of HDF5 library used in writing the file.
 Note this attribute is spelled with uppercase "V",
 different than other version attributes.

Specified by:
setAttributeHDF5_Version in interface NXroot
Parameters:
HDF5_Version - the HDF5_Version








getAttributeXML_version
public java.lang.String getAttributeXML_version()
Description copied from interface: NXroot
Version of XML support library used in writing the XML file

Specified by:
getAttributeXML_version in interface NXroot
Returns:
the value.








setAttributeXML_version
public void setAttributeXML_version(java.lang.String XML_version)
Description copied from interface: NXroot
Version of XML support library used in writing the XML file

Specified by:
setAttributeXML_version in interface NXroot
Parameters:
XML_version - the XML_version








getAttributeH5py_version
public java.lang.String getAttributeH5py_version()
Description copied from interface: NXroot
Version of h5py Python package used in writing the file

Specified by:
getAttributeH5py_version in interface NXroot
Returns:
the value.








setAttributeH5py_version
public void setAttributeH5py_version(java.lang.String h5py_version)
Description copied from interface: NXroot
Version of h5py Python package used in writing the file

Specified by:
setAttributeH5py_version in interface NXroot
Parameters:
h5py_version - the h5py_version








getAttributeCreator
public java.lang.String getAttributeCreator()
Description copied from interface: NXroot
facility or program where file originated

Specified by:
getAttributeCreator in interface NXroot
Returns:
the value.








setAttributeCreator
public void setAttributeCreator(java.lang.String creator)
Description copied from interface: NXroot
facility or program where file originated

Specified by:
setAttributeCreator in interface NXroot
Parameters:
creator - the creator








getEntry
public NXentry getEntry()
Description copied from interface: NXroot
entries

Specified by:
getEntry in interface NXroot
Returns:
the value.








setEntry
public void setEntry(NXentry entry)
Description copied from interface: NXroot
entries

Specified by:
setEntry in interface NXroot
Parameters:
entry - the entry








getEntry
public NXentry getEntry(java.lang.String name)
Description copied from interface: NXroot
Get a NXentry node by name:
 

 

 entries
 

Specified by:
getEntry in interface NXroot
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXentry for that node.








setEntry
public void setEntry(java.lang.String name,
                     NXentry entry)
Description copied from interface: NXroot
Set a NXentry node by name:
 

 

 entries
 

Specified by:
setEntry in interface NXroot
Parameters:
name - the name of the node
entry - the value to set








getAllEntry
public java.util.Map<java.lang.String,NXentry> getAllEntry()
Description copied from interface: NXroot
Get all NXentry nodes:
 

 

 entries
 

Specified by:
getAllEntry in interface NXroot
Returns:
a map from node names to the NXentry for that node.








setAllEntry
public void setAllEntry(java.util.Map<java.lang.String,NXentry> entry)
Description copied from interface: NXroot
Set multiple child nodes of a particular type.
 

 

 entries
 

Specified by:
setAllEntry in interface NXroot
Parameters:
entry - the child nodes to add








getAttributeDefault
public java.lang.String getAttributeDefault()
Description copied from interface: NXroot
.. index:: plotting
 Declares which :ref:`NXentry` group contains
 the data to be shown by default.
 It is needed to resolve ambiguity when
 more than one :ref:`NXentry` group exists.
 The value is the name of the default :ref:`NXentry` group.
 It is recommended (as of NIAC2014) to use this attribute
 to help define the path to the default dataset to be plotted.
 See http://wiki.nexusformat.org/2014_How_to_find_default_data
 for a summary of the discussion.

Specified by:
getAttributeDefault in interface NXroot
Returns:
the value.








setAttributeDefault
public void setAttributeDefault(java.lang.String default_)
Description copied from interface: NXroot
.. index:: plotting
 Declares which :ref:`NXentry` group contains
 the data to be shown by default.
 It is needed to resolve ambiguity when
 more than one :ref:`NXentry` group exists.
 The value is the name of the default :ref:`NXentry` group.
 It is recommended (as of NIAC2014) to use this attribute
 to help define the path to the default dataset to be plotted.
 See http://wiki.nexusformat.org/2014_How_to_find_default_data
 for a summary of the discussion.

Specified by:
setAttributeDefault in interface NXroot
Parameters:
default_ - the default














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