Package edu.uiuc.ncsa.qdl.module

Class QDLModule

java.lang.Object

edu.uiuc.ncsa.qdl.module.Module

edu.uiuc.ncsa.qdl.module.QDLModule

All Implemented Interfaces:

XThing, Serializable, Cloneable

public class QDLModule
extends Module

Created by Jeff Gaynor
on 4/1/20 at 11:30 AM

See Also:

Serialized Form

Field Summary

Fields inherited from class edu.uiuc.ncsa.qdl.module.Module

FDOC_CONVERT

Constructor Summary

Constructors

Constructor	Description
QDLModule()

Method Summary

Modifier and Type	Method	Description
void	deserializeFromJSON(net.sf.json.JSONObject json, SerializationState serializationState)
List<String>	getDocumentation()
String	getFilePath()
List<String>	getListByTag()	Documentation resides in the module definition, so it is loaded here at parse time.
ModuleStatement	getModuleStatement()
List<String>	getSource()
Module	newInstance(State state)	Modules are effectively templates.
void	readExtraXMLElements(XMLEvent xe, XMLEventReader xer)	This passes in the current start event so you can add your own event loop and cases.
net.sf.json.JSONObject	serializeToJSON(SerializationState serializationState)	The result of this is a json object
void	setDocumentation(List<String> documentation)
void	setFilePath(String filePath)
void	setModuleStatement(ModuleStatement moduleStatement)
void	writeExtraXMLElements(XMLStreamWriter xsw)	Write extra elements.

Methods inherited from class edu.uiuc.ncsa.qdl.module.Module

fromJSON, fromXML, fromXML, getAlias, getId, getInheritMode, getKey, getListByTag, getMTKey, getName, getNamespace, getParentInstanceAlias, getParentInstanceID, getParentTemplateID, getState, isExternal, isTemplate, readExtraXMLAttributes, setAlias, setId, setInheritanceMode, setNamespace, setParentInstanceAlias, setParentInstanceID, setParentTemplateID, setState, setTemplate, setupModule, toJSON, toString, toXML, toXML, toXML2, writeExtraXMLAttributes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QDLModule

public QDLModule()

Method Detail

getFilePath

public String getFilePath()

setFilePath

public void setFilePath(String filePath)

getModuleStatement

public ModuleStatement getModuleStatement()

setModuleStatement

public void setModuleStatement(ModuleStatement moduleStatement)

getSource

public List<String> getSource()

newInstance

public Module newInstance(State state)

Description copied from class: Module

Modules are effectively templates. This passes in the state of the parser at the point a new module is required and the contract is to create a new instance of this module with the state. Note that the state passed in may have nothing to do with the state here. You are creating a new module for the given state using this as a template.

All implementations should gracefully handle a null state with the assumption that the full state will be set later. This is because of bootstrapping networks of modules during deserialization.

Specified by:

newInstance in class Module

Returns:

writeExtraXMLElements

public void writeExtraXMLElements(XMLStreamWriter xsw)
                           throws XMLStreamException

Description copied from class: Module

Write extra elements. You must control for the opening and closing tags. These are inserted right after the state element.

Overrides:

writeExtraXMLElements in class Module

Throws:

XMLStreamException

serializeToJSON

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

Description copied from class: Module

The result of this is a json object

Overrides:

serializeToJSON in class Module

Returns:

Throws:

Throwable

deserializeFromJSON

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

Overrides:

deserializeFromJSON in class Module

Throws:

Throwable

readExtraXMLElements

public void readExtraXMLElements(XMLEvent xe,
                                 XMLEventReader xer)
                          throws XMLStreamException

Description copied from class: Module

This passes in the current start event so you can add your own event loop and cases. Note you need have only a switch on the tag names you want.

Overrides:

readExtraXMLElements in class Module

Throws:

XMLStreamException

getListByTag

public List<String> getListByTag()

Documentation resides in the module definition, so it is loaded here at parse time.

Specified by:

getListByTag in class Module

Returns:

setDocumentation

public void setDocumentation(List<String> documentation)

Specified by:

setDocumentation in class Module

getDocumentation

public List<String> getDocumentation()

Specified by:

getDocumentation in class Module