Package gda.data.metadata

Class NXMetaDataProvider

java.lang.Object

gda.factory.FindableBase

gda.data.metadata.NXMetaDataProvider

All Implemented Interfaces:

NexusTreeAppender, Findable, Map<String,Object>

public class NXMetaDataProvider
extends FindableBase
implements NexusTreeAppender, Map<String,Object>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	NXMetaDataProvider.ValueWithUnits	A simple record to store a value together with its associated units.

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
NXMetaDataProvider()

Method Summary

Modifier and Type	Method	Description
void	add(gda.data.metadata.MetaDataUserSuppliedItem userSupplied)	Deprecated, for removal: This API element is subject to removal in a future version.
void	add(Scannable scannable)
void	add(Object... args)
void	add(String key, Object value, String units)
void	appendToTopNode(INexusTree topNode)
void	clear()	Deprecated.
void	clearDynamicScannableMetadata()	Removes all scannables added with NXMetaDataProvider.add(..).
String	concatenateContentsForList(boolean withValues, String preamble, String lsNextItemSeparator, String llMidConnector, String llNextItemSeparator)	Deprecated, for removal: This API element is subject to removal in a future version. client code should not call this method directly, instead call list(boolean)
boolean	containsKey(Object key)	Deprecated.
boolean	containsValue(Object value)	Deprecated.
INexusTree	createChildNodeForMetaTextEntry(String name, String nxClass, INexusTree parentNode, NexusGroupData groupData)	Deprecated, for removal: This API element is subject to removal in a future version.
INexusTree	createChildNodeForScannableMetaEntry(Scannable scannable, INexusTree parentNode, Map<String,Object> scannableMap)	Deprecated, for removal: This API element is subject to removal in a future version.
INexusTree	createChildNodeForTextualMetaEntry(INexusTree parentNode, String name, Object value, String units)	Deprecated, for removal: This API element is subject to removal in a future version.
Map<String,Object>	createMetaScannableMap(Scannable scannable)	Deprecated, for removal: This API element is subject to removal in a future version.
NexusGroupData	createNexusGroupData(Object object)	Deprecated.
NexusGroupData	createNexusGroupDataInternal(Object object)
Set<Map.Entry<String,Object>>	entrySet()	Deprecated.
boolean	equals(Object o)
Object	get(Object key)	Deprecated.
String	getFieldItemSeparator()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getFloatArrayFormat()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getGroupItemSeparator()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getIntArrayFormat()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getLlArrayClose()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getLlArrayItemSeparator()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getLlArrayOpen()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getLlNextItemSeparator()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getLlUnitsSeparator()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getLsNextItemSeparator()	Deprecated, for removal: This API element is subject to removal in a future version.
Map<String,NXMetaDataProvider.ValueWithUnits>	getMetadataValuesAndUnits()
List<Scannable>	getMetaScannables()
Map<String,Object>	getMetaTexts()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getName()	Get the object name.
String	getPreamble()	Deprecated, for removal: This API element is subject to removal in a future version.
List<String>	getScannableExtraNames(Scannable scannable)	Deprecated.
List<String>	getScannableFieldNames(Scannable scannable)	Deprecated.
List<String>	getScannableInputNames(Scannable scannable)	Deprecated.
static String	getScannableUnit(Scannable scannable)
boolean	hasGenuineMultipleFieldNames(Scannable scannable)
int	hashCode()
boolean	isEmpty()	Deprecated.
Set<String>	keySet()	Deprecated.
String	list(boolean withValues)
String	listAsString(String format, String delimiter)
void	modifyFormattingMap(Map<String,String> modificationsMap)	Deprecated, for removal: This API element is subject to removal in a future version. the map (formattingMap) that we modified here was never read.
Object	put(String key, Object value)	Deprecated.
void	putAll(Map<? extends String,? extends Object> m)
void	remove(Scannable scannable)
Object	remove(Object key)	Deprecated.
void	remove(Object... args)
void	reset()
Object[]	separateGetPositionOutputIntoElementalPosObjects(Object scannableGetPositionOut)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setFieldItemSeparator(String fieldItemSeparator)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setFloatArrayFormat(String llFloatArrayFormat)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setGroupItemSeparator(String groupItemSeparator)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setIntArrayFormat(String llIntArrayFormat)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setLlArrayClose(String llArrayClose)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setLlArrayItemSeparator(String llArrayItemSeparator)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setLlArrayOpen(String llArrayOpen)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setLlMidConnector(String llMidConnector)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setLlNextItemSeparator(String llNextItemSeparator)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setLlUnitsSeparator(String llUnitsSeparator)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setLsNextItemSeparator(String lsNextItemSeparator)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setMetaScannables(List<Scannable> metaScannables)
void	setMetaTexts(Map<String,String> metaTexts)
void	setPreamble(String preamble)	Deprecated, for removal: This API element is subject to removal in a future version.
int	size()	Deprecated.
Collection<Object>	values()	Deprecated.

