nz.ac.waikato.mcennis.rat.graph
Class MemGraph

java.lang.Object
  nz.ac.waikato.mcennis.rat.graph.model.ModelShell
      nz.ac.waikato.mcennis.rat.graph.MemGraph

All Implemented Interfaces:

java.io.Serializable, Graph, Model, ParsedObject

Direct Known Subclasses:

Tree

public class MemGraph
extends ModelShell
implements Graph, java.io.Serializable

A graph object that is held entirely in memory

See Also:

nz.ac.waikato.mcennis.arm.graph.Graph, Serialized Form

Field Summary

Fields inherited from class nz.ac.waikato.mcennis.rat.graph.model.ModelShell

listener

Constructor Summary

MemGraph()
Creates a new instance of MemGraph

Method Summary

void	add(Actor u) Add a user to the graph.
void	add(Graph uid) Add a graph (g) to the graph.
void	add(Link link) Adds a userlink to the graph.
void	add(PathSet pathSet) Add a PathSet to this graph.
void	add(Property prop) Add a property to this graph.
void	addChild(Graph g) Set the given graph to be a child of the current graph.
void	anonymize() Replaces all actor IDs with an anonymous numeric ID.
void	close() Close database connections or write to file.
void	commit() Commit the contents to database or storage.
java.lang.String	escapeXML(java.lang.String base) Encode the string so that it is XML safe
Actor[]	getActor() Retrieve an array of all actors of all types.
Actor[]	getActor(java.lang.String type) Retrieve an array of all actors of a given type.
Actor	getActor(java.lang.String type, java.lang.String ID) Retrieve the users that has the given ID.
int	getActorCount(java.lang.String type) Returns the number of actors of the given type
java.util.Iterator<Actor>	getActorIterator(java.lang.String type) Create a read only iterator over all actors.
java.lang.String[]	getActorTypes() List all types - returns null if no actors exist.
Graph[]	getChildren() Returns the children graphs of this object or null if none exist
Graph	getChildren(java.lang.String id) Returns the children graph with the given id or null if there is not a child with that name.
Graph[]	getGraphs(java.util.regex.Pattern pattern) Creates an array of graph objects.
java.lang.String	getID() Return the ID associated with this Graph
Link[]	getLink() Return all user to user links in this graph in an array.
Link[]	getLink(java.lang.String type) Retrieve an array of all userlinks of the given type from this graph or null if no such links are in this graph.
Link[]	getLink(java.lang.String type, Actor source, Actor dest) Returns all links of the given type (relation) type going from actor sourceActor to actor destActor or null.
protected java.util.LinkedList<Link>	getLinkByDestination(Actor a)
Link[]	getLinkByDestination(java.lang.String type, Actor dest) Returns all links (edges, arcs) of type (relation) type that point to the given actor.
protected java.util.LinkedList<Link>	getLinkBySource(Actor a)
Link[]	getLinkBySource(java.lang.String type, Actor source) Returns all links (edges, arcs) of type (relation) type that go from the given actor to any destination.
java.lang.String[]	getLinkTypes() Returns all link types currently in this graph or null if no links are present.
Parameter[]	getParameters() Obtain a computer-readable description of the parameters and options this graph supports
Graph	getParent() Returns the parent graph of this object or null if this is a root graph
PathSet[]	getPathSet() Return all PathSets associated with this graph.
PathSet	getPathSet(java.lang.String id) Return the named PathSet.
Property[]	getProperty() Returns an array of all properties associated with this object or null if none exist
Property	getProperty(java.lang.String type) Return a property named by the given string or null if no property by this name exists
Graph	getSubGraph(java.util.Properties props, java.util.Set<Actor> actorList) Creates a new graph from the current graph using the Properties props containing the actors actor and all links that link between actors in actor.
Graph[]	getSubGraph(Query q) Return newly created subgraphs that matches the given query FIXME: Currently not implemented in any graph.
void	init(java.util.Properties map) Set the parameters of this graph from the following property object.
void	outputXML(java.io.Writer output, boolean isInnerGraph) Serializes MemGraphs to an XML file
void	remove(Actor u) Identifies the given user and removes it and all links involving it from the graph.
void	remove(Link ul) remove all user links with the same type, user ID, and artist ID from the graph
void	setID(java.lang.String id) Set this graph's ID to this value.
void	setSubGraph(Query q) Same as getSubGraph but the resulting graphs are stored internally NOTE: this interface may be removed.
void	setWriter(java.io.Writer w) Set the output stream to serialize into when closed

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

MemGraph

public MemGraph()

Creates a new instance of MemGraph

Method Detail

add

public void add(Link link)

Description copied from interface: Graph

Adds a userlink to the graph. There is no limit on the number of links between users or even with the same type, source user, and destination user.

Specified by:

add in interface Graph

Parameters:

link - description of a named link between two users

add

public void add(Actor u)

Description copied from interface: Graph

Add a user to the graph. This replaces the user if a user with the same ID already exists.

Specified by:

add in interface Graph

Parameters:

u - user to be included in the graph.

getActor

public Actor getActor(java.lang.String type,
                      java.lang.String ID)

