generated.docs.javadoc.org.eclipse.dawnsci.analysis.api.tree.Node.html Maven / Gradle / Ivy






Node (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.analysis.api.tree
Interface Node






All Known Subinterfaces:
DataNode, GroupNode, NXaperture, NXattenuator, NXbeam, NXbeam_stop, NXbending_magnet, NXcapillary, NXcite, NXcollection, NXcollimator, NXcontainer, NXcrystal, NXcylindrical_geometry, NXdata, NXdetector, NXdetector_group, NXdetector_module, NXdisk_chopper, NXelectrostatic_kicker, NXentry, NXenvironment, NXevent_data, NXfermi_chopper, NXfilter, NXflipper, NXfresnel_zone_plate, NXgeometry, NXgrating, NXguide, NXinsertion_device, NXinstrument, NXlog, NXmagnetic_kicker, NXmirror, NXmoderator, NXmonitor, NXmonochromator, NXnote, NXobject, NXoff_geometry, NXorientation, NXparameters, NXpinhole, NXpolarizer, NXpositioner, NXprocess, NXquadrupole_magnet, NXreflections, NXroot, NXsample, NXsample_component, NXsensor, NXseparator, NXshape, NXslit, NXsolenoid_magnet, NXsource, NXspin_rotator, NXsubentry, NXtransformations, NXtranslation, NXuser, NXvelocity_selector, NXxraylens, SymbolicNode


All Known Implementing Classes:
DataNodeImpl, GroupNodeImpl, NodeImpl, NXapertureImpl, NXattenuatorImpl, NXbeam_stopImpl, NXbeamImpl, NXbending_magnetImpl, NXcapillaryImpl, NXciteImpl, NXcollectionImpl, NXcollimatorImpl, NXcontainerImpl, NXcrystalImpl, NXcylindrical_geometryImpl, NXdataImpl, NXdetector_groupImpl, NXdetector_moduleImpl, NXdetectorImpl, NXdisk_chopperImpl, NXelectrostatic_kickerImpl, NXentryImpl, NXenvironmentImpl, NXevent_dataImpl, NXfermi_chopperImpl, NXfilterImpl, NXflipperImpl, NXfresnel_zone_plateImpl, NXgeometryImpl, NXgratingImpl, NXguideImpl, NXinsertion_deviceImpl, NXinstrumentImpl, NXlogImpl, NXmagnetic_kickerImpl, NXmirrorImpl, NXmoderatorImpl, NXmonitorImpl, NXmonochromatorImpl, NXnoteImpl, NXobjectImpl, NXoff_geometryImpl, NXorientationImpl, NXparametersImpl, NXpinholeImpl, NXpolarizerImpl, NXpositionerImpl, NXprocessImpl, NXquadrupole_magnetImpl, NXreflectionsImpl, NXrootImpl, NXsample_componentImpl, NXsampleImpl, NXsensorImpl, NXseparatorImpl, NXshapeImpl, NXslitImpl, NXsolenoid_magnetImpl, NXsourceImpl, NXspin_rotatorImpl, NXsubentryImpl, NXtransformationsImpl, NXtranslationImpl, NXuserImpl, NXvelocity_selectorImpl, NXxraylensImpl, SymbolicNodeImpl




public interface Node
Fundamental unit of tree which can possess attributes











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
ATTRIBUTE
String used as separator between a node and its attributes



static java.lang.String
SEPARATOR
String used as separator between a group and its children










Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


void
addAttribute(Attribute a)
Add given attribute to node



boolean
containsAttribute(java.lang.String name) 


Attribute
getAttribute(java.lang.String name)
Get attribute of given name from node



java.util.Iterator<? extends Attribute>
getAttributeIterator() 


java.util.Iterator<java.lang.String>
getAttributeNameIterator() 


long
getID() 


int
getNumberOfAttributes() 


boolean
isDataNode() 


boolean
isGroupNode() 


boolean
isSymbolicNode() 















Field Detail





SEPARATOR
static final java.lang.String SEPARATOR
String used as separator between a group and its children

See Also:
Constant Field Values








ATTRIBUTE
static final java.lang.String ATTRIBUTE
String used as separator between a node and its attributes

See Also:
Constant Field Values










Method Detail





getID
long getID()

Returns:
ID








getNumberOfAttributes
int getNumberOfAttributes()

Returns:
number of attributes on node








containsAttribute
boolean containsAttribute(java.lang.String name)

Parameters:
name - 
Returns:
true if node contains attribute of given name








getAttribute
Attribute getAttribute(java.lang.String name)
Get attribute of given name from node

Parameters:
name - 
Returns:
attribute (can be null if there is no attribute of given name)








addAttribute
void addAttribute(Attribute a)
Add given attribute to node

Parameters:
a - 








getAttributeNameIterator
java.util.Iterator<java.lang.String> getAttributeNameIterator()

Returns:
iterator over attribute names in node








getAttributeIterator
java.util.Iterator<? extends Attribute> getAttributeIterator()

Returns:
iterator over attribute names in node








isGroupNode
boolean isGroupNode()

Returns:
true if this node is a GroupNode,
 false otherwise








isDataNode
boolean isDataNode()

Returns:
true if this node is a DataNode,
 false otherwise








isSymbolicNode
boolean isSymbolicNode()

Returns:
true if this node is a SymbolicNode,
 false otherwise














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`	`ATTRIBUTE` String used as separator between a node and its attributes
`static java.lang.String`	`SEPARATOR` String used as separator between a group and its children

Modifier and Type	Method and Description
`void`	`addAttribute(Attribute a)` Add given attribute to node
`boolean`	`containsAttribute(java.lang.String name)`
`Attribute`	`getAttribute(java.lang.String name)` Get attribute of given name from node
`java.util.Iterator<? extends Attribute>`	`getAttributeIterator()`
`java.util.Iterator<java.lang.String>`	`getAttributeNameIterator()`
`long`	`getID()`
`int`	`getNumberOfAttributes()`
`boolean`	`isDataNode()`
`boolean`	`isGroupNode()`
`boolean`	`isSymbolicNode()`