• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXnote.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.NXnote.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
Interface NXnote






All Superinterfaces:
GroupNode, java.lang.Iterable<NodeLink>, Node, NXobject


All Known Implementing Classes:
NXnoteImpl




public interface NXnote
extends NXobject
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











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_AUTHOR 


static java.lang.String
NX_DATA 


static java.lang.String
NX_DATE 


static java.lang.String
NX_DESCRIPTION 


static java.lang.String
NX_FILE_NAME 


static java.lang.String
NX_SEQUENCE_INDEX 


static java.lang.String
NX_TYPE 






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


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



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 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, getNexusBaseClass, getNumber, getNXclass, getPermittedChildGroupClasses, 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





NX_AUTHOR
static final java.lang.String NX_AUTHOR

See Also:
Constant Field Values








NX_DATE
static final java.lang.String NX_DATE

See Also:
Constant Field Values








NX_TYPE
static final java.lang.String NX_TYPE

See Also:
Constant Field Values








NX_FILE_NAME
static final java.lang.String NX_FILE_NAME

See Also:
Constant Field Values








NX_DESCRIPTION
static final java.lang.String NX_DESCRIPTION

See Also:
Constant Field Values








NX_SEQUENCE_INDEX
static final java.lang.String NX_SEQUENCE_INDEX

See Also:
Constant Field Values








NX_DATA
static final java.lang.String NX_DATA

See Also:
Constant Field Values










Method Detail





getAuthor
IDataset getAuthor()
Author or creator of note

Returns:
the value.








setAuthor
DataNode setAuthor(IDataset author)
Author or creator of note

Parameters:
author - the author








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

Returns:
the value.








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

Parameters:
author - the author








getDate
IDataset getDate()
Date note created/added
 

 Type: NX_DATE_TIME
 

Returns:
the value.








setDate
DataNode setDate(IDataset date)
Date note created/added
 

 Type: NX_DATE_TIME
 

Parameters:
date - the date








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

 Type: NX_DATE_TIME
 

Returns:
the value.








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

 Type: NX_DATE_TIME
 

Parameters:
date - the date








getType
IDataset getType()
Mime content type of note data field e.g. image/jpeg, text/plain, text/html

Returns:
the value.








setType
DataNode setType(IDataset type)
Mime content type of note data field e.g. image/jpeg, text/plain, text/html

Parameters:
type - the type








getTypeScalar
java.lang.String getTypeScalar()
Mime content type of note data field e.g. image/jpeg, text/plain, text/html

Returns:
the value.








setTypeScalar
DataNode setTypeScalar(java.lang.String type)
Mime content type of note data field e.g. image/jpeg, text/plain, text/html

Parameters:
type - the type








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

Returns:
the value.








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

Parameters:
file_name - the file_name








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

Returns:
the value.








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

Parameters:
file_name - the file_name








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

Returns:
the value.








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

Parameters:
description - the description








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

Returns:
the value.








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

Parameters:
description - the description








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

 Type: NX_POSINT
 

Returns:
the value.








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

 Type: NX_POSINT
 

Parameters:
sequence_index - the sequence_index








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

 Type: NX_POSINT
 

Returns:
the value.








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

 Type: NX_POSINT
 

Parameters:
sequence_index - the sequence_index








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

 Type: NX_BINARY
 

Returns:
the value.








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

 Type: NX_BINARY
 

Parameters:
data - the data








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

 Type: NX_BINARY
 

Returns:
the value.








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

 Type: NX_BINARY
 

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