Description copied from interface: Graph

Retrieve the users that has the given ID. Returns null if no user is in the graph with that ID.

Specified by:

getActor in interface Graph

ID - ID string identifying an user

Returns:

user object who has this ID or null if it is not present

getActor

public Actor[] getActor(java.lang.String type)

Description copied from interface: Graph

Retrieve an array of all actors of a given type. Returns null if there are no actors of that type in the graph.

Specified by:

getActor in interface Graph

Parameters:

type - class of actor to return

Returns:

array of actors of the given type

outputXML

public void outputXML(java.io.Writer output,
                      boolean isInnerGraph)
               throws java.io.IOException

Serializes MemGraphs to an XML file

Parameters:

output - output stream to serialize into

isInnerGraph - is this the root graph (requiring headers) or an inner graph.

Throws:

java.io.IOException

getActor

public Actor[] getActor()

Description copied from interface: Graph

Retrieve an array of all actors of all types. Returns null if no actors are in the graph.

Specified by:

getActor in interface Graph

Returns:

array of all users in the graph

getLinkBySource

public Link[] getLinkBySource(java.lang.String type,
                              Actor source)

Description copied from interface: Graph

Returns all links (edges, arcs) of type (relation) type that go from the given actor to any destination. Returns null if no such links exist.

Specified by:

getLinkBySource in interface Graph

Parameters:

type - type (relation) of link to return

source - starting point of the link

Returns:

Array of links or null

getLinkByDestination

public Link[] getLinkByDestination(java.lang.String type,
                                   Actor dest)

Description copied from interface: Graph

Returns all links (edges, arcs) of type (relation) type that point to the given actor. Returns null if no such links exist

Specified by:

getLinkByDestination in interface Graph

Parameters:

type - type (relation) of link to return

dest - actor pointed to by links

Returns:

Array of links or null

getLink

public Link[] getLink(java.lang.String type,
                      Actor source,
                      Actor dest)

Description copied from interface: Graph

Returns all links of the given type (relation) type going from actor sourceActor to actor destActor or null. This is typically 1 link or null, but the spec does not forbid multiple links of the same type (relation) between two actors.

Specified by:

getLink in interface Graph

Parameters:

type - type (relation) of the link to return

source - starting point of the link

dest - actor pointed to by links

Returns:

Array of links or null

getLink

public Link[] getLink()

Description copied from interface: Graph

Return all user to user links in this graph in an array. Returns null if no such user link exists.

Specified by:

getLink in interface Graph

Returns:

array of all userlinks or null

getLink

public Link[] getLink(java.lang.String type)

Description copied from interface: Graph

Retrieve an array of all userlinks of the given type from this graph or null if no such links are in this graph.

Specified by:

getLink in interface Graph

Returns:

array of all user links of a given type or null

remove

public void remove(Actor u)

Description copied from interface: Graph

Identifies the given user and removes it and all links involving it from the graph.

Specified by:

remove in interface Graph

Parameters:

u - user to be removed from the graph.

remove

public void remove(Link ul)

Description copied from interface: Graph

remove all user links with the same type, user ID, and artist ID from the graph

Specified by:

remove in interface Graph

Parameters:

ul - link to be removed from the graph.

getSubGraph

public Graph[] getSubGraph(Query q)

Description copied from interface: Graph

Return newly created subgraphs that matches the given query FIXME: Currently not implemented in any graph. FIXME: Query structure needs to be defined.

Specified by:

getSubGraph in interface Graph

Parameters:

q - query object to be executed.

Returns:

Array of graphs created by the query or null if none are created

setSubGraph

public void setSubGraph(Query q)

Description copied from interface: Graph

Same as getSubGraph but the resulting graphs are stored internally NOTE: this interface may be removed.

Specified by:

setSubGraph in interface Graph

Parameters:

q - Query to be executed

getProperty

public Property[] getProperty()

Description copied from interface: Graph

Returns an array of all properties associated with this object or null if none exist

Specified by:

getProperty in interface Graph

Returns:

Array of properties

getProperty

public Property getProperty(java.lang.String type)

Description copied from interface: Graph

Return a property named by the given string or null if no property by this name exists

Specified by:

getProperty in interface Graph

Parameters:

type - property's name

Returns:

Given property

add

public void add(Property prop)

Description copied from interface: Graph

Add a property to this graph. If a property by this name already exists, it is overwritten with the given property.

Specified by:

add in interface Graph

Parameters:

prop - property to be added.

getPathSet

public PathSet[] getPathSet()

Description copied from interface: Graph

Return all PathSets associated with this graph. Null if no PathSets are in the current graph.

Specified by:

getPathSet in interface Graph

Returns:

Array of PathSets

add

public void add(PathSet pathSet)

Description copied from interface: Graph

Add a PathSet to this graph. If another PathSet of the same ID exists, it will be overwritten.

Specified by:

add in interface Graph

Parameters:

pathSet - PathSet to be added to this graph

getPathSet

public PathSet getPathSet(java.lang.String id)

Description copied from interface: Graph

