generated.docs.javadoc.org.eclipse.dawnsci.nexus.builder.appdef.NexusApplicationBuilder.html Maven / Gradle / Ivy






NexusApplicationBuilder (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.builder.appdef
Interface NexusApplicationBuilder






All Known Implementing Classes:
AbstractNexusApplicationBuilder, TomoApplicationBuilder




public interface NexusApplicationBuilder
A interface for building NXsubentry for a NeXus application.











Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


<N extends NXobject>
N
add(NexusObjectProvider<N> nexusObjectProvider)
Adds the nexus object provided by the given NexusObjectProvider.



void
addDefaultGroups()
Adds the default groups to the subentry.



DataNode
getDataNode(java.lang.String relativePath)
Returns the data node with the given path relative to the NXsubentry for
 this application definition.



NXsubentry
getNXsubentry()
Returns the wrapped NXsubentry.



NexusDataBuilder
newData()
Creates a new NexusDataBuilder child of this application.



void
validate()
Validates this NeXus application according to the NXDL application definition.
















Method Detail





getNXsubentry
NXsubentry getNXsubentry()
Returns the wrapped NXsubentry. This can be used to make custom modifications.

Returns:
the wrapped NXsubentry








addDefaultGroups
void addDefaultGroups()
               throws NexusException
Adds the default groups to the subentry. This method should be called before
 any nexus objects are added to the entry

Throws:
NexusException - if the default groups cannot be added for any reason








add
<N extends NXobject> N add(NexusObjectProvider<N> nexusObjectProvider)
                    throws NexusException
Adds the nexus object provided by the given NexusObjectProvider.

Parameters:
nexusObjectProvider - 
Returns:
the added nexus object
Throws:
NexusException - if the nexus objects cannot be added for any reason








newData
NexusDataBuilder newData()
                  throws NexusException
Creates a new NexusDataBuilder child of this application. If the application definition defines links from fields within this data node
 to the subentry for the application definition, these will be automatically added when this method is invoked.

Returns:
nexus data model
Throws:
NexusException - if the new data cannot be created for any reason








getDataNode
DataNode getDataNode(java.lang.String relativePath)
              throws NexusException
Returns the data node with the given path relative to the NXsubentry for
 this application definition.

Parameters:
relativePath - 
Returns:
data node
Throws:
NexusException








validate
void validate()
       throws NexusValidationException
Validates this NeXus application according to the NXDL application definition.

Throws:
NexusValidationException - if the application is invalid














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
`<N extends NXobject> N`	`add(NexusObjectProvider<N> nexusObjectProvider)` Adds the nexus object provided by the given `NexusObjectProvider`.
`void`	`addDefaultGroups()` Adds the default groups to the subentry.
`DataNode`	`getDataNode(java.lang.String relativePath)` Returns the data node with the given path relative to the `NXsubentry` for this application definition.
`NXsubentry`	`getNXsubentry()` Returns the wrapped `NXsubentry`.
`NexusDataBuilder`	`newData()` Creates a new `NexusDataBuilder` child of this application.
`void`	`validate()` Validates this NeXus application according to the NXDL application definition.