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






NXcite (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
Interface NXcite






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


All Known Implementing Classes:
NXciteImpl




public interface NXcite
extends NXobject
A literature reference
 Definition to include references for example for detectors,
 manuals, instruments, acquisition or analysis software used.
 The idea would be to include this in the relevant NeXus object:
 :ref:`NXdetector` for detectors, :ref:`NXinstrument` for instruments, etc.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_BIBTEX 


static java.lang.String
NX_DESCRIPTION 


static java.lang.String
NX_DOI 


static java.lang.String
NX_ENDNOTE 


static java.lang.String
NX_URL 






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
getBibtex()
Bibliographic reference data in BibTeX format.



java.lang.String
getBibtexScalar()
Bibliographic reference data in BibTeX format.



IDataset
getDescription()
This should describe the reason for including this reference.



java.lang.String
getDescriptionScalar()
This should describe the reason for including this reference.



IDataset
getDoi()
DOI referencing the document or data.



java.lang.String
getDoiScalar()
DOI referencing the document or data.



IDataset
getEndnote()
Bibliographic reference data in EndNote format.



java.lang.String
getEndnoteScalar()
Bibliographic reference data in EndNote format.



IDataset
getUrl()
URL referencing the document or data.



java.lang.String
getUrlScalar()
URL referencing the document or data.



DataNode
setBibtex(IDataset bibtex)
Bibliographic reference data in BibTeX format.



DataNode
setBibtexScalar(java.lang.String bibtex)
Bibliographic reference data in BibTeX format.



DataNode
setDescription(IDataset description)
This should describe the reason for including this reference.



DataNode
setDescriptionScalar(java.lang.String description)
This should describe the reason for including this reference.



DataNode
setDoi(IDataset doi)
DOI referencing the document or data.



DataNode
setDoiScalar(java.lang.String doi)
DOI referencing the document or data.



DataNode
setEndnote(IDataset endnote)
Bibliographic reference data in EndNote format.



DataNode
setEndnoteScalar(java.lang.String endnote)
Bibliographic reference data in EndNote format.



DataNode
setUrl(IDataset url)
URL referencing the document or data.



DataNode
setUrlScalar(java.lang.String url)
URL referencing the document or data.







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_DESCRIPTION
static final java.lang.String NX_DESCRIPTION

See Also:
Constant Field Values








NX_URL
static final java.lang.String NX_URL

See Also:
Constant Field Values








NX_DOI
static final java.lang.String NX_DOI

See Also:
Constant Field Values








NX_ENDNOTE
static final java.lang.String NX_ENDNOTE

See Also:
Constant Field Values








NX_BIBTEX
static final java.lang.String NX_BIBTEX

See Also:
Constant Field Values










Method Detail





getDescription
IDataset getDescription()
This should describe the reason for including this reference.
 For example: The dataset in this group was normalised using the method
 which is described in detail in this reference.
 
 Type: NX_CHAR
 

Returns:
the value.








setDescription
DataNode setDescription(IDataset description)
This should describe the reason for including this reference.
 For example: The dataset in this group was normalised using the method
 which is described in detail in this reference.
 
 Type: NX_CHAR
 

Parameters:
description - the description








getDescriptionScalar
java.lang.String getDescriptionScalar()
This should describe the reason for including this reference.
 For example: The dataset in this group was normalised using the method
 which is described in detail in this reference.
 
 Type: NX_CHAR
 

Returns:
the value.








setDescriptionScalar
DataNode setDescriptionScalar(java.lang.String description)
This should describe the reason for including this reference.
 For example: The dataset in this group was normalised using the method
 which is described in detail in this reference.
 
 Type: NX_CHAR
 

Parameters:
description - the description








getUrl
IDataset getUrl()
URL referencing the document or data.
 
 Type: NX_CHAR
 

Returns:
the value.








setUrl
DataNode setUrl(IDataset url)
URL referencing the document or data.
 
 Type: NX_CHAR
 

Parameters:
url - the url








getUrlScalar
java.lang.String getUrlScalar()
URL referencing the document or data.
 
 Type: NX_CHAR
 

Returns:
the value.








setUrlScalar
DataNode setUrlScalar(java.lang.String url)
URL referencing the document or data.
 
 Type: NX_CHAR
 

Parameters:
url - the url








getDoi
IDataset getDoi()
DOI referencing the document or data.
 
 Type: NX_CHAR
 

Returns:
the value.








setDoi
DataNode setDoi(IDataset doi)
DOI referencing the document or data.
 
 Type: NX_CHAR
 

Parameters:
doi - the doi








getDoiScalar
java.lang.String getDoiScalar()
DOI referencing the document or data.
 
 Type: NX_CHAR
 

Returns:
the value.








setDoiScalar
DataNode setDoiScalar(java.lang.String doi)
DOI referencing the document or data.
 
 Type: NX_CHAR
 

Parameters:
doi - the doi








getEndnote
IDataset getEndnote()
Bibliographic reference data in EndNote format.
 
 Type: NX_CHAR
 

Returns:
the value.








setEndnote
DataNode setEndnote(IDataset endnote)
Bibliographic reference data in EndNote format.
 
 Type: NX_CHAR
 

Parameters:
endnote - the endnote








getEndnoteScalar
java.lang.String getEndnoteScalar()
Bibliographic reference data in EndNote format.
 
 Type: NX_CHAR
 

Returns:
the value.








setEndnoteScalar
DataNode setEndnoteScalar(java.lang.String endnote)
Bibliographic reference data in EndNote format.
 
 Type: NX_CHAR
 

Parameters:
endnote - the endnote








getBibtex
IDataset getBibtex()
Bibliographic reference data in BibTeX format.
 
 Type: NX_CHAR
 

Returns:
the value.








setBibtex
DataNode setBibtex(IDataset bibtex)
Bibliographic reference data in BibTeX format.
 
 Type: NX_CHAR
 

Parameters:
bibtex - the bibtex








getBibtexScalar
java.lang.String getBibtexScalar()
Bibliographic reference data in BibTeX format.
 
 Type: NX_CHAR
 

Returns:
the value.








setBibtexScalar
DataNode setBibtexScalar(java.lang.String bibtex)
Bibliographic reference data in BibTeX format.
 
 Type: NX_CHAR
 

Parameters:
bibtex - the bibtex














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	Field and Description
`static java.lang.String`	`NX_BIBTEX`
`static java.lang.String`	`NX_DESCRIPTION`
`static java.lang.String`	`NX_DOI`
`static java.lang.String`	`NX_ENDNOTE`
`static java.lang.String`	`NX_URL`

Modifier and Type	Method and Description
`IDataset`	`getBibtex()` Bibliographic reference data in BibTeX format.
`java.lang.String`	`getBibtexScalar()` Bibliographic reference data in BibTeX format.
`IDataset`	`getDescription()` This should describe the reason for including this reference.
`java.lang.String`	`getDescriptionScalar()` This should describe the reason for including this reference.
`IDataset`	`getDoi()` DOI referencing the document or data.
`java.lang.String`	`getDoiScalar()` DOI referencing the document or data.
`IDataset`	`getEndnote()` Bibliographic reference data in EndNote format.
`java.lang.String`	`getEndnoteScalar()` Bibliographic reference data in EndNote format.
`IDataset`	`getUrl()` URL referencing the document or data.
`java.lang.String`	`getUrlScalar()` URL referencing the document or data.
`DataNode`	`setBibtex(IDataset bibtex)` Bibliographic reference data in BibTeX format.
`DataNode`	`setBibtexScalar(java.lang.String bibtex)` Bibliographic reference data in BibTeX format.
`DataNode`	`setDescription(IDataset description)` This should describe the reason for including this reference.
`DataNode`	`setDescriptionScalar(java.lang.String description)` This should describe the reason for including this reference.
`DataNode`	`setDoi(IDataset doi)` DOI referencing the document or data.
`DataNode`	`setDoiScalar(java.lang.String doi)` DOI referencing the document or data.
`DataNode`	`setEndnote(IDataset endnote)` Bibliographic reference data in EndNote format.
`DataNode`	`setEndnoteScalar(java.lang.String endnote)` Bibliographic reference data in EndNote format.
`DataNode`	`setUrl(IDataset url)` URL referencing the document or data.
`DataNode`	`setUrlScalar(java.lang.String url)` URL referencing the document or data.