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



java.lang.Object


org.eclipse.dawnsci.nexus.builder.data.DataDeviceBuilder<N>







Type Parameters:
N - the sub-interface of NXobject that the nexus object was created from




public class DataDeviceBuilder<N extends NXobject>
extends java.lang.Object
A builder class for building a DataDevice from an NexusObjectProvider.
 Provides the ability to configure which fields from the underlying nexus object are 
 are linked to the NXdata group and how.











Constructor Summary

Constructors 

Constructor and Description


DataDeviceBuilder(NexusObjectProvider<N> nexusObjectProvider,
                 boolean isPrimary)
Create a new DataDeviceBuilder for the given NexusObjectProvider.










Method Summary

All Methods Static Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


void
addAxisField(java.lang.String axisFieldName) 


void
addAxisField(java.lang.String axisFieldName,
            int defaultAxisDimension) 


void
addAxisField(java.lang.String axisFieldName,
            int[] dimensionMappings) 


void
addAxisField(java.lang.String axisFieldName,
            java.lang.String axisFieldDestinationName) 


void
addAxisFields(java.lang.String... axisFieldNames) 


DataDevice<N>
build()
Builds and returns the data device.



void
clearAxisFields() 


static <N extends NXobject>
AxisDataDevice<N>
newAxisDataDevice(NexusObjectProvider<N> nexusObjectProvider) 


static <N extends NXobject>
AxisDataDevice<N>
newAxisDataDevice(NexusObjectProvider<N> nexusObjectProvider,
                 java.lang.Integer defaultAxisDimension) 


static <N extends NXobject>
AxisDataDevice<N>
newAxisDataDevice(NexusObjectProvider<N> nexusObjectProvider,
                 java.lang.String defaultAxisSourceFieldName,
                 java.lang.Integer defaultAxisDimension) 


static <N extends NXobject>
DataDeviceBuilder<N>
newAxisDataDeviceBuilder(NexusObjectProvider<N> nexusObjectProvider) 


static <N extends NXobject>
DataDeviceBuilder<N>
newAxisDataDeviceBuilder(NexusObjectProvider<N> nexusObjectProvider,
                        java.lang.Integer defaultAxisDimension) 


static <N extends NXobject>
DataDeviceBuilder<N>
newAxisDataDeviceBuilder(NexusObjectProvider<N> nexusObjectProvider,
                        java.lang.String defaultAxisSourceFieldName,
                        java.lang.Integer defaultAxisDimension) 


static <N extends NXobject>
PrimaryDataDevice<N>
newPrimaryDataDevice(NexusObjectProvider<N> nexusObjectProvider) 


static <N extends NXobject>
PrimaryDataDevice<N>
newPrimaryDataDevice(NexusObjectProvider<N> nexusObjectProvider,
                    java.lang.String signalDataFieldName) 


static <N extends NXobject>
DataDeviceBuilder<N>
newPrimaryDataDeviceBuilder(NexusObjectProvider<N> nexusObjectProvider) 


void
setAxisFields(java.lang.String... axisFieldNames) 


void
setDefaultAxisDimension(java.lang.Integer defaultAxisDimension) 


void
setDefaultAxisDimension(java.lang.String axisFieldName,
                       int defaultAxisDimension) 


void
setDefaultAxisSourceFieldName(java.lang.String defaultAxisSourceFieldName) 


void
setDefaultDimensionMappings(int[] defaultDimensionMappings) 


void
setDestinationFieldName(java.lang.String sourceFieldName,
                       java.lang.String destinationFieldName) 


void
setDestinationFieldNamePrefix(java.lang.String prefix) 


void
setDimensionMappings(java.lang.String axisFieldName,
                    int... dimensionMappings) 


void
setSignalField(java.lang.String signalFieldSourceName) 


void
setUseDeviceName(boolean useDeviceName) 






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














Constructor Detail





DataDeviceBuilder
public DataDeviceBuilder(NexusObjectProvider<N> nexusObjectProvider,
                         boolean isPrimary)
Create a new DataDeviceBuilder for the given NexusObjectProvider.

Parameters:
nexusObjectProvider - nexus object provider wrapping a NXobject
isPrimary - true to build a PrimaryDataDevice, containing
   the @signal field for the NXdata group,
   false to build an AxisDataDevice.










