unsw.cse.framescript
Class MicaBotSerialiser

java.lang.Object
  extended by unsw.cse.framescript.XMLSerialiser
      extended by unsw.cse.framescript.MicaBotSerialiser
All Implemented Interfaces:
Serialiser

public class MicaBotSerialiser
extends XMLSerialiser

Extends the FrameScript serialiser to work with the MicaBot terms.

Author:
mmcgill

Field Summary
 
Fields inherited from class unsw.cse.framescript.XMLSerialiser
ALTERNATIVE, ALTERNATIVES, ATOM, ATOMDEF, BECAUSE, CACHE, CLASS, COMMENT, COMMONVARIABLES, COMPOUND, CONCLUSION, CONDITION, CORNERSTONE, CURRENTCONTEXT, CURRENTTOPIC, DAEMON, DOMAIN, DOMAINS, DOUBLE, DVAL, EXCEPT, EXPR, EXPRLIST, FACET, FAILSAFE, FALSE, FRAMESCRIPT, FUNCTOR, GENERIC, GENERICS, HISTORY, ID, INFIX, INSTANCE, INSTANCES, INTEGER, IVAL, LIST, MULTIVALUED, NAME, NULL, NUMARGS, OFFSET, OPERATOR, PARENTS, PATTERN, POSTFIX, PREFIX, RDR, RECOGNISER, REFERENCE, RIGHT, SCRIPT, SCRIPTS, SEQUENCE, SLOT, SPECIFICATION, STR, STRING, SUBR, SUBRS, TEXT, TOPICS, TRACE, TRIGGER, TRUE, USEFULLMATCH, VALUE, VARIABLE, VERBOSE
 
Constructor Summary
MicaBotSerialiser()
           
 
Method Summary
 Term declareMobTypes(org.w3c.dom.Node n)
           
 java.lang.String declareReferences(int indentLevel)
          Declares the type and ID numbers of all referenced types as XML.
 Term parseMobTypeNode(org.w3c.dom.Node n)
           
 Term parseNode(org.w3c.dom.Node n)
          Parses a FrameScript term from and XML node.
 java.lang.String serialiseMobGeneric(MobGeneric mobtype, long id, int indentLevel)
           
 java.lang.String serialiseReferredTerm(Term t, long id, int indentLevel)
          Serialises a referenced term to XML.
 java.lang.String serialiseStatics(int indentLevel)
          Defines all static variables in XML.
 void serialiseTo(java.lang.String filename)
          Serialises FrameScript to a file.
 void unserialiseFrom(java.lang.String filename)
          Deserialises FrameScript from a file.
 
Methods inherited from class unsw.cse.framescript.XMLSerialiser
idParseError, indent, lookUpReference, parseAlternativesNode, parseAtomDefNode, parseAtomNode, parseCommentNode, parseCompoundNode, parseDomainNode, parseDoubleNode, parseExprListNode, parseExprNode, parseFacetDaemonNode, parseFacetsNode, parseGenericNode, parseInstanceNode, parseIntegerNode, parseListNode, parseParentsNode, parsePatternNode, parseRDRNode, parseReferenceNode, parseScriptDaemonNode, parseScriptNode, parseSequenceNode, parseSlotNode, parseStringNode, parseSubrNode, parseValueNode, parseVariableNode, putReference, serialise
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MicaBotSerialiser

public MicaBotSerialiser()
Method Detail

serialiseTo

public void serialiseTo(java.lang.String filename)
                 throws java.io.IOException
Description copied from interface: Serialiser
Serialises FrameScript to a file.

Specified by:
serialiseTo in interface Serialiser
Overrides:
serialiseTo in class XMLSerialiser
Parameters:
filename - name of the file to serialise to
Throws:
java.io.IOException - any exceptions writing to the file

serialiseStatics

public java.lang.String serialiseStatics(int indentLevel)
Description copied from class: XMLSerialiser
Defines all static variables in XML. Extensions should override and declare their variables.

Overrides:
serialiseStatics in class XMLSerialiser
Parameters:
indentLevel - the indentation level
Returns:
the static variables as an XML string

declareReferences

public java.lang.String declareReferences(int indentLevel)
Description copied from class: XMLSerialiser
Declares the type and ID numbers of all referenced types as XML. Extensions should override and declare any new types.

Overrides:
declareReferences in class XMLSerialiser
Parameters:
indentLevel - the indentation level
Returns:
declaration of all referenced terms in an XML string

serialiseReferredTerm

public java.lang.String serialiseReferredTerm(Term t,
                                              long id,
                                              int indentLevel)
Description copied from class: XMLSerialiser
Serialises a referenced term to XML. Extensions should override and define any new types.

Overrides:
serialiseReferredTerm in class XMLSerialiser
Parameters:
t - the term
id - the term id number
indentLevel - the indentation level
Returns:
the term defined as an xml string

serialiseMobGeneric

public java.lang.String serialiseMobGeneric(MobGeneric mobtype,
                                            long id,
                                            int indentLevel)

unserialiseFrom

public void unserialiseFrom(java.lang.String filename)
                     throws java.io.IOException,
                            unsw.cse.framescript.SerialisationException
Description copied from interface: Serialiser
Deserialises FrameScript from a file.

Specified by:
unserialiseFrom in interface Serialiser
Overrides:
unserialiseFrom in class XMLSerialiser
Parameters:
filename - the name of the file to deserialise from
Throws:
java.io.IOException - any errors reading from the file
unsw.cse.framescript.SerialisationException - any errors deserialising an object

parseNode

public Term parseNode(org.w3c.dom.Node n)
Description copied from class: XMLSerialiser
Parses a FrameScript term from and XML node. Extensions should override and look for any of their specific nodes first.

Overrides:
parseNode in class XMLSerialiser
Parameters:
n - the XML node

declareMobTypes

public Term declareMobTypes(org.w3c.dom.Node n)

parseMobTypeNode

public Term parseMobTypeNode(org.w3c.dom.Node n)