TPTP 4.5.0 Platform Project
Public API Specification

org.eclipse.hyades.loaders.common
Class XMLexecutionEventLoader

java.lang.Object
  extended by org.eclipse.hyades.loaders.hierarchy.IgnoredXMLFragmentLoader
      extended by org.eclipse.hyades.loaders.common.XMLexecutionEventLoader
All Implemented Interfaces:
IXMLEventConstants, BinaryFragmentLoader, XMLFragmentLoader
Direct Known Subclasses:
XMLinvocationEventLoader, XMLloopEventLoader, XMLmessageEventLoader, XMLtimedEventLoader, XMLtypedEventLoader, XMLverdictEventLoader

public abstract class XMLexecutionEventLoader
extends IgnoredXMLFragmentLoader
implements IXMLEventConstants

This is the base class for the execution event loaders and handles attributes of the base event.


Field Summary
static boolean DEBUG
           
static java.lang.String ROOT_PARENT
           
 
Fields inherited from interface org.eclipse.hyades.loaders.common.IXMLEventConstants
CONFLICT_IGNORE, CONFLICT_NONE, CONFLICT_OVERWRITE, CONFLICT_OVERWRITE_IF_EARLIEST, CONFLICT_OVERWRITE_IF_LATEST
 
Constructor Summary
XMLexecutionEventLoader()
           
 
Method Summary
 void addAttribute(java.lang.String name, java.lang.String value)
           
 void addCharacters(char[] data, int offset, int length)
           
 void addYourselfInContext()
          This is called on end of root element of each fragment
 void addYourselfToContainer()
          This method adds the event to the correct container within the execution result.
 void endChild(java.lang.String name)
           
 void initialize(HierarchyContext context, java.lang.String name)
          This is called on start of root element of each fragment
 void startChild(java.lang.String name)
           
 
Methods inherited from class org.eclipse.hyades.loaders.hierarchy.IgnoredXMLFragmentLoader
addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, cleanUp
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEBUG

public static final boolean DEBUG
See Also:
Constant Field Values

ROOT_PARENT

public static final java.lang.String ROOT_PARENT
See Also:
Constant Field Values
Constructor Detail

XMLexecutionEventLoader

public XMLexecutionEventLoader()
Method Detail

initialize

public void initialize(HierarchyContext context,
                       java.lang.String name)
Description copied from interface: XMLFragmentLoader
This is called on start of root element of each fragment

Specified by:
initialize in interface XMLFragmentLoader
Overrides:
initialize in class IgnoredXMLFragmentLoader

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.String value)
Specified by:
addAttribute in interface XMLFragmentLoader
Overrides:
addAttribute in class IgnoredXMLFragmentLoader

addCharacters

public void addCharacters(char[] data,
                          int offset,
                          int length)
Specified by:
addCharacters in interface XMLFragmentLoader
Overrides:
addCharacters in class IgnoredXMLFragmentLoader

startChild

public void startChild(java.lang.String name)
Specified by:
startChild in interface XMLFragmentLoader
Overrides:
startChild in class IgnoredXMLFragmentLoader

endChild

public void endChild(java.lang.String name)
Specified by:
endChild in interface XMLFragmentLoader
Overrides:
endChild in class IgnoredXMLFragmentLoader

addYourselfInContext

public void addYourselfInContext()
Description copied from interface: XMLFragmentLoader
This is called on end of root element of each fragment

Specified by:
addYourselfInContext in interface XMLFragmentLoader
Overrides:
addYourselfInContext in class IgnoredXMLFragmentLoader

addYourselfToContainer

public void addYourselfToContainer()
This method adds the event to the correct container within the execution result. The container may be specified by a parentId, or may be the root container (which is the outermost execution result, and is signified by an empty parentId.) If the parentId specifies an Invocation Event, then the invocation event is not actually the container. The real container is the execution history that is contained by the execution result contained by the invocation event. (Got that?) To make more sense of this, look at the data model, and see that an execution event can be contained by either another execution event, or by an execution history. If the parentId specifies an invocation event, then the container is really the execution history. If the sortBy field in the XML is not set, then the even is merely added to the execution history. If the sortBy field is set, then the event is inserted into the execution history in the right place based on the field its sorted on.


TPTP 4.5.0 Platform Project
Public API Specification