• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NexusObjectWrapper.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.builder.NexusObjectWrapper.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.builder
Class NexusObjectWrapper<N extends NXobject>



java.lang.Object


org.eclipse.dawnsci.nexus.builder.AbstractNexusObjectProvider<N>


org.eclipse.dawnsci.nexus.builder.NexusObjectWrapper<N>









Type Parameters:
N - nexus base class type, a subinterface of NXobject


All Implemented Interfaces:
NexusEntryModification, NexusObjectProvider<N>




public class NexusObjectWrapper<N extends NXobject>
extends AbstractNexusObjectProvider<N>
An implementation of AbstractNexusObjectProvider that wraps the nexus object that
 should be returned by AbstractNexusObjectProvider.getNexusObject().











Field Summary




Fields inherited from class org.eclipse.dawnsci.nexus.builder.AbstractNexusObjectProvider
DEFAULT_DATA_NODE_NAME








Constructor Summary

Constructors 

Constructor and Description


NexusObjectWrapper(java.lang.String name,
                  N nexusObject)
Creates a new AbstractNexusObjectProvider for given name, base class type
 and data node name.



NexusObjectWrapper(java.lang.String name,
                  NexusBaseClass nexusBaseClass)
Creates a new AbstractNexusObjectProvider for given name, base class type
 and data node name.



NexusObjectWrapper(java.lang.String name,
                  NexusBaseClass nexusBaseClass,
                  java.lang.String defaultDataFieldName,
                  java.lang.String... additionalDataFieldNames)
Creates a new AbstractNexusObjectProvider for given name, base class type
 and data node name.



NexusObjectWrapper(java.lang.String name,
                  N nexusObject,
                  java.lang.String defaultDataFieldName,
                  java.lang.String... additionalDataFieldNames)
Creates a new AbstractNexusObjectProvider for given name, base class type
 and data node name.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


protected N
createNexusObject() 


void
setNexusObject(N nexusObject)
Sets the nexus object to be returned by this wrapepr







Methods inherited from class org.eclipse.dawnsci.nexus.builder.AbstractNexusObjectProvider
addAdditionalPrimaryDataFieldName, addAxisDataField, addAxisDataFieldForPrimaryDataField, addAxisDataFieldName, addAxisDataFieldNames, addExternalFileName, addExternalLink, addExternalLink, getAdditionalPrimaryDataFieldNames, getAxisDataFieldNames, getAxisDataFieldsForPrimaryDataField, getCategory, getCollectionName, getDefaultAxisDataFieldName, getDefaultAxisDimension, getDefaultName, getDimensionMappings, getExternalDatasetRank, getExternalFileNames, getName, getNexusBaseClass, getNexusObject, getPrimaryDataFieldName, getPropertyValue, getUseDeviceNameInNXdata, getWriteableDataset, setAxisDataFieldNames, setCategory, setCollectionName, setDefaultAxisDataFieldName, setDefaultExternalFileName, setExternalDatasetRank, setName, setPrimaryDataFieldName, setPropertyValue, setUseDeviceNameInNXdata





Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





NexusObjectWrapper
public NexusObjectWrapper(java.lang.String name,
                          NexusBaseClass nexusBaseClass)
Creates a new AbstractNexusObjectProvider for given name, base class type
 and data node name.

Parameters:
name - name
nexusBaseClass - base class type










NexusObjectWrapper
public NexusObjectWrapper(java.lang.String name,
                          N nexusObject)
Creates a new AbstractNexusObjectProvider for given name, base class type
 and data node name.

Parameters:
name - name
nexusObject - nexusObject










NexusObjectWrapper
public NexusObjectWrapper(java.lang.String name,
                          N nexusObject,
                          java.lang.String defaultDataFieldName,
                          java.lang.String... additionalDataFieldNames)
Creates a new AbstractNexusObjectProvider for given name, base class type
 and data node name. The default data field will be used as the @signal
 for an NexusBaseClass.NX_DETECTOR when building an NXdata for this object,
 otherwise if this device is the default axis for a particular dimension of the
 @signal field of the device, this is the field that will be added to the
 @axes attribute of the NXdata group for that dimension.

Parameters:
name - name
nexusObject - nexusObject to return
defaultDataFieldName - default data field, the default signal field for a detector,
    the default axis field for any other type of nexus object
additionalDataFieldNames - the names of any additional data fields








NexusObjectWrapper
public NexusObjectWrapper(java.lang.String name,
                          NexusBaseClass nexusBaseClass,
                          java.lang.String defaultDataFieldName,
                          java.lang.String... additionalDataFieldNames)
Creates a new AbstractNexusObjectProvider for given name, base class type
 and data node name. The default data field will be used as the @signal
 for an NexusBaseClass.NX_DETECTOR when building an NXdata for this object,
 otherwise if this device is the default axis for a particular dimension of the
 @signal field of the device, this is the field that will be added to the
 @axes attribute of the NXdata group for that dimension.

Parameters:
name - name
nexusBaseClass - base class type
defaultDataFieldName - default data field, the default signal field for a detector,
    the default axis field for any other type of nexus object
additionalDataFieldNames - the names of any additional data fields










Method Detail







setNexusObject
public void setNexusObject(N nexusObject)
Sets the nexus object to be returned by this wrapepr

Parameters:
nexusObject - 








createNexusObject
protected N createNexusObject()

Specified by:
createNexusObject in class AbstractNexusObjectProvider<N extends NXobject>














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