Return the named PathSet. Returns null if no PathSet of the given ID exists.

Specified by:

getPathSet in interface Graph

Parameters:

id - ID of the PathSet to return

Returns:

PathSet specified by this ID

getLinkTypes

public java.lang.String[] getLinkTypes()

Description copied from interface: Graph

Returns all link types currently in this graph or null if no links are present.

Specified by:

getLinkTypes in interface Graph

Returns:

array of link types

getActorTypes

public java.lang.String[] getActorTypes()

Description copied from interface: Graph

List all types - returns null if no actors exist.

Specified by:

getActorTypes in interface Graph

Returns:

array of all type names in this graph

setID

public void setID(java.lang.String id)

Description copied from interface: Graph

Set this graph's ID to this value. Graph ID's must be unique.

Specified by:

setID in interface Graph

Parameters:

id - graph ID

getID

public java.lang.String getID()

Description copied from interface: Graph

Return the ID associated with this Graph

Specified by:

getID in interface Graph

Returns:

ID

getActorIterator

public java.util.Iterator<Actor> getActorIterator(java.lang.String type)

Description copied from interface: Graph

Create a read only iterator over all actors.

Specified by:

getActorIterator in interface Graph

Parameters:

type - type (mode) of actor to return

Returns:

iterator over all actors of the given type

add

public void add(Graph uid)

Description copied from interface: Graph

Add a graph (g) to the graph. Will be changed to be a graph helper - deprecated by addChild(Graph g)

Specified by:

add in interface Graph

Parameters:

uid - graph to be added

commit

public void commit()

Description copied from interface: Graph

Commit the contents to database or storage. This is a null operation for memory only objects. (Delaying committing changes to be in batches can result in a massive decrease in execution time.)

Specified by:

commit in interface Graph

close

public void close()

Description copied from interface: Graph

Close database connections or write to file. Operations on a graph after close are undefined.

Specified by:

close in interface Graph

setWriter

public void setWriter(java.io.Writer w)

Set the output stream to serialize into when closed

Parameters:

w - target output stream

escapeXML

public java.lang.String escapeXML(java.lang.String base)

Encode the string so that it is XML safe

Parameters:

base - string to encode

Returns:

escaped string

anonymize

public void anonymize()

Description copied from interface: Graph

Replaces all actor IDs with an anonymous numeric ID.

Specified by:

anonymize in interface Graph

getParent

public Graph getParent()

Description copied from interface: Graph

Returns the parent graph of this object or null if this is a root graph

Specified by:

getParent in interface Graph

Returns:

parent graph

getChildren

public Graph[] getChildren()

Description copied from interface: Graph

Returns the children graphs of this object or null if none exist

Specified by:

getChildren in interface Graph

Returns:

Array of graphs that are children of this graph

getChildren

public Graph getChildren(java.lang.String id)

Description copied from interface: Graph

Returns the children graph with the given id or null if there is not a child with that name.

Specified by:

getChildren in interface Graph

Parameters:

id - ID of the graph to return

Returns:

Graph with the given ID

addChild

public void addChild(Graph g)

Description copied from interface: Graph

Set the given graph to be a child of the current graph. NOTE: this does not verify that all actors and links only reference actors or links in the parent - this is the responsibility of the caller.

Specified by:

addChild in interface Graph

Parameters:

g - Child Graph

getSubGraph

public Graph getSubGraph(java.util.Properties props,
                         java.util.Set<Actor> actorList)
                  throws java.lang.Exception

Description copied from interface: Graph

Creates a new graph from the current graph using the Properties props containing the actors actor and all links that link between actors in actor.

Specified by:

getSubGraph in interface Graph

Parameters:

props - Properties for creating a new Graph

actorList - subset of graph's actors to make the subgraph from

Returns:

child graph of this graph

Throws:

java.lang.Exception - if actor is null or properties is null

getLinkBySource

protected java.util.LinkedList<Link> getLinkBySource(Actor a)

getLinkByDestination

protected java.util.LinkedList<Link> getLinkByDestination(Actor a)

getGraphs

public Graph[] getGraphs(java.util.regex.Pattern pattern)

Description copied from interface: Graph

Creates an array of graph objects. Created as follows: if the graph matches, it adds itself to the array, else it recursively checks every child. This ensures that algorithms only execute at one level of the tree.

Specified by:

getGraphs in interface Graph

Parameters:

pattern - Regular expression for identifying graphs

Returns:

array of graphs or an empty graph array if no graph matches

getActorCount

public int getActorCount(java.lang.String type)

Description copied from interface: Graph

Returns the number of actors of the given type

Specified by:

getActorCount in interface Graph

Parameters:

type - type of actor to query

Returns:

int number of actors of the given type

getParameters

public Parameter[] getParameters()

Description copied from interface: Graph

Obtain a computer-readable description of the parameters and options this graph supports

Specified by:

getParameters in interface Graph

Returns:

Description of all parameters this graph object supports.

init

public void init(java.util.Properties map)

Description copied from interface: Graph

Set the parameters of this graph from the following property object.

Specified by:

init in interface Graph

Parameters:

map - properties to be set