generated.docs.javadoc.org.eclipse.dawnsci.nexus.impl.NXuserImpl.html Maven / Gradle / Ivy






NXuserImpl (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.impl
Class NXuserImpl



java.lang.Object


org.eclipse.dawnsci.analysis.tree.impl.NodeImpl


org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl


org.eclipse.dawnsci.nexus.impl.NXobjectImpl


org.eclipse.dawnsci.nexus.impl.NXuserImpl













All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXobject, NXuser




public class NXuserImpl
extends NXobjectImpl
implements NXuser
Contact information for a user.
 The format allows more
 than one user with the same affiliation and contact information,
 but a second :ref:`NXuser` group should be used if they have different
 affiliations, etc.

See Also:
Serialized Form












Field Summary

Fields 

Modifier and Type
Field and Description


static java.util.Set<NexusBaseClass>
PERMITTED_CHILD_GROUP_CLASSES 






Fields inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
NX_CLASS





Fields inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
attributes, id, INDENT





Fields inherited from interface org.eclipse.dawnsci.nexus.NXuser
NX_ADDRESS, NX_AFFILIATION, NX_EMAIL, NX_FACILITY_USER_ID, NX_FAX_NUMBER, NX_NAME, NX_ROLE, NX_TELEPHONE_NUMBER





Fields inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
ATTRIBUTE, SEPARATOR








Constructor Summary

Constructors 

Constructor and Description


NXuserImpl() 


NXuserImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


IDataset
getAddress()
Address of user



java.lang.String
getAddressScalar()
Address of user



IDataset
getAffiliation()
Affiliation of user



java.lang.String
getAffiliationScalar()
Affiliation of user



IDataset
getEmail()
Email of user



java.lang.String
getEmailScalar()
Email of user



IDataset
getFacility_user_id()
facility based unique identifier for this person
 e.g.



java.lang.String
getFacility_user_idScalar()
facility based unique identifier for this person
 e.g.



IDataset
getFax_number()
Fax number of user



java.lang.String
getFax_numberScalar()
Fax number of user



IDataset
getName()
Name of user responsible for this entry



java.lang.String
getNameScalar()
Name of user responsible for this entry



NexusBaseClass
getNexusBaseClass()
Enum constant from NexusBaseClass for this base class, e.g.



java.lang.Class<? extends NXobject>
getNXclass()
Java Class object of the interface for this base class, e.g.



java.util.Set<NexusBaseClass>
getPermittedChildGroupClasses()
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.



IDataset
getRole()
Role of user responsible for this entry.



java.lang.String
getRoleScalar()
Role of user responsible for this entry.



IDataset
getTelephone_number()
Telephone number of user



java.lang.String
getTelephone_numberScalar()
Telephone number of user



DataNode
setAddress(IDataset address)
Address of user



DataNode
setAddressScalar(java.lang.String address)
Address of user



DataNode
setAffiliation(IDataset affiliation)
Affiliation of user



DataNode
setAffiliationScalar(java.lang.String affiliation)
Affiliation of user



DataNode
setEmail(IDataset email)
Email of user



DataNode
setEmailScalar(java.lang.String email)
Email of user



DataNode
setFacility_user_id(IDataset facility_user_id)
facility based unique identifier for this person
 e.g.



DataNode
setFacility_user_idScalar(java.lang.String facility_user_id)
facility based unique identifier for this person
 e.g.



DataNode
setFax_number(IDataset fax_number)
Fax number of user



DataNode
setFax_numberScalar(java.lang.String fax_number)
Fax number of user



DataNode
setName(IDataset name)
Name of user responsible for this entry



DataNode
setNameScalar(java.lang.String name)
Name of user responsible for this entry



DataNode
setRole(IDataset role)
Role of user responsible for this entry.



DataNode
setRoleScalar(java.lang.String role)
Role of user responsible for this entry.



DataNode
setTelephone_number(IDataset telephone_number)
Telephone number of user



DataNode
setTelephone_numberScalar(java.lang.String telephone_number)
Telephone number of user







Methods inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
addExternalLink, appendNodeString, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setDate, setField, setString





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, createNodeLink, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isGroupNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool, toString





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isSymbolicNode





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





Methods inherited from interface org.eclipse.dawnsci.nexus.NXobject
addExternalLink, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setField





Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.GroupNode
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool





Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isGroupNode, isSymbolicNode





Methods inherited from interface java.lang.Iterable
forEach, spliterator














Field Detail





PERMITTED_CHILD_GROUP_CLASSES
public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES









Constructor Detail





NXuserImpl
public NXuserImpl()







NXuserImpl
public NXuserImpl(long oid)









Method Detail





getNXclass
public java.lang.Class<? extends NXobject> getNXclass()
Description copied from interface: NXobject
Java Class object of the interface for this base class, e.g. NXsample.class.

Specified by:
getNXclass in interface NXobject
Returns:
name of Nexus class








getNexusBaseClass
public NexusBaseClass getNexusBaseClass()
Description copied from interface: NXobject
Enum constant from NexusBaseClass for this base class, e.g. NexusBaseClass.NX_SAMPLE.

Specified by:
getNexusBaseClass in interface NXobject
Returns:
NexusBaseClass enum constant for this class








getPermittedChildGroupClasses
public java.util.Set<NexusBaseClass> getPermittedChildGroupClasses()
Description copied from interface: NXobject
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.

Specified by:
getPermittedChildGroupClasses in interface NXobject
Returns:
NexusBaseClass constants for permitted child groups








getName
public IDataset getName()
Description copied from interface: NXuser
Name of user responsible for this entry

Specified by:
getName in interface NXuser
Returns:
the value.








getNameScalar
public java.lang.String getNameScalar()
Description copied from interface: NXuser
Name of user responsible for this entry

Specified by:
getNameScalar in interface NXuser
Returns:
the value.








setName
public DataNode setName(IDataset name)
Description copied from interface: NXuser
Name of user responsible for this entry

Specified by:
setName in interface NXuser
Parameters:
name - the name








setNameScalar
public DataNode setNameScalar(java.lang.String name)
Description copied from interface: NXuser
Name of user responsible for this entry

Specified by:
setNameScalar in interface NXuser
Parameters:
name - the name








getRole
public IDataset getRole()
Description copied from interface: NXuser
Role of user responsible for this entry.
 Suggested roles are "local_contact",
 "principal_investigator", and "proposer"

Specified by:
getRole in interface NXuser
Returns:
the value.








getRoleScalar
public java.lang.String getRoleScalar()
Description copied from interface: NXuser
Role of user responsible for this entry.
 Suggested roles are "local_contact",
 "principal_investigator", and "proposer"

Specified by:
getRoleScalar in interface NXuser
Returns:
the value.








setRole
public DataNode setRole(IDataset role)
Description copied from interface: NXuser
Role of user responsible for this entry.
 Suggested roles are "local_contact",
 "principal_investigator", and "proposer"

Specified by:
setRole in interface NXuser
Parameters:
role - the role








setRoleScalar
public DataNode setRoleScalar(java.lang.String role)
Description copied from interface: NXuser
Role of user responsible for this entry.
 Suggested roles are "local_contact",
 "principal_investigator", and "proposer"

Specified by:
setRoleScalar in interface NXuser
Parameters:
role - the role








getAffiliation
public IDataset getAffiliation()
Description copied from interface: NXuser
Affiliation of user

Specified by:
getAffiliation in interface NXuser
Returns:
the value.








getAffiliationScalar
public java.lang.String getAffiliationScalar()
Description copied from interface: NXuser
Affiliation of user

Specified by:
getAffiliationScalar in interface NXuser
Returns:
the value.








setAffiliation
public DataNode setAffiliation(IDataset affiliation)
Description copied from interface: NXuser
Affiliation of user

Specified by:
setAffiliation in interface NXuser
Parameters:
affiliation - the affiliation








setAffiliationScalar
public DataNode setAffiliationScalar(java.lang.String affiliation)
Description copied from interface: NXuser
Affiliation of user

Specified by:
setAffiliationScalar in interface NXuser
Parameters:
affiliation - the affiliation








getAddress
public IDataset getAddress()
Description copied from interface: NXuser
Address of user

Specified by:
getAddress in interface NXuser
Returns:
the value.








getAddressScalar
public java.lang.String getAddressScalar()
Description copied from interface: NXuser
Address of user

Specified by:
getAddressScalar in interface NXuser
Returns:
the value.








setAddress
public DataNode setAddress(IDataset address)
Description copied from interface: NXuser
Address of user

Specified by:
setAddress in interface NXuser
Parameters:
address - the address








setAddressScalar
public DataNode setAddressScalar(java.lang.String address)
Description copied from interface: NXuser
Address of user

Specified by:
setAddressScalar in interface NXuser
Parameters:
address - the address








getTelephone_number
public IDataset getTelephone_number()
Description copied from interface: NXuser
Telephone number of user

Specified by:
getTelephone_number in interface NXuser
Returns:
the value.








getTelephone_numberScalar
public java.lang.String getTelephone_numberScalar()
Description copied from interface: NXuser
Telephone number of user

Specified by:
getTelephone_numberScalar in interface NXuser
Returns:
the value.








setTelephone_number
public DataNode setTelephone_number(IDataset telephone_number)
Description copied from interface: NXuser
Telephone number of user

Specified by:
setTelephone_number in interface NXuser
Parameters:
telephone_number - the telephone_number








setTelephone_numberScalar
public DataNode setTelephone_numberScalar(java.lang.String telephone_number)
Description copied from interface: NXuser
Telephone number of user

Specified by:
setTelephone_numberScalar in interface NXuser
Parameters:
telephone_number - the telephone_number








getFax_number
public IDataset getFax_number()
Description copied from interface: NXuser
Fax number of user

Specified by:
getFax_number in interface NXuser
Returns:
the value.








getFax_numberScalar
public java.lang.String getFax_numberScalar()
Description copied from interface: NXuser
Fax number of user

Specified by:
getFax_numberScalar in interface NXuser
Returns:
the value.








setFax_number
public DataNode setFax_number(IDataset fax_number)
Description copied from interface: NXuser
Fax number of user

Specified by:
setFax_number in interface NXuser
Parameters:
fax_number - the fax_number








setFax_numberScalar
public DataNode setFax_numberScalar(java.lang.String fax_number)
Description copied from interface: NXuser
Fax number of user

Specified by:
setFax_numberScalar in interface NXuser
Parameters:
fax_number - the fax_number








getEmail
public IDataset getEmail()
Description copied from interface: NXuser
Email of user

Specified by:
getEmail in interface NXuser
Returns:
the value.








getEmailScalar
public java.lang.String getEmailScalar()
Description copied from interface: NXuser
Email of user

Specified by:
getEmailScalar in interface NXuser
Returns:
the value.








setEmail
public DataNode setEmail(IDataset email)
Description copied from interface: NXuser
Email of user

Specified by:
setEmail in interface NXuser
Parameters:
email - the email








setEmailScalar
public DataNode setEmailScalar(java.lang.String email)
Description copied from interface: NXuser
Email of user

Specified by:
setEmailScalar in interface NXuser
Parameters:
email - the email








getFacility_user_id
public IDataset getFacility_user_id()
Description copied from interface: NXuser
facility based unique identifier for this person
 e.g. their identification code on the facility
 address/contact database

Specified by:
getFacility_user_id in interface NXuser
Returns:
the value.








getFacility_user_idScalar
public java.lang.String getFacility_user_idScalar()
Description copied from interface: NXuser
facility based unique identifier for this person
 e.g. their identification code on the facility
 address/contact database

Specified by:
getFacility_user_idScalar in interface NXuser
Returns:
the value.








setFacility_user_id
public DataNode setFacility_user_id(IDataset facility_user_id)
Description copied from interface: NXuser
facility based unique identifier for this person
 e.g. their identification code on the facility
 address/contact database

Specified by:
setFacility_user_id in interface NXuser
Parameters:
facility_user_id - the facility_user_id








setFacility_user_idScalar
public DataNode setFacility_user_idScalar(java.lang.String facility_user_id)
Description copied from interface: NXuser
facility based unique identifier for this person
 e.g. their identification code on the facility
 address/contact database

Specified by:
setFacility_user_idScalar in interface NXuser
Parameters:
facility_user_id - the facility_user_id














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
`IDataset`	`getAddress()` Address of user
`java.lang.String`	`getAddressScalar()` Address of user
`IDataset`	`getAffiliation()` Affiliation of user
`java.lang.String`	`getAffiliationScalar()` Affiliation of user
`IDataset`	`getEmail()` Email of user
`java.lang.String`	`getEmailScalar()` Email of user
`IDataset`	`getFacility_user_id()` facility based unique identifier for this person e.g.
`java.lang.String`	`getFacility_user_idScalar()` facility based unique identifier for this person e.g.
`IDataset`	`getFax_number()` Fax number of user
`java.lang.String`	`getFax_numberScalar()` Fax number of user
`IDataset`	`getName()` Name of user responsible for this entry
`java.lang.String`	`getNameScalar()` Name of user responsible for this entry
`NexusBaseClass`	`getNexusBaseClass()` Enum constant from `NexusBaseClass` for this base class, e.g.
`java.lang.Class<? extends NXobject>`	`getNXclass()` Java `Class` object of the interface for this base class, e.g.
`java.util.Set<NexusBaseClass>`	`getPermittedChildGroupClasses()` Returns a set containing the `NexusBaseClass` constants for the permitted child group types of this base class.
`IDataset`	`getRole()` Role of user responsible for this entry.
`java.lang.String`	`getRoleScalar()` Role of user responsible for this entry.
`IDataset`	`getTelephone_number()` Telephone number of user
`java.lang.String`	`getTelephone_numberScalar()` Telephone number of user
`DataNode`	`setAddress(IDataset address)` Address of user
`DataNode`	`setAddressScalar(java.lang.String address)` Address of user
`DataNode`	`setAffiliation(IDataset affiliation)` Affiliation of user
`DataNode`	`setAffiliationScalar(java.lang.String affiliation)` Affiliation of user
`DataNode`	`setEmail(IDataset email)` Email of user
`DataNode`	`setEmailScalar(java.lang.String email)` Email of user
`DataNode`	`setFacility_user_id(IDataset facility_user_id)` facility based unique identifier for this person e.g.
`DataNode`	`setFacility_user_idScalar(java.lang.String facility_user_id)` facility based unique identifier for this person e.g.
`DataNode`	`setFax_number(IDataset fax_number)` Fax number of user
`DataNode`	`setFax_numberScalar(java.lang.String fax_number)` Fax number of user
`DataNode`	`setName(IDataset name)` Name of user responsible for this entry
`DataNode`	`setNameScalar(java.lang.String name)` Name of user responsible for this entry
`DataNode`	`setRole(IDataset role)` Role of user responsible for this entry.
`DataNode`	`setRoleScalar(java.lang.String role)` Role of user responsible for this entry.
`DataNode`	`setTelephone_number(IDataset telephone_number)` Telephone number of user
`DataNode`	`setTelephone_numberScalar(java.lang.String telephone_number)` Telephone number of user

Constructors
Constructor and Description
`NXuserImpl()`
`NXuserImpl(long oid)`