nz.ac.waikato.mcennis.rat.dataAquisition
Class ReadMemGraphXMLFile

java.lang.Object
  extended by nz.ac.waikato.mcennis.rat.graph.model.ModelShell
      extended by nz.ac.waikato.mcennis.rat.dataAquisition.ReadMemGraphXMLFile
All Implemented Interfaces:
Component, DataAquisition, Model

public class ReadMemGraphXMLFile
extends ModelShell
implements DataAquisition

Class for reading an arbitrary MemGraph XML file. Uses the GraphReader XML Parser. THe DTD is as follows:


 <!DOCTYPE dataObject [

   <!ELEMENT dataObject (graph)>

   <!ELEMENT graph (graphClass,graphName,graphProperties*,pathSet*,user*,userLink*,graph*)>

   <!ELEMENT graphClass (#PCDATA)>

   <!ELEMENT graphName (#PCDATA)>

   <!ELEMENT graphProperties (gClass,gValueClass,gType,gValue+)>

   <!ELEMENT gClass (#PCDATA)>

   <!ELEMENT gValueClass (#PCDATA)>

   <!ELEMENT gType (#PCDATA)>

   <!ELEMENT gValue (#PCDATA)>

   <!ELEMENT pathSet (path+)>

   <!ELEMENT path (actor+)>

   <!ELEMENT actor (actorType,actorID)>

   <!ELEMENT actorType (#PCDATA)>

   <!ELEMENT actorID (#PCDATA)>

   <!ELEMENT user (userClass,ID,properties*,page*)>

   <!ELEMENT ID (#PCDATA)>

   <!ELEMENT properties (propertiesClass,valueClass,type,value*)>

   <!ELEMENT type (#PCDATA)>

   <!ELEMENT value (#PCDATA)>

   <!ELEMENT valueClass (#PCDATA)>

   <!ELEMENT userLink (uClass,uStrength,uSourceType,uSourceID,uDestinationType,uDestinationID,uProperties)>

   <!ELEMENT uClass (#PCDATA)>

   <!ELEMENT uSourceType (#PCDATA)>

   <!ELEMENT uSourceID (#PCDATA)>

   <!ELEMENT uStrength (#PCDATA)>

   <!ELEMENT uDestinationType (#PCDATA)>

   <!ELEMENT uDestinationID (#PCDATA)>

   <!ELEMENT uProperties (uPropertiesClass,uValueClass,uPropertiesType,uPropertiesValue+)>

   <!ELEMENT uPropertiesClass (#PCDATA)>

   <!ELEMENT uPropertiesValueClass (#PCDATA)>

   <!ELEMENT uPropertiesType (#PCDATA)>

   <!ELEMENT uPropertiesValue (#PCDATA)>

   <!ELEMENT page (#PCDATA)>

 ]>

 
Parameters for this algorithm:


Field Summary
 
Fields inherited from class nz.ac.waikato.mcennis.rat.graph.model.ModelShell
listener
 
Constructor Summary
ReadMemGraphXMLFile()
           
 
Method Summary
 void cancel()
          Stop all collection at the end of the next entity (file, web-page, etc.)
 Graph get()
          Obtain a reference to the graph this object holds
 java.util.List<IODescriptor> getInputType()
          The input type describes all the different kinds of graph objects that are utilized (and hence required) by this object.
 java.util.List<IODescriptor> getOutputType()
          The output type describes all the different kinds of graph objects that are created during the execution of this algorithm.
 Properties getParameter()
          List of all parameters this component accepts.
 Parameter getParameter(java.lang.String param)
          Returns the specific parameter identified by its key-name.
 void init(Properties map)
          initializes the data aquisition algorithm.
 ReadMemGraphXMLFile prototype()
          All Components implement the prototype pattern.
 void set(Graph g)
          Set the graph to be populated by this object
 void start()
          Begin executing the data aquisition module
 
Methods inherited from class nz.ac.waikato.mcennis.rat.graph.model.ModelShell
addListener, fireChange
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface nz.ac.waikato.mcennis.rat.graph.model.Model
addListener
 

Constructor Detail

ReadMemGraphXMLFile

public ReadMemGraphXMLFile()
Method Detail

start

public void start()
Description copied from interface: DataAquisition
Begin executing the data aquisition module

Specified by:
start in interface DataAquisition

set

public void set(Graph g)
Description copied from interface: DataAquisition
Set the graph to be populated by this object

Specified by:
set in interface DataAquisition
Parameters:
g - graph to be created for analysis

get

public Graph get()
Description copied from interface: DataAquisition
Obtain a reference to the graph this object holds

Specified by:
get in interface DataAquisition
Returns:
graph created by this object

cancel

public void cancel()
Description copied from interface: DataAquisition
Stop all collection at the end of the next entity (file, web-page, etc.)

Specified by:
cancel in interface DataAquisition

getInputType

public java.util.List<IODescriptor> getInputType()
Description copied from interface: Component
The input type describes all the different kinds of graph objects that are utilized (and hence required) by this object. This result is only guaranteed to be fixed if structural parameters are not modified. This is an empty array if there is no input.

Specified by:
getInputType in interface Component
Returns:
IODescriptor array for this component
See Also:
IODescriptor

getOutputType

public java.util.List<IODescriptor> getOutputType()
Description copied from interface: Component
The output type describes all the different kinds of graph objects that are created during the execution of this algorithm. The result is only guaranteed to be fixed if structural parameters are not modified. This is an empty array if there is no output.

Specified by:
getOutputType in interface Component
Returns:
IODescriptor array for this component
See Also:
IODescriptor

getParameter

public Properties getParameter()
Description copied from interface: Component
List of all parameters this component accepts. Each parameter also has a distinct key-name used when initializing the object using the init method. If there are no parameters, null is returned.

Specified by:
getParameter in interface Component
Returns:
read-only array of Parameters

getParameter

public Parameter getParameter(java.lang.String param)
Description copied from interface: Component
Returns the specific parameter identified by its key-name. If no parameter is found with this key-name, null is returned.

Specified by:
getParameter in interface Component
Parameters:
param - key-name of the parameter
Returns:
named parameter

init

public void init(Properties map)
initializes the data aquisition algorithm. Note: no inputs and outputs are runtime dependant.

Specified by:
init in interface Component
Parameters:
map - map of the given properties naming parameters and their values in a string

prototype

public ReadMemGraphXMLFile prototype()
Description copied from interface: Component
All Components implement the prototype pattern. The new parameter has no common resources to the original that are not static resources o the class.

Specified by:
prototype in interface Component
Returns:
default-parameter version of the same class as the original.

Get Relational Analysis Toolkit at SourceForge.net. Fast, secure and Free Open Source software downloads