Package edu.uiuc.ncsa.qdl.variables

Class VTable<K extends XKey,V extends VThing>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

edu.uiuc.ncsa.qdl.state.XTable<K,V>

edu.uiuc.ncsa.qdl.variables.VTable<K,V>

All Implemented Interfaces:

Serializable, Cloneable, Map<K,V>

public class VTable<K extends XKey,V extends VThing>
extends XTable<K,V>

Created by Jeff Gaynor
on 2/20/22 at 6:12 AM

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>

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY_KEY
static String	VALUE_KEY

Fields inherited from class edu.uiuc.ncsa.qdl.state.XTable

FDOC_CONVERT

Constructor Summary

Constructors

Constructor	Description
VTable()

Method Summary

Modifier and Type	Method	Description
V	deserializeElement(XMLEventReader xer, SerializationState SerializationState, QDLInterpreter qi)
void	deserializeFromJSON(net.sf.json.JSONObject json, QDLInterpreter qi, SerializationState serializationState)
String	fromJSONEntry(String x, SerializationState serializationState)
void	fromXML(XMLEventReader xer, QDLInterpreter qi)
protected void	fromXMLEntry(XMLEventReader xer, QDLInterpreter qi)
String	getXMLElementTag()
String	getXMLTableTag()
Set<String>	listVariables()
net.sf.json.JSONObject	serializeToJSON(V xThing, SerializationState serializationState)	This serializes an entry.
String	toJSONEntry(V xThing, SerializationState serializationState)
void	toXML(XMLStreamWriter xsw, SerializationState SerializationState)
void	toXML2(XMLStreamWriter xsw, SerializationState serializationState)
protected void	toXMLEntry(V vThing, XMLStreamWriter xsw, SerializationState serializationState)	New format (version 2.1+) for non-modules is

Methods inherited from class edu.uiuc.ncsa.qdl.state.XTable

convertFDOC, fromXML, getID, getModuleUtils, put, serializeToJSON, toString

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

KEY_KEY

public static final String KEY_KEY

See Also:

Constant Field Values

VALUE_KEY

public static final String VALUE_KEY

See Also:

Constant Field Values

Constructor Detail

VTable

public VTable()

Method Detail

toXML2

public void toXML2(XMLStreamWriter xsw,
                   SerializationState serializationState)
            throws XMLStreamException

Throws:

XMLStreamException

toXMLEntry

protected void toXMLEntry(V vThing,
                          XMLStreamWriter xsw,
                          SerializationState serializationState)
                   throws XMLStreamException

New format (version 2.1+) for non-modules is

     <e type="qdl">
        <v>base64_encoded_QDL</v>
     </e>
 

and for modules it is

     <e type="module">
        <v>base64_encoded_QDL</v>
        <state inheritanceMode="...">serialized_module_state</state>
     </e>
 

Parameters:

vThing -

xsw -

serializationState -

Throws:

XMLStreamException

serializeToJSON

public net.sf.json.JSONObject serializeToJSON(V xThing,
                                              SerializationState serializationState)
                                       throws Throwable

This serializes an entry. The contract is that these are knitted into an array.

Specified by:

serializeToJSON in class XTable<K extends XKey,V extends VThing>

Parameters:

xThing -

serializationState -

Returns:

Throws:

Throwable

deserializeFromJSON

public void deserializeFromJSON(net.sf.json.JSONObject json,
                                QDLInterpreter qi,
                                SerializationState serializationState)
                         throws Throwable

Specified by:

deserializeFromJSON in class XTable<K extends XKey,V extends VThing>

Throws:

Throwable

fromXMLEntry

protected void fromXMLEntry(XMLEventReader xer,
                            QDLInterpreter qi)
                     throws XMLStreamException

Throws:

XMLStreamException

toXML

public void toXML(XMLStreamWriter xsw,
                  SerializationState SerializationState)
           throws XMLStreamException

Specified by:

toXML in class XTable<K extends XKey,V extends VThing>

Throws:

XMLStreamException

fromXML

public void fromXML(XMLEventReader xer,
                    QDLInterpreter qi)
             throws XMLStreamException

Specified by:

fromXML in class XTable<K extends XKey,V extends VThing>

Throws:

XMLStreamException

getXMLTableTag

public String getXMLTableTag()

Specified by:

getXMLTableTag in class XTable<K extends XKey,V extends VThing>

Returns:

getXMLElementTag

public String getXMLElementTag()

Specified by:

getXMLElementTag in class XTable<K extends XKey,V extends VThing>

Returns:

deserializeElement

public V deserializeElement(XMLEventReader xer,
                            SerializationState SerializationState,
                            QDLInterpreter qi)
                     throws XMLStreamException

Specified by:

deserializeElement in class XTable<K extends XKey,V extends VThing>

Returns:

Throws:

XMLStreamException

toJSONEntry

public String toJSONEntry(V xThing,
                          SerializationState serializationState)

Specified by:

toJSONEntry in class XTable<K extends XKey,V extends VThing>

fromJSONEntry

public String fromJSONEntry(String x,
                            SerializationState serializationState)

Specified by:

fromJSONEntry in class XTable<K extends XKey,V extends VThing>

listVariables

public Set<String> listVariables()