Package xal.smf.scada

Class ScadaFieldMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,ScadaFieldDescriptor>

xal.smf.scada.ScadaFieldMap

All Implemented Interfaces:

Serializable, Cloneable, Map<String,ScadaFieldDescriptor>

public class ScadaFieldMap
extends HashMap<String,ScadaFieldDescriptor>

This class parses the meta-data of the AScada.Field annotation used to identify fields in data structures as Supervisory Control And Data Acquisition (SCADA) fields. The meta-data is taken from each field annotation and is used to populate a ScadaFieldDescriptor object. The sum of all annotation data for each field is returned as a map of the data structure field name to the actual field descriptor.

NOTE:

This whole mechanism of ScadaFieldDescriptor usage is (hopefully) going to be eradicated. It is too clumsy and the Java Annotation mechanism seems more appropriate.

Ported from XAL on Jul 15, 2014.
· Jonathan M. Freed

Since:

Mar 9, 2011

Author:

Christopher K. Allen

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

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

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
ScadaFieldMap(Class<?> clsScada)	Create a new SCADA field map object for the given SCADA data structure.
ScadaFieldMap(List<ScadaFieldDescriptor> lstFlds)	Create a new SCADA field map object which contains the fields in the given list.

Method Summary

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Details

ScadaFieldMap

public ScadaFieldMap(Class<?> clsScada)

Create a new SCADA field map object for the given SCADA data structure. The map is keyed by SCADA field name.

Parameters:

clsScada - class representing a SCADA data structure

Since:

Mar 9, 2011

ScadaFieldMap

public ScadaFieldMap(List<ScadaFieldDescriptor> lstFlds)

Create a new SCADA field map object which contains the fields in the given list.

NOTE:

The class ScadaFieldList is derived from the type List. Thus, objects of that type maybe be used as arguments.

Parameters:

lstFlds - list containing field descriptors to be mapped (keyed by field name)

Since:

Oct 14, 2011

See Also:

• ScadaFieldList