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






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



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













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




public class NXciteImpl
extends NXobjectImpl
implements NXcite
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.

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.NXcite
NX_BIBTEX, NX_DESCRIPTION, NX_DOI, NX_ENDNOTE, NX_URL





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








Constructor Summary

Constructors 

Constructor and Description


NXciteImpl() 


NXciteImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete 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.



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





NXciteImpl
public NXciteImpl()







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








getDescription
public IDataset getDescription()
Description copied from interface: NXcite
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
 

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








getDescriptionScalar
public java.lang.String getDescriptionScalar()
Description copied from interface: NXcite
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
 

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








setDescription
public DataNode setDescription(IDataset description)
Description copied from interface: NXcite
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
 

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








setDescriptionScalar
public DataNode setDescriptionScalar(java.lang.String description)
Description copied from interface: NXcite
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
 

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








getUrl
public IDataset getUrl()
Description copied from interface: NXcite
URL referencing the document or data.
 
 Type: NX_CHAR
 

Specified by:
getUrl in interface NXcite
Returns:
the value.








getUrlScalar
public java.lang.String getUrlScalar()
Description copied from interface: NXcite
URL referencing the document or data.
 
 Type: NX_CHAR
 

Specified by:
getUrlScalar in interface NXcite
Returns:
the value.








setUrl
public DataNode setUrl(IDataset url)
Description copied from interface: NXcite
URL referencing the document or data.
 
 Type: NX_CHAR
 

Specified by:
setUrl in interface NXcite
Parameters:
url - the url








setUrlScalar
public DataNode setUrlScalar(java.lang.String url)
Description copied from interface: NXcite
URL referencing the document or data.
 
 Type: NX_CHAR
 

Specified by:
setUrlScalar in interface NXcite
Parameters:
url - the url








getDoi
public IDataset getDoi()
Description copied from interface: NXcite
DOI referencing the document or data.
 
 Type: NX_CHAR
 

Specified by:
getDoi in interface NXcite
Returns:
the value.








getDoiScalar
public java.lang.String getDoiScalar()
Description copied from interface: NXcite
DOI referencing the document or data.
 
 Type: NX_CHAR
 

Specified by:
getDoiScalar in interface NXcite
Returns:
the value.








setDoi
public DataNode setDoi(IDataset doi)
Description copied from interface: NXcite
DOI referencing the document or data.
 
 Type: NX_CHAR
 

Specified by:
setDoi in interface NXcite
Parameters:
doi - the doi








setDoiScalar
public DataNode setDoiScalar(java.lang.String doi)
Description copied from interface: NXcite
DOI referencing the document or data.
 
 Type: NX_CHAR
 

Specified by:
setDoiScalar in interface NXcite
Parameters:
doi - the doi








getEndnote
public IDataset getEndnote()
Description copied from interface: NXcite
Bibliographic reference data in EndNote format.
 
 Type: NX_CHAR
 

Specified by:
getEndnote in interface NXcite
Returns:
the value.








getEndnoteScalar
public java.lang.String getEndnoteScalar()
Description copied from interface: NXcite
Bibliographic reference data in EndNote format.
 
 Type: NX_CHAR
 

Specified by:
getEndnoteScalar in interface NXcite
Returns:
the value.








setEndnote
public DataNode setEndnote(IDataset endnote)
Description copied from interface: NXcite
Bibliographic reference data in EndNote format.
 
 Type: NX_CHAR
 

Specified by:
setEndnote in interface NXcite
Parameters:
endnote - the endnote








setEndnoteScalar
public DataNode setEndnoteScalar(java.lang.String endnote)
Description copied from interface: NXcite
Bibliographic reference data in EndNote format.
 
 Type: NX_CHAR
 

Specified by:
setEndnoteScalar in interface NXcite
Parameters:
endnote - the endnote








getBibtex
public IDataset getBibtex()
Description copied from interface: NXcite
Bibliographic reference data in BibTeX format.
 
 Type: NX_CHAR
 

Specified by:
getBibtex in interface NXcite
Returns:
the value.








getBibtexScalar
public java.lang.String getBibtexScalar()
Description copied from interface: NXcite
Bibliographic reference data in BibTeX format.
 
 Type: NX_CHAR
 

Specified by:
getBibtexScalar in interface NXcite
Returns:
the value.








setBibtex
public DataNode setBibtex(IDataset bibtex)
Description copied from interface: NXcite
Bibliographic reference data in BibTeX format.
 
 Type: NX_CHAR
 

Specified by:
setBibtex in interface NXcite
Parameters:
bibtex - the bibtex








setBibtexScalar
public DataNode setBibtexScalar(java.lang.String bibtex)
Description copied from interface: NXcite
Bibliographic reference data in BibTeX format.
 
 Type: NX_CHAR
 

Specified by:
setBibtexScalar in interface NXcite
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	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.
`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`	`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.

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