Package edu.uiuc.ncsa.qdl.extensions

Class JavaModule

java.lang.Object

edu.uiuc.ncsa.qdl.module.Module

edu.uiuc.ncsa.qdl.extensions.JavaModule

All Implemented Interfaces:

XThing, Serializable, Cloneable

Direct Known Subclasses:

CryptoModule, EGModule, QDLCLIToolsModule, QDLConvertModule, QDLDBModule, QDLDynamoDBModule, QDLHTTPModule, QDLMailModule

public abstract class JavaModule
extends Module

This will let you create your own extensions to QDL in Java. Simply implement the interfaces QDLFunction for functions and QDLVariable for variables, add the module and you can use it in QDL like any other module.

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<QDLFunction>	funcs
protected List<QDLVariable>	vars

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

FDOC_CONVERT

Constructor Summary

Constructors

Modifier	Constructor	Description
	JavaModule()	Used by QDLLoader
protected	JavaModule(URI namespace, String alias)	Used by the factory method Module.newInstance(State)

Method Summary

Modifier and Type	Method	Description
void	addFunctions(List<QDLFunction> functions)
void	addVariables(List<QDLVariable> variables)
List<String>	createDefaultDocs()	Creates the documentation from the first of each line of every function.
void	deserializeFromJSON(net.sf.json.JSONObject json, SerializationState serializationState)
String	getClassname()
List<String>	getDescription()	The createDefaultDocs() will create basic documentation for functions and such, and is called automatically during module init(State), but the actual description of this module -- if any -- is done here.
List<String>	getDocumentation()
List<String>	getListByTag()
String	getLoaderClassName()
QDLModuleMetaClass	getMetaClass()
boolean	hasMetaClass()
void	init(State state)	This is critical in that it puts all the functions and variables (with their correct alias) in to the state for this module.
void	init(State state, boolean doVariables)
boolean	isExternal()	This returns true only if the module is from another language than a QDL module.
net.sf.json.JSONObject	serializeToJSON(SerializationState serializationState)	The result of this is a json object
void	setClassName(String className)
void	setDocumentation(List<String> documentation)
void	setLoaderClassName(String loaderClassName)
void	setMetaClass(QDLModuleMetaClass metaClass)
void	writeExtraXMLAttributes(XMLStreamWriter xsw)	Add any attributes you want to the module tag (you must read them later).

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, isTemplate, newInstance, readExtraXMLAttributes, readExtraXMLElements, setAlias, setId, setInheritanceMode, setNamespace, setParentInstanceAlias, setParentInstanceID, setParentTemplateID, setState, setTemplate, setupModule, toJSON, toString, toXML, toXML, toXML2, writeExtraXMLElements

Methods inherited from class java.lang.Object

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

Field Detail

vars

protected List<QDLVariable> vars

funcs

protected List<QDLFunction> funcs

Constructor Detail

JavaModule

public JavaModule()

Used by QDLLoader

JavaModule

protected JavaModule(URI namespace,
                     String alias)

Used by the factory method Module.newInstance(State)

Parameters:

namespace -

alias -

Method Detail

isExternal

public boolean isExternal()

Description copied from class: Module

This returns true only if the module is from another language than a QDL module.

Overrides:

isExternal in class Module

Returns:

getClassname

public String getClassname()

setClassName

public void setClassName(String className)

getLoaderClassName

public String getLoaderClassName()

setLoaderClassName

public void setLoaderClassName(String loaderClassName)

addFunctions

public void addFunctions(List<QDLFunction> functions)

addVariables

public void addVariables(List<QDLVariable> variables)

init

public void init(State state)

This is critical in that it puts all the functions and variables (with their correct alias) in to the state for this module. Normally this is called when module_import is invoked on each module, so generally you do not need to call this ever. It is, however, what makes any module work.

Parameters:

state -

init

public void init(State state,
                 boolean doVariables)

writeExtraXMLAttributes

public void writeExtraXMLAttributes(XMLStreamWriter xsw)
                             throws XMLStreamException

Description copied from class: Module

Add any attributes you want to the module tag (you must read them later).

Overrides:

writeExtraXMLAttributes 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

createDefaultDocs

public List<String> createDefaultDocs()

Creates the documentation from the first of each line of every function. Use this or override as needed.

Returns:

getDescription

public List<String> getDescription()

The createDefaultDocs() will create basic documentation for functions and such, and is called automatically during module init(State), but the actual description of this module -- if any -- is done here. Override and return your description.

Returns:

getListByTag

public List<String> getListByTag()

Specified by:

getListByTag in class Module

setDocumentation

public void setDocumentation(List<String> documentation)

Specified by:

setDocumentation in class Module

getDocumentation

public List<String> getDocumentation()

Specified by:

getDocumentation in class Module

getMetaClass

public QDLModuleMetaClass getMetaClass()

setMetaClass

public void setMetaClass(QDLModuleMetaClass metaClass)

hasMetaClass

public boolean hasMetaClass()