Methods inherited from class gda.factory.FindableBase

setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Details

NXMetaDataProvider

public NXMetaDataProvider()

Method Details

setGroupItemSeparator

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public void setGroupItemSeparator(String groupItemSeparator)

Deprecated, for removal: This API element is subject to removal in a future version.

getGroupItemSeparator

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public String getGroupItemSeparator()

Deprecated, for removal: This API element is subject to removal in a future version.

setFieldItemSeparator

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public void setFieldItemSeparator(String fieldItemSeparator)

Deprecated, for removal: This API element is subject to removal in a future version.

getFieldItemSeparator

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public String getFieldItemSeparator()

Deprecated, for removal: This API element is subject to removal in a future version.

setPreamble

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public void setPreamble(String preamble)

Deprecated, for removal: This API element is subject to removal in a future version.

getPreamble

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public String getPreamble()

Deprecated, for removal: This API element is subject to removal in a future version.

setLsNextItemSeparator

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public void setLsNextItemSeparator(String lsNextItemSeparator)

Deprecated, for removal: This API element is subject to removal in a future version.

getLsNextItemSeparator

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public String getLsNextItemSeparator()

Deprecated, for removal: This API element is subject to removal in a future version.

setLlNextItemSeparator

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public void setLlNextItemSeparator(String llNextItemSeparator)

Deprecated, for removal: This API element is subject to removal in a future version.

getLlNextItemSeparator

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public String getLlNextItemSeparator()

Deprecated, for removal: This API element is subject to removal in a future version.

setLlMidConnector

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public void setLlMidConnector(String llMidConnector)

Deprecated, for removal: This API element is subject to removal in a future version.

setLlUnitsSeparator

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public void setLlUnitsSeparator(String llUnitsSeparator)

Deprecated, for removal: This API element is subject to removal in a future version.

getLlUnitsSeparator

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public String getLlUnitsSeparator()

Deprecated, for removal: This API element is subject to removal in a future version.

setLlArrayOpen

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public void setLlArrayOpen(String llArrayOpen)

Deprecated, for removal: This API element is subject to removal in a future version.

getLlArrayOpen

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public String getLlArrayOpen()

Deprecated, for removal: This API element is subject to removal in a future version.

setLlArrayClose

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public void setLlArrayClose(String llArrayClose)

Deprecated, for removal: This API element is subject to removal in a future version.

getLlArrayClose

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public String getLlArrayClose()

Deprecated, for removal: This API element is subject to removal in a future version.

setLlArrayItemSeparator

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public void setLlArrayItemSeparator(String llArrayItemSeparator)

Deprecated, for removal: This API element is subject to removal in a future version.

getLlArrayItemSeparator

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public String getLlArrayItemSeparator()

Deprecated, for removal: This API element is subject to removal in a future version.

setFloatArrayFormat

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public void setFloatArrayFormat(String llFloatArrayFormat)

Deprecated, for removal: This API element is subject to removal in a future version.

getFloatArrayFormat

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public String getFloatArrayFormat()

Deprecated, for removal: This API element is subject to removal in a future version.

setIntArrayFormat

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public void setIntArrayFormat(String llIntArrayFormat)

Deprecated, for removal: This API element is subject to removal in a future version.

getIntArrayFormat

@Deprecated(since="GDA 9.30",
            forRemoval=true)
public String getIntArrayFormat()

Deprecated, for removal: This API element is subject to removal in a future version.

appendToTopNode

public void appendToTopNode(INexusTree topNode)

Specified by:

appendToTopNode in interface NexusTreeAppender

reset

public void reset()

clearDynamicScannableMetadata

public void clearDynamicScannableMetadata()

Removes all scannables added with NXMetaDataProvider.add(..). Does not restore anything that was removed or overwritten.

listAsString

public String listAsString(String format,
 String delimiter)

setMetaTexts

public void setMetaTexts(Map<String,String> metaTexts)

getMetaTexts

@Deprecated(forRemoval=true,
            since="GDA 9.30")
public Map<String,Object> getMetaTexts()

Deprecated, for removal: This API element is subject to removal in a future version.

getMetadataValuesAndUnits

public Map<String,NXMetaDataProvider.ValueWithUnits> getMetadataValuesAndUnits()

add

public void add(String key,
 Object value,
 String units)

add

@Deprecated(forRemoval=true,
            since="GDA 9.30")
public void add(gda.data.metadata.MetaDataUserSuppliedItem userSupplied)

Deprecated, for removal: This API element is subject to removal in a future version.

size

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public int size()

Deprecated.

Specified by:

size in interface Map<String,Object>

isEmpty

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public boolean isEmpty()

Deprecated.

Specified by:

isEmpty in interface Map<String,Object>

containsKey

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public boolean containsKey(Object key)

Deprecated.

Specified by:

containsKey in interface Map<String,Object>

containsValue

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public boolean containsValue(Object value)

Deprecated.

Specified by:

containsValue in interface Map<String,Object>

get

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public Object get(Object key)

Deprecated.

Specified by:

get in interface Map<String,Object>

put

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public Object put(String key,
 Object value)

Deprecated.

Specified by:

put in interface Map<String,Object>

remove

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public Object remove(Object key)

Deprecated.

Specified by:

remove in interface Map<String,Object>

putAll

public void putAll(Map<? extends String,? extends Object> m)

Specified by:

putAll in interface Map<String,Object>

clear

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public void clear()

Deprecated.

Specified by:

clear in interface Map<String,Object>

keySet

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public Set<String> keySet()

Deprecated.

Specified by:

keySet in interface Map<String,Object>

values

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public Collection<Object> values()

Deprecated.

Specified by:

values in interface Map<String,Object>

entrySet

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public Set<Map.Entry<String,Object>> entrySet()

Deprecated.

Specified by:

entrySet in interface Map<String,Object>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class FindableBase

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,Object>

Overrides:

hashCode in class FindableBase

setMetaScannables

public void setMetaScannables(List<Scannable> metaScannables)

getMetaScannables

public List<Scannable> getMetaScannables()

list

public String list(boolean withValues)

concatenateContentsForList

@Deprecated(forRemoval=true,
            since="GDA 9.30")
public String concatenateContentsForList(boolean withValues,
 String preamble,
 String lsNextItemSeparator,
 String llMidConnector,
 String llNextItemSeparator)

Deprecated, for removal: This API element is subject to removal in a future version.

client code should not call this method directly, instead call list(boolean)

add

public void add(Object... args)

add

public void add(Scannable scannable)

remove

public void remove(Object... args)

remove

public void remove(Scannable scannable)

createMetaScannableMap

@Deprecated(forRemoval=true,
            since="GDA 9.30")
public Map<String,Object> createMetaScannableMap(Scannable scannable)
                                          throws DeviceException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

DeviceException

getName

public String getName()

Description copied from interface: Findable

Get the object name. Used by Castor to check if the object name has been set before calling the Findable.setName(String) method.

Specified by:

getName in interface Findable

Overrides:

getName in class FindableBase

Returns:

a String containing the object name.

getScannableFieldNames

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public List<String> getScannableFieldNames(Scannable scannable)

Deprecated.

getScannableInputNames

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public List<String> getScannableInputNames(Scannable scannable)

Deprecated.

getScannableExtraNames

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public List<String> getScannableExtraNames(Scannable scannable)

Deprecated.

createChildNodeForTextualMetaEntry

@Deprecated(forRemoval=true,
            since="GDA 9.30")
public INexusTree createChildNodeForTextualMetaEntry(INexusTree parentNode,
 String name,
 Object value,
 String units)

Deprecated, for removal: This API element is subject to removal in a future version.

createChildNodeForScannableMetaEntry

@Deprecated(forRemoval=true,
            since="GDA 9.30")
public INexusTree createChildNodeForScannableMetaEntry(Scannable scannable,
 INexusTree parentNode,
 Map<String,Object> scannableMap)

Deprecated, for removal: This API element is subject to removal in a future version.

hasGenuineMultipleFieldNames

public boolean hasGenuineMultipleFieldNames(Scannable scannable)

createNexusGroupData

@Deprecated(forRemoval=false,
            since="GDA 9.30")
public NexusGroupData createNexusGroupData(Object object)

Deprecated.

createNexusGroupDataInternal

public NexusGroupData createNexusGroupDataInternal(Object object)

separateGetPositionOutputIntoElementalPosObjects

@Deprecated(forRemoval=true,
            since="GDA 9.30")
public Object[] separateGetPositionOutputIntoElementalPosObjects(Object scannableGetPositionOut)

Deprecated, for removal: This API element is subject to removal in a future version.

getScannableUnit

public static String getScannableUnit(Scannable scannable)
                               throws DeviceException

Throws:

DeviceException

createChildNodeForMetaTextEntry

@Deprecated(forRemoval=true,
            since="GDA 9.30")
public INexusTree createChildNodeForMetaTextEntry(String name,
 String nxClass,
 INexusTree parentNode,
 NexusGroupData groupData)

Deprecated, for removal: This API element is subject to removal in a future version.

modifyFormattingMap

@Deprecated(forRemoval=true,
            since="GDA 9.30")
public void modifyFormattingMap(Map<String,String> modificationsMap)

Deprecated, for removal: This API element is subject to removal in a future version.

the map (formattingMap) that we modified here was never read. It has been deleted.

Parameters:

modificationsMap -