generated.docs.javadoc.org.eclipse.dawnsci.nexus.impl.NXprocessImpl.html Maven / Gradle / Ivy






NXprocessImpl (h5jan API)











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 NXprocessImpl



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













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




public class NXprocessImpl
extends NXobjectImpl
implements NXprocess
Document an event of data processing, reconstruction, or analysis for this data.

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.NXprocess
NX_DATE, NX_PROGRAM, NX_SEQUENCE_INDEX, NX_VERSION





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








Constructor Summary

Constructors 

Constructor and Description


NXprocessImpl() 


NXprocessImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


java.util.Map<java.lang.String,NXnote>
getAllNote()
Get all NXnote nodes:
 
 
 The note will contain information about how the data was processed
 or anything about the data provenance.



IDataset
getDate()
Date and time of processing.



java.util.Date
getDateScalar()
Date and time of processing.



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



NXnote
getNote()
The note will contain information about how the data was processed
 or anything about the data provenance.



NXnote
getNote(java.lang.String name)
Get a NXnote node by name:
 
 
 The note will contain information about how the data was processed
 or anything about the data provenance.



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.



IDataset
getProgram()
Name of the program used



java.lang.String
getProgramScalar()
Name of the program used



IDataset
getSequence_index()
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.



java.lang.Long
getSequence_indexScalar()
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.



IDataset
getVersion()
Version of the program used



java.lang.String
getVersionScalar()
Version of the program used



void
setAllNote(java.util.Map<java.lang.String,NXnote> note)
Set multiple child nodes of a particular type.



DataNode
setDate(IDataset date)
Date and time of processing.



DataNode
setDateScalar(java.util.Date date)
Date and time of processing.



void
setNote(NXnote note)
The note will contain information about how the data was processed
 or anything about the data provenance.



void
setNote(java.lang.String name,
       NXnote note)
Set a NXnote node by name:
 
 
 The note will contain information about how the data was processed
 or anything about the data provenance.



DataNode
setProgram(IDataset program)
Name of the program used



DataNode
setProgramScalar(java.lang.String program)
Name of the program used



DataNode
setSequence_index(IDataset sequence_index)
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.



DataNode
setSequence_indexScalar(java.lang.Long sequence_index)
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.



DataNode
setVersion(IDataset version)
Version of the program used



DataNode
setVersionScalar(java.lang.String version)
Version of the program used







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





NXprocessImpl
public NXprocessImpl()







