Package edu.uiuc.ncsa.oa2.qdl.storage

Class StoreAccessModule

java.lang.Object

edu.uiuc.ncsa.qdl.module.Module

edu.uiuc.ncsa.qdl.extensions.JavaModule

edu.uiuc.ncsa.oa2.qdl.storage.StoreAccessModule

All Implemented Interfaces:

edu.uiuc.ncsa.qdl.state.XThing, Serializable, Cloneable

Direct Known Subclasses:

PStoreAccessModule

public class StoreAccessModule
extends edu.uiuc.ncsa.qdl.extensions.JavaModule

Created by Jeff Gaynor
on 12/18/20 at 3:09 PM

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	CFG_FILE_TAG
static String	CFG_NAME_TAG
static String	STORE_FACADE_TAG
static String	STORE_TYPE_TAG
protected StoreFacade	storeFacade

Fields inherited from class edu.uiuc.ncsa.qdl.extensions.JavaModule

funcs, vars

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

FDOC_CONVERT

Constructor Summary

Constructors

Constructor	Description
StoreAccessModule()
StoreAccessModule(URI namespace, String alias)

Method Summary

Modifier and Type	Method	Description
protected List<edu.uiuc.ncsa.qdl.extensions.QDLFunction>	createFList(StoreFacade sf)
protected List<edu.uiuc.ncsa.qdl.extensions.QDLVariable>	createVarList(StoreFacade sf)
protected void	doIt(StoreAccessModule sam, edu.uiuc.ncsa.qdl.state.State state)	This sets up the module.
List<String>	getDescription()
edu.uiuc.ncsa.qdl.module.Module	newInstance(edu.uiuc.ncsa.qdl.state.State state)	This will create the module and store.
StoreFacade	newStoreFacade()
protected String	processXML(XMLEventReader xer, String tag)	Each of the elements inside the STORE_FACADE_TAG has the same structure.
void	readExtraXMLElements(XMLEvent xe, XMLEventReader xer)
void	writeExtraXMLElements(XMLStreamWriter xsw)

Methods inherited from class edu.uiuc.ncsa.qdl.extensions.JavaModule

addFunctions, addVariables, createDefaultDocs, getClassname, getDocumentation, getListByTag, getLoaderClassName, init, init, isExternal, setClassName, setDocumentation, setLoaderClassName, writeExtraXMLAttributes

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

fromJSON, fromXML, fromXML, getAlias, getId, getKey, getListByTag, getMTKey, getName, getNamespace, getParentTemplateID, getState, isTemplate, readExtraXMLAttributes, setAlias, setId, setNamespace, setParentTemplateID, setState, setTemplate, setupModule, toJSON, toString, toXML, toXML

Methods inherited from class java.lang.Object

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

Field Detail

storeFacade

protected StoreFacade storeFacade

STORE_FACADE_TAG

public static final String STORE_FACADE_TAG

See Also:

Constant Field Values

CFG_FILE_TAG

public static final String CFG_FILE_TAG

See Also:

Constant Field Values

CFG_NAME_TAG

public static final String CFG_NAME_TAG

See Also:

Constant Field Values

STORE_TYPE_TAG

public static final String STORE_TYPE_TAG

See Also:

Constant Field Values

Constructor Detail

StoreAccessModule

public StoreAccessModule()

StoreAccessModule

public StoreAccessModule(URI namespace,
                         String alias)

Method Detail

newInstance

public edu.uiuc.ncsa.qdl.module.Module newInstance(edu.uiuc.ncsa.qdl.state.State state)

This will create the module and store. Then call doIt(StoreAccessModule, State) to finish off the setup.

Specified by:

newInstance in class edu.uiuc.ncsa.qdl.module.Module

Parameters:

state -

Returns:

doIt

protected void doIt(StoreAccessModule sam,
                    edu.uiuc.ncsa.qdl.state.State state)

This sets up the module.

Parameters:

sam -

state -

createVarList

protected List<edu.uiuc.ncsa.qdl.extensions.QDLVariable> createVarList(StoreFacade sf)

createFList

protected List<edu.uiuc.ncsa.qdl.extensions.QDLFunction> createFList(StoreFacade sf)

newStoreFacade

public StoreFacade newStoreFacade()

writeExtraXMLElements

public void writeExtraXMLElements(XMLStreamWriter xsw)
                           throws XMLStreamException

Overrides:

writeExtraXMLElements in class edu.uiuc.ncsa.qdl.module.Module

Throws:

XMLStreamException

processXML

protected String processXML(XMLEventReader xer,
                            String tag)
                     throws XMLStreamException

Each of the elements inside the STORE_FACADE_TAG has the same structure. This just slogs through that. Assumption is that this is on the start tag of the element

Parameters:

tag -

Throws:

XMLStreamException

readExtraXMLElements

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

Overrides:

readExtraXMLElements in class edu.uiuc.ncsa.qdl.module.Module

Throws:

XMLStreamException

getDescription

public List<String> getDescription()

Overrides:

getDescription in class edu.uiuc.ncsa.qdl.extensions.JavaModule