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






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






All Known Implementing Classes:
AttributeImpl




public interface Attribute
Represent an attribute of a node











Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


java.lang.String
getFirstElement() 


java.lang.String
getName() 


int
getRank() 


int[]
getShape() 


int
getSize()
Get number of items in attribute dataset



java.lang.String
getTypeName() 


IDataset
getValue()
Get dataset holding value(s) of attribute



boolean
isString() 


void
setTypeName(java.lang.String name)
Set name of attribute type



void
setValue(java.lang.Object obj)
Set value of attribute from given object



void
setValue(java.lang.Object obj,
        boolean isUnsigned)
Set value of attribute from given object
















Method Detail





getName
java.lang.String getName()

Returns:
name of attribute








isString
boolean isString()

Returns:
true if attribute contains strings








getTypeName
java.lang.String getTypeName()

Returns:
name of attribute type








setTypeName
void setTypeName(java.lang.String name)
Set name of attribute type

Parameters:
name - 








getRank
int getRank()

Returns:
rank of attribute dataset








getShape
int[] getShape()

Returns:
shape of attribute dataset








getSize
int getSize()
Get number of items in attribute dataset

Returns:
size








getFirstElement
java.lang.String getFirstElement()

Returns:
first element as string








getValue
IDataset getValue()
Get dataset holding value(s) of attribute

Returns:
dataset








setValue
void setValue(java.lang.Object obj)
Set value of attribute from given object

Parameters:
obj - 








setValue
void setValue(java.lang.Object obj,
              boolean isUnsigned)
Set value of attribute from given object

Parameters:
obj - 
isUnsigned - if true, interpret integer values as unsigned by increasing element bit width














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
`java.lang.String`	`getFirstElement()`
`java.lang.String`	`getName()`
`int`	`getRank()`
`int[]`	`getShape()`
`int`	`getSize()` Get number of items in attribute dataset
`java.lang.String`	`getTypeName()`
`IDataset`	`getValue()` Get dataset holding value(s) of attribute
`boolean`	`isString()`
`void`	`setTypeName(java.lang.String name)` Set name of attribute type
`void`	`setValue(java.lang.Object obj)` Set value of attribute from given object
`void`	`setValue(java.lang.Object obj, boolean isUnsigned)` Set value of attribute from given object