Package edu.uiuc.ncsa.qdl.module

Class MIStack<V extends MITable<? extends XKey,? extends MIWrapper>>

java.lang.Object

edu.uiuc.ncsa.qdl.state.XStack<V>

edu.uiuc.ncsa.qdl.module.MIStack<V>

All Implemented Interfaces:

Serializable

public class MIStack<V extends MITable<? extends XKey,? extends MIWrapper>>
extends XStack<V>
implements Serializable

Created by Jeff Gaynor
on 1/29/22 at 7:25 AM

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MIStack()

Method Summary

Modifier and Type	Method	Description
void	fromXML(XMLEventReader xer, QDLInterpreter qi)
XThing	get(XKey key)
List<XKey>	getAliases(MTKey key)	For a given module namespace, return all current aliases.
List<String>	getAliasesAsString(MTKey key)	Same as getAliases(MTKey) except that the result is not a set of keys but a simple list of the aliases as strings.
Module	getModule(XKey xKey)	Convenience method that casts
XStack	getStateStack(State state)	This gets the stack corresponding to this class from the state..
String	getXMLStackTag()
String	getXMLTableTag()
XStack	newInstance()
XTable	newTableInstance()
void	setStateStack(State state, XStack xStack)	This sets the stack corresponding to this class from the state with the given stack.

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

addTables, allKeys, append, appendTables, clear, clone, containsKey, containsKey, deserializeFromJSON, deserializeFromJSONNEW, deserializeFromJSONOLD, fromJSON, fromXML, fromXMLNEW, getAll, getJSON, getLocal, getRoot, getStack, isEmpty, keySet, localGet, localHas, localPut, localRemove, main, nonlocalGet, peek, push, pushNewTable, put, put, remove, serializeContent, serializeToJSON, setStack, size, toJSON, toString, toXML, toXMLNEW

Methods inherited from class java.lang.Object

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

Constructor Detail

MIStack

public MIStack()

Method Detail

newInstance

public XStack newInstance()

Specified by:

newInstance in class XStack<V extends MITable<? extends XKey,? extends MIWrapper>>

newTableInstance

public XTable newTableInstance()

Specified by:

newTableInstance in class XStack<V extends MITable<? extends XKey,? extends MIWrapper>>

fromXML

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

Specified by:

fromXML in class XStack<V extends MITable<? extends XKey,? extends MIWrapper>>

Throws:

XMLStreamException

getModule

public Module getModule(XKey xKey)

Convenience method that casts

Parameters:

xKey -

Returns:

get

public XThing get(XKey key)

Overrides:

get in class XStack<V extends MITable<? extends XKey,? extends MIWrapper>>

getXMLStackTag

public String getXMLStackTag()

Specified by:

getXMLStackTag in class XStack<V extends MITable<? extends XKey,? extends MIWrapper>>

getXMLTableTag

public String getXMLTableTag()

Specified by:

getXMLTableTag in class XStack<V extends MITable<? extends XKey,? extends MIWrapper>>

Returns:

getAliases

public List<XKey> getAliases(MTKey key)

For a given module namespace, return all current aliases. Note that this means current overrides, so if there are multiple instances in the stack, only the active one is returned.

Parameters:

key -

Returns:

getAliasesAsString

public List<String> getAliasesAsString(MTKey key)

Same as getAliases(MTKey) except that the result is not a set of keys but a simple list of the aliases as strings. Mostly this is used in the workspace to display lists of aliases.

Parameters:

key -

Returns:

setStateStack

public void setStateStack(State state,
                          XStack xStack)

Description copied from class: XStack

This sets the stack corresponding to this class from the state with the given stack. If the stack is not of the correct type, a class cast exception will result.

We could have tried this with some type of dynamic casting, but that is messy and fragile in Java

Specified by:

setStateStack in class XStack<V extends MITable<? extends XKey,? extends MIWrapper>>

getStateStack

public XStack getStateStack(State state)

Description copied from class: XStack

This gets the stack corresponding to this class from the state..

Specified by:

getStateStack in class XStack<V extends MITable<? extends XKey,? extends MIWrapper>>

Returns: