Package edu.uiuc.ncsa.qdl.module

Class MITable<K extends XKey,V extends MIWrapper>

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.module.MITable<K,V>

All Implemented Interfaces:

Documentable, Serializable, Cloneable, Map<K,V>

public class MITable<K extends XKey,V extends MIWrapper>
extends XTable<K,V>
implements Documentable

Table of modules keyed by alias.

Created by Jeff Gaynor
on 12/1/21 at 1:03 PM

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 inherited from class edu.uiuc.ncsa.qdl.state.XTable

FDOC_CONVERT

Constructor Summary

Constructors

Constructor	Description
MITable()

Method Summary

Modifier and Type	Method	Description
V	deserializeElement(XMLUtils.ModuleAttributes moduleAttributes, SerializationState serializationState)
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)
List<String>	getDocumentation(FKey key)
List<String>	getDocumentation(String fName, int argCount)	Get the complete documentation for a specific function.
UUID	getID()
String	getXMLElementTag()
String	getXMLTableTag()
List<String>	listAllDocs()	Return the first lines of all the function documentation this module knows.
List<String>	listAllDocs(String functionName)	Return the first line of all documentation for the given function name.
TreeSet<String>	listFunctions(String regex)	List first lines of function documentation given a regular expression.
V	put(XKey xKey, XThing xThing)
net.sf.json.JSONObject	serializeToJSON(V wrapper, SerializationState serializationState)
String	toJSONEntry(V wrapper, SerializationState serializationState)
void	toXML(XMLStreamWriter xsw, SerializationState serializationState)

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

convertFDOC, fromXML, 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

Constructor Detail

MITable

public MITable()

Method Detail

put

public V put(XKey xKey,
             XThing xThing)

toXML

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

Specified by:

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

Throws:

XMLStreamException

getXMLTableTag

public String getXMLTableTag()

Specified by:

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

Returns:

getXMLElementTag

public String getXMLElementTag()

Specified by:

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

Returns:

deserializeElement

public V deserializeElement(XMLUtils.ModuleAttributes moduleAttributes,
                            SerializationState serializationState)

deserializeElement

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

Specified by:

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

Returns:

Throws:

XMLStreamException

fromXML

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

Specified by:

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

Throws:

XMLStreamException

listFunctions

public TreeSet<String> listFunctions(String regex)

Description copied from interface: Documentable

List first lines of function documentation given a regular expression.

Specified by:

listFunctions in interface Documentable

Returns:

listAllDocs

public List<String> listAllDocs()

Description copied from interface: Documentable

Return the first lines of all the function documentation this module knows.

Specified by:

listAllDocs in interface Documentable

Returns:

listAllDocs

public List<String> listAllDocs(String functionName)

Description copied from interface: Documentable

Return the first line of all documentation for the given function name.

Specified by:

listAllDocs in interface Documentable

Returns:

getDocumentation

public List<String> getDocumentation(String fName,
                                     int argCount)

Description copied from interface: Documentable

Get the complete documentation for a specific function.

Specified by:

getDocumentation in interface Documentable

Returns:

getDocumentation

public List<String> getDocumentation(FKey key)

Specified by:

getDocumentation in interface Documentable

getID

public UUID getID()

Overrides:

getID in class XTable<K extends XKey,V extends MIWrapper>

toJSONEntry

public String toJSONEntry(V wrapper,
                          SerializationState serializationState)
                   throws Throwable

Specified by:

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

Throws:

Throwable

serializeToJSON

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

Specified by:

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

Throws:

Throwable

fromJSONEntry

public String fromJSONEntry(String x,
                            SerializationState serializationState)

Specified by:

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

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 MIWrapper>

Throws:

Throwable