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






NXnoteImpl (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 NXnoteImpl



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













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




public class NXnoteImpl
extends NXobjectImpl
implements NXnote
Any additional freeform information not covered by the other base classes.
 This class can be used to store additional information in a
 NeXus file e.g. pictures, movies, audio, additional text logs

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.NXnote
NX_AUTHOR, NX_DATA, NX_DATE, NX_DESCRIPTION, NX_FILE_NAME, NX_SEQUENCE_INDEX, NX_TYPE





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








Constructor Summary

Constructors 

Constructor and Description


NXnoteImpl() 


NXnoteImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


IDataset
getAuthor()
Author or creator of note



java.lang.String
getAuthorScalar()
Author or creator of note



IDataset
getData()
Binary note data - if text, line terminator is [CR][LF].



java.lang.Object
getDataScalar()
Binary note data - if text, line terminator is [CR][LF].



IDataset
getDate()
Date note created/added



java.util.Date
getDateScalar()
Date note created/added



IDataset
getDescription()
Title of an image or other details of the note



java.lang.String
getDescriptionScalar()
Title of an image or other details of the note



IDataset
getFile_name()
Name of original file name if note was read from an external source



java.lang.String
getFile_nameScalar()
Name of original file name if note was read from an external source



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.



IDataset
getSequence_index()
Sequence index of note, for placing a sequence of
 multiple **NXnote** groups in an order.



java.lang.Long
getSequence_indexScalar()
Sequence index of note, for placing a sequence of
 multiple **NXnote** groups in an order.



IDataset
getType()
Mime content type of note data field e.g.



java.lang.String
getTypeScalar()
Mime content type of note data field e.g.



DataNode
setAuthor(IDataset author)
Author or creator of note



DataNode
setAuthorScalar(java.lang.String author)
Author or creator of note



DataNode
setData(IDataset data)
Binary note data - if text, line terminator is [CR][LF].



DataNode
setDataScalar(java.lang.Object data)
Binary note data - if text, line terminator is [CR][LF].



DataNode
setDate(IDataset date)
Date note created/added



DataNode
setDateScalar(java.util.Date date)
Date note created/added



DataNode
setDescription(IDataset description)
Title of an image or other details of the note



DataNode
setDescriptionScalar(java.lang.String description)
Title of an image or other details of the note



DataNode
setFile_name(IDataset file_name)
Name of original file name if note was read from an external source



DataNode
setFile_nameScalar(java.lang.String file_name)
Name of original file name if note was read from an external source



DataNode
setSequence_index(IDataset sequence_index)
Sequence index of note, for placing a sequence of
 multiple **NXnote** groups in an order.



DataNode
setSequence_indexScalar(java.lang.Long sequence_index)
Sequence index of note, for placing a sequence of
 multiple **NXnote** groups in an order.



DataNode
setType(IDataset type)
Mime content type of note data field e.g.



DataNode
setTypeScalar(java.lang.String type)
Mime content type of note data field e.g.







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





NXnoteImpl
public NXnoteImpl()







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








getAuthor
public IDataset getAuthor()
Description copied from interface: NXnote
Author or creator of note

Specified by:
getAuthor in interface NXnote
Returns:
the value.








getAuthorScalar
public java.lang.String getAuthorScalar()
Description copied from interface: NXnote
Author or creator of note

Specified by:
getAuthorScalar in interface NXnote
Returns:
the value.








setAuthor
public DataNode setAuthor(IDataset author)
Description copied from interface: NXnote
Author or creator of note

Specified by:
setAuthor in interface NXnote
Parameters:
author - the author








setAuthorScalar
public DataNode setAuthorScalar(java.lang.String author)
Description copied from interface: NXnote
Author or creator of note

Specified by:
setAuthorScalar in interface NXnote
Parameters:
author - the author








getDate
public IDataset getDate()
Description copied from interface: NXnote
Date note created/added
 
 Type: NX_DATE_TIME
 

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








getDateScalar
public java.util.Date getDateScalar()
Description copied from interface: NXnote
Date note created/added
 
 Type: NX_DATE_TIME
 

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








setDate
public DataNode setDate(IDataset date)
Description copied from interface: NXnote
Date note created/added
 
 Type: NX_DATE_TIME
 

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








setDateScalar
public DataNode setDateScalar(java.util.Date date)
Description copied from interface: NXnote
Date note created/added
 
 Type: NX_DATE_TIME
 

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








getType
public IDataset getType()
Description copied from interface: NXnote
Mime content type of note data field e.g. image/jpeg, text/plain, text/html

Specified by:
getType in interface NXnote
Returns:
the value.








getTypeScalar
public java.lang.String getTypeScalar()
Description copied from interface: NXnote
Mime content type of note data field e.g. image/jpeg, text/plain, text/html

Specified by:
getTypeScalar in interface NXnote
Returns:
the value.








setType
public DataNode setType(IDataset type)
Description copied from interface: NXnote
Mime content type of note data field e.g. image/jpeg, text/plain, text/html

Specified by:
setType in interface NXnote
Parameters:
type - the type








setTypeScalar
public DataNode setTypeScalar(java.lang.String type)
Description copied from interface: NXnote
Mime content type of note data field e.g. image/jpeg, text/plain, text/html

Specified by:
setTypeScalar in interface NXnote
Parameters:
type - the type








getFile_name
public IDataset getFile_name()
Description copied from interface: NXnote
Name of original file name if note was read from an external source

Specified by:
getFile_name in interface NXnote
Returns:
the value.








getFile_nameScalar
public java.lang.String getFile_nameScalar()
Description copied from interface: NXnote
Name of original file name if note was read from an external source

Specified by:
getFile_nameScalar in interface NXnote
Returns:
the value.








setFile_name
public DataNode setFile_name(IDataset file_name)
Description copied from interface: NXnote
Name of original file name if note was read from an external source

Specified by:
setFile_name in interface NXnote
Parameters:
file_name - the file_name








setFile_nameScalar
public DataNode setFile_nameScalar(java.lang.String file_name)
Description copied from interface: NXnote
Name of original file name if note was read from an external source

Specified by:
setFile_nameScalar in interface NXnote
Parameters:
file_name - the file_name








getDescription
public IDataset getDescription()
Description copied from interface: NXnote
Title of an image or other details of the note

Specified by:
getDescription in interface NXnote
Returns:
the value.








getDescriptionScalar
public java.lang.String getDescriptionScalar()
Description copied from interface: NXnote
Title of an image or other details of the note

Specified by:
getDescriptionScalar in interface NXnote
Returns:
the value.








setDescription
public DataNode setDescription(IDataset description)
Description copied from interface: NXnote
Title of an image or other details of the note

Specified by:
setDescription in interface NXnote
Parameters:
description - the description








setDescriptionScalar
public DataNode setDescriptionScalar(java.lang.String description)
Description copied from interface: NXnote
Title of an image or other details of the note

Specified by:
setDescriptionScalar in interface NXnote
Parameters:
description - the description








getSequence_index
public IDataset getSequence_index()
Description copied from interface: NXnote
Sequence index of note, for placing a sequence of
 multiple **NXnote** groups in an order. Starts with 1.
 
 Type: NX_POSINT
 

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








getSequence_indexScalar
public java.lang.Long getSequence_indexScalar()
Description copied from interface: NXnote
Sequence index of note, for placing a sequence of
 multiple **NXnote** groups in an order. Starts with 1.
 
 Type: NX_POSINT
 

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








setSequence_index
public DataNode setSequence_index(IDataset sequence_index)
Description copied from interface: NXnote
Sequence index of note, for placing a sequence of
 multiple **NXnote** groups in an order. Starts with 1.
 
 Type: NX_POSINT
 

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








setSequence_indexScalar
public DataNode setSequence_indexScalar(java.lang.Long sequence_index)
Description copied from interface: NXnote
Sequence index of note, for placing a sequence of
 multiple **NXnote** groups in an order. Starts with 1.
 
 Type: NX_POSINT
 

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








getData
public IDataset getData()
Description copied from interface: NXnote
Binary note data - if text, line terminator is [CR][LF].
 
 Type: NX_BINARY
 

Specified by:
getData in interface NXnote
Returns:
the value.








getDataScalar
public java.lang.Object getDataScalar()
Description copied from interface: NXnote
Binary note data - if text, line terminator is [CR][LF].
 
 Type: NX_BINARY
 

Specified by:
getDataScalar in interface NXnote
Returns:
the value.








setData
public DataNode setData(IDataset data)
Description copied from interface: NXnote
Binary note data - if text, line terminator is [CR][LF].
 
 Type: NX_BINARY
 

Specified by:
setData in interface NXnote
Parameters:
data - the data








setDataScalar
public DataNode setDataScalar(java.lang.Object data)
Description copied from interface: NXnote
Binary note data - if text, line terminator is [CR][LF].
 
 Type: NX_BINARY
 

Specified by:
setDataScalar in interface NXnote
Parameters:
data - the data














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
`IDataset`	`getAuthor()` Author or creator of note
`java.lang.String`	`getAuthorScalar()` Author or creator of note
`IDataset`	`getData()` Binary note data - if text, line terminator is [CR][LF].
`java.lang.Object`	`getDataScalar()` Binary note data - if text, line terminator is [CR][LF].
`IDataset`	`getDate()` Date note created/added
`java.util.Date`	`getDateScalar()` Date note created/added
`IDataset`	`getDescription()` Title of an image or other details of the note
`java.lang.String`	`getDescriptionScalar()` Title of an image or other details of the note
`IDataset`	`getFile_name()` Name of original file name if note was read from an external source
`java.lang.String`	`getFile_nameScalar()` Name of original file name if note was read from an external source
`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.
`IDataset`	`getSequence_index()` Sequence index of note, for placing a sequence of multiple NXnote groups in an order.
`java.lang.Long`	`getSequence_indexScalar()` Sequence index of note, for placing a sequence of multiple NXnote groups in an order.
`IDataset`	`getType()` Mime content type of note data field e.g.
`java.lang.String`	`getTypeScalar()` Mime content type of note data field e.g.
`DataNode`	`setAuthor(IDataset author)` Author or creator of note
`DataNode`	`setAuthorScalar(java.lang.String author)` Author or creator of note
`DataNode`	`setData(IDataset data)` Binary note data - if text, line terminator is [CR][LF].
`DataNode`	`setDataScalar(java.lang.Object data)` Binary note data - if text, line terminator is [CR][LF].
`DataNode`	`setDate(IDataset date)` Date note created/added
`DataNode`	`setDateScalar(java.util.Date date)` Date note created/added
`DataNode`	`setDescription(IDataset description)` Title of an image or other details of the note
`DataNode`	`setDescriptionScalar(java.lang.String description)` Title of an image or other details of the note
`DataNode`	`setFile_name(IDataset file_name)` Name of original file name if note was read from an external source
`DataNode`	`setFile_nameScalar(java.lang.String file_name)` Name of original file name if note was read from an external source
`DataNode`	`setSequence_index(IDataset sequence_index)` Sequence index of note, for placing a sequence of multiple NXnote groups in an order.
`DataNode`	`setSequence_indexScalar(java.lang.Long sequence_index)` Sequence index of note, for placing a sequence of multiple NXnote groups in an order.
`DataNode`	`setType(IDataset type)` Mime content type of note data field e.g.
`DataNode`	`setTypeScalar(java.lang.String type)` Mime content type of note data field e.g.

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