NXprocessImpl
public NXprocessImpl(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








getProgram
public IDataset getProgram()
Description copied from interface: NXprocess
Name of the program used
 
 Type: NX_CHAR
 

Specified by:
getProgram in interface NXprocess
Returns:
the value.








getProgramScalar
public java.lang.String getProgramScalar()
Description copied from interface: NXprocess
Name of the program used
 
 Type: NX_CHAR
 

Specified by:
getProgramScalar in interface NXprocess
Returns:
the value.








setProgram
public DataNode setProgram(IDataset program)
Description copied from interface: NXprocess
Name of the program used
 
 Type: NX_CHAR
 

Specified by:
setProgram in interface NXprocess
Parameters:
program - the program








setProgramScalar
public DataNode setProgramScalar(java.lang.String program)
Description copied from interface: NXprocess
Name of the program used
 
 Type: NX_CHAR
 

Specified by:
setProgramScalar in interface NXprocess
Parameters:
program - the program








getSequence_index
public IDataset getSequence_index()
Description copied from interface: NXprocess
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.
 Starts with 1.
 
 Type: NX_POSINT
 

Specified by:
getSequence_index in interface NXprocess
Returns:
the value.








getSequence_indexScalar
public java.lang.Long getSequence_indexScalar()
Description copied from interface: NXprocess
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.
 Starts with 1.
 
 Type: NX_POSINT
 

Specified by:
getSequence_indexScalar in interface NXprocess
Returns:
the value.








setSequence_index
public DataNode setSequence_index(IDataset sequence_index)
Description copied from interface: NXprocess
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.
 Starts with 1.
 
 Type: NX_POSINT
 

Specified by:
setSequence_index in interface NXprocess
Parameters:
sequence_index - the sequence_index








setSequence_indexScalar
public DataNode setSequence_indexScalar(java.lang.Long sequence_index)
Description copied from interface: NXprocess
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.
 Starts with 1.
 
 Type: NX_POSINT
 

Specified by:
setSequence_indexScalar in interface NXprocess
Parameters:
sequence_index - the sequence_index








getVersion
public IDataset getVersion()
Description copied from interface: NXprocess
Version of the program used
 
 Type: NX_CHAR
 

Specified by:
getVersion in interface NXprocess
Returns:
the value.








getVersionScalar
public java.lang.String getVersionScalar()
Description copied from interface: NXprocess
Version of the program used
 
 Type: NX_CHAR
 

Specified by:
getVersionScalar in interface NXprocess
Returns:
the value.








setVersion
public DataNode setVersion(IDataset version)
Description copied from interface: NXprocess
Version of the program used
 
 Type: NX_CHAR
 

Specified by:
setVersion in interface NXprocess
Parameters:
version - the version








setVersionScalar
public DataNode setVersionScalar(java.lang.String version)
Description copied from interface: NXprocess
Version of the program used
 
 Type: NX_CHAR
 

Specified by:
setVersionScalar in interface NXprocess
Parameters:
version - the version








getDate
public IDataset getDate()
Description copied from interface: NXprocess
Date and time of processing.
 
 Type: NX_DATE_TIME
 

Specified by:
getDate in interface NXprocess
Returns:
the value.








getDateScalar
public java.util.Date getDateScalar()
Description copied from interface: NXprocess
Date and time of processing.
 
 Type: NX_DATE_TIME
 

Specified by:
getDateScalar in interface NXprocess
Returns:
the value.








setDate
public DataNode setDate(IDataset date)
Description copied from interface: NXprocess
Date and time of processing.
 
 Type: NX_DATE_TIME
 

Specified by:
setDate in interface NXprocess
Parameters:
date - the date








setDateScalar
public DataNode setDateScalar(java.util.Date date)
Description copied from interface: NXprocess
Date and time of processing.
 
 Type: NX_DATE_TIME
 

Specified by:
setDateScalar in interface NXprocess
Parameters:
date - the date








getNote
public NXnote getNote()
Description copied from interface: NXprocess
The note will contain information about how the data was processed
 or anything about the data provenance.
 The contents of the note can be anything that the processing code
 can understand, or simple text.
 The name will be numbered to allow for ordering of steps.

Specified by:
getNote in interface NXprocess
Returns:
the value.








setNote
public void setNote(NXnote note)
Description copied from interface: NXprocess
The note will contain information about how the data was processed
 or anything about the data provenance.
 The contents of the note can be anything that the processing code
 can understand, or simple text.
 The name will be numbered to allow for ordering of steps.

Specified by:
setNote in interface NXprocess
Parameters:
note - the note








getNote
public NXnote getNote(java.lang.String name)
Description copied from interface: NXprocess
Get a NXnote node by name:
 
 
 The note will contain information about how the data was processed
 or anything about the data provenance.
 The contents of the note can be anything that the processing code
 can understand, or simple text.
 The name will be numbered to allow for ordering of steps.
 

Specified by:
getNote in interface NXprocess
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXnote for that node.








setNote
public void setNote(java.lang.String name,
                    NXnote note)
Description copied from interface: NXprocess
Set a NXnote node by name:
 
 
 The note will contain information about how the data was processed
 or anything about the data provenance.
 The contents of the note can be anything that the processing code
 can understand, or simple text.
 The name will be numbered to allow for ordering of steps.
 

Specified by:
setNote in interface NXprocess
Parameters:
name - the name of the node
note - the value to set








getAllNote
public java.util.Map<java.lang.String,NXnote> getAllNote()
Description copied from interface: NXprocess
Get all NXnote nodes:
 
 
 The note will contain information about how the data was processed
 or anything about the data provenance.
 The contents of the note can be anything that the processing code
 can understand, or simple text.
 The name will be numbered to allow for ordering of steps.
 

Specified by:
getAllNote in interface NXprocess
Returns:
a map from node names to the NXnote for that node.








setAllNote
public void setAllNote(java.util.Map<java.lang.String,NXnote> note)
Description copied from interface: NXprocess
Set multiple child nodes of a particular type.
 
 
 The note will contain information about how the data was processed
 or anything about the data provenance.
 The contents of the note can be anything that the processing code
 can understand, or simple text.
 The name will be numbered to allow for ordering of steps.
 

Specified by:
setAllNote in interface NXprocess
Parameters:
note - the child nodes to add














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

Modifier and Type	Method and Description
`java.util.Map<java.lang.String,NXnote>`	`getAllNote()` Get all NXnote nodes: The note will contain information about how the data was processed or anything about the data provenance.
`IDataset`	`getDate()` Date and time of processing.
`java.util.Date`	`getDateScalar()` Date and time of processing.
`NexusBaseClass`	`getNexusBaseClass()` Enum constant from `NexusBaseClass` for this base class, e.g.
`NXnote`	`getNote()` The note will contain information about how the data was processed or anything about the data provenance.
`NXnote`	`getNote(java.lang.String name)` Get a NXnote node by name: The note will contain information about how the data was processed or anything about the data provenance.
`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.
`IDataset`	`getProgram()` Name of the program used
`java.lang.String`	`getProgramScalar()` Name of the program used
`IDataset`	`getSequence_index()` Sequence index of processing, for determining the order of multiple NXprocess steps.
`java.lang.Long`	`getSequence_indexScalar()` Sequence index of processing, for determining the order of multiple NXprocess steps.
`IDataset`	`getVersion()` Version of the program used
`java.lang.String`	`getVersionScalar()` Version of the program used
`void`	`setAllNote(java.util.Map<java.lang.String,NXnote> note)` Set multiple child nodes of a particular type.
`DataNode`	`setDate(IDataset date)` Date and time of processing.
`DataNode`	`setDateScalar(java.util.Date date)` Date and time of processing.
`void`	`setNote(NXnote note)` The note will contain information about how the data was processed or anything about the data provenance.
`void`	`setNote(java.lang.String name, NXnote note)` Set a NXnote node by name: The note will contain information about how the data was processed or anything about the data provenance.
`DataNode`	`setProgram(IDataset program)` Name of the program used
`DataNode`	`setProgramScalar(java.lang.String program)` Name of the program used
`DataNode`	`setSequence_index(IDataset sequence_index)` Sequence index of processing, for determining the order of multiple NXprocess steps.
`DataNode`	`setSequence_indexScalar(java.lang.Long sequence_index)` Sequence index of processing, for determining the order of multiple NXprocess steps.
`DataNode`	`setVersion(IDataset version)` Version of the program used
`DataNode`	`setVersionScalar(java.lang.String version)` Version of the program used

Constructors
Constructor and Description
`NXprocessImpl()`
`NXprocessImpl(long oid)`