Method Detail





newPrimaryDataDevice
public static <N extends NXobject> PrimaryDataDevice<N> newPrimaryDataDevice(NexusObjectProvider<N> nexusObjectProvider)
                                                                      throws NexusException

Throws:
NexusException








newPrimaryDataDevice
public static <N extends NXobject> PrimaryDataDevice<N> newPrimaryDataDevice(NexusObjectProvider<N> nexusObjectProvider,
                                                                             java.lang.String signalDataFieldName)
                                                                      throws NexusException

Throws:
NexusException








newPrimaryDataDeviceBuilder
public static <N extends NXobject> DataDeviceBuilder<N> newPrimaryDataDeviceBuilder(NexusObjectProvider<N> nexusObjectProvider)







newAxisDataDevice
public static <N extends NXobject> AxisDataDevice<N> newAxisDataDevice(NexusObjectProvider<N> nexusObjectProvider)
                                                                throws NexusException

Throws:
NexusException








newAxisDataDevice
public static <N extends NXobject> AxisDataDevice<N> newAxisDataDevice(NexusObjectProvider<N> nexusObjectProvider,
                                                                       java.lang.Integer defaultAxisDimension)
                                                                throws NexusException

Throws:
NexusException








newAxisDataDevice
public static <N extends NXobject> AxisDataDevice<N> newAxisDataDevice(NexusObjectProvider<N> nexusObjectProvider,
                                                                       java.lang.String defaultAxisSourceFieldName,
                                                                       java.lang.Integer defaultAxisDimension)
                                                                throws NexusException

Throws:
NexusException








newAxisDataDeviceBuilder
public static <N extends NXobject> DataDeviceBuilder<N> newAxisDataDeviceBuilder(NexusObjectProvider<N> nexusObjectProvider)







newAxisDataDeviceBuilder
public static <N extends NXobject> DataDeviceBuilder<N> newAxisDataDeviceBuilder(NexusObjectProvider<N> nexusObjectProvider,
                                                                                 java.lang.Integer defaultAxisDimension)







newAxisDataDeviceBuilder
public static <N extends NXobject> DataDeviceBuilder<N> newAxisDataDeviceBuilder(NexusObjectProvider<N> nexusObjectProvider,
                                                                                 java.lang.String defaultAxisSourceFieldName,
                                                                                 java.lang.Integer defaultAxisDimension)







setSignalField
public void setSignalField(java.lang.String signalFieldSourceName)







clearAxisFields
public void clearAxisFields()







addAxisField
public void addAxisField(java.lang.String axisFieldName)







addAxisField
public void addAxisField(java.lang.String axisFieldName,
                         int defaultAxisDimension)







addAxisField
public void addAxisField(java.lang.String axisFieldName,
                         java.lang.String axisFieldDestinationName)







setDefaultAxisDimension
public void setDefaultAxisDimension(java.lang.String axisFieldName,
                                    int defaultAxisDimension)







addAxisField
public void addAxisField(java.lang.String axisFieldName,
                         int[] dimensionMappings)







setDimensionMappings
public void setDimensionMappings(java.lang.String axisFieldName,
                                 int... dimensionMappings)







addAxisFields
public void addAxisFields(java.lang.String... axisFieldNames)







setAxisFields
public void setAxisFields(java.lang.String... axisFieldNames)







setDefaultAxisDimension
public void setDefaultAxisDimension(java.lang.Integer defaultAxisDimension)







setDefaultAxisSourceFieldName
public void setDefaultAxisSourceFieldName(java.lang.String defaultAxisSourceFieldName)







setDefaultDimensionMappings
public void setDefaultDimensionMappings(int[] defaultDimensionMappings)







setUseDeviceName
public void setUseDeviceName(boolean useDeviceName)







setDestinationFieldNamePrefix
public void setDestinationFieldNamePrefix(java.lang.String prefix)







setDestinationFieldName
public void setDestinationFieldName(java.lang.String sourceFieldName,
                                    java.lang.String destinationFieldName)







build
public DataDevice<N> build()
                    throws NexusException
Builds and returns the data device. If primary was set to true, a
 PrimaryDataDevice will be returned, otherwise an AxisDataDevice will be
 returned

Returns:
data device
Throws:
NexusException














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