uk.ac.ebi.arrayexpress2.magetab.datamodel.graph

Class AbstractNode

java.lang.Object

uk.ac.ebi.arrayexpress2.magetab.datamodel.graph.AbstractNode

All Implemented Interfaces:

Node

Direct Known Subclasses:

AbstractADFNode, AbstractSDRFNode, UnresolvedPlaceholderNode

public abstract class AbstractNode
extends Object
implements Node

An abstract top-level implementation of a Node in the MAGE-TAB graph. This takes care of getting and setting node types and names, and the child nodes.

Author:

Tony Burdett

Field Summary

Fields

Modifier and Type	Field and Description
protected String	nodeName

Constructor Summary

Constructors

Constructor and Description
AbstractNode()
AbstractNode(String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildNode(Node childNode) Adds the child node to this Node.
void	addChildNode(String tag, String value) Adds a child node to this Node.
void	addParentNode(Node parentNode) Adds a parent node to this node
void	addParentNode(String tag, String value) Adds a parent node to this Node.
boolean	equals(Object obj) Nodes are determined to be equal() if they are of the same class, have the same Node.getNodeType() value and the same getNodeName() value.
Set<Node>	getChildNodes() Returns the set of nodes that are children of this node.
protected org.slf4j.Logger	getLog()
String	getNodeName() Get the value associated to this node in the spreadsheet.
Set<Node>	getParentNodes() Returns the set of nodes that are parents of this node.
int	hashCode()
void	removeChildNode(Node childNode) Removes the reference to the child from this node
void	removeParentNode(Node parentNode) Removes the reference to the parent from this node
void	setNodeName(String nodeName) Set the value associated to this node in the spreadsheet.
String	toString()
boolean	updateChildNode(Node nodeToUpdate) Updates a child node equal to the supplied node with a new object reference.
boolean	updateParentNode(Node nodeToUpdate) Updates a parent node equal to the supplied node with a new object reference.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.ac.ebi.arrayexpress2.magetab.datamodel.graph.Node

getNodeType

Field Detail

nodeName

protected volatile String nodeName

Constructor Detail

AbstractNode

public AbstractNode()

AbstractNode

public AbstractNode(String name)

Method Detail

setNodeName

public void setNodeName(String nodeName)

Description copied from interface: Node

Set the value associated to this node in the spreadsheet. In other words, the particular entry in the current row under the given type.

Specified by:

setNodeName in interface Node

Parameters:

nodeName - the value for this node name entry

getNodeName

public String getNodeName()

Description copied from interface: Node

Get the value associated to this node in the spreadsheet. In other words, the particular entry in the current row under the given type.

Specified by:

getNodeName in interface Node

Returns:

the value for this node name entry

addChildNode

public void addChildNode(Node childNode)

Description copied from interface: Node

Adds the child node to this Node.

Specified by:

addChildNode in interface Node

Parameters:

childNode - the node to add

removeChildNode

public void removeChildNode(Node childNode)

Description copied from interface: Node

Removes the reference to the child from this node

Specified by:

removeChildNode in interface Node

Parameters:

childNode - the node to remove

addChildNode

public void addChildNode(String tag,
                String value)

Description copied from interface: Node

Adds a child node to this Node. The child node will be a placeholder until all references are correctly resolved, but this placeholder will be equal to the actual node.

Specified by:

addChildNode in interface Node

Parameters:

tag - the type (or column header, or tag) of the node to add

value - the value (or node name) of the node to add

getChildNodes

public Set<Node> getChildNodes()

Description copied from interface: Node

Returns the set of nodes that are children of this node.

Specified by:

getChildNodes in interface Node

Returns:

the nodes that are directly linked downstream of this node

updateChildNode

public boolean updateChildNode(Node nodeToUpdate)

Description copied from interface: Node

Updates a child node equal to the supplied node with a new object reference. Use this whenever temporary nodes (usually of type UnresolvedPlaceholderNode) have been stored, and are subsequently updated with a correct type.

This method capitalises on the fact that nodes with the same type and name parameter are equal, even if the actual object references are different. Invoking this method updates the node to the new reference.

Specified by:

updateChildNode in interface Node

Parameters:

nodeToUpdate - the new object reference to use

Returns:

true if the node was replaced, false otherwise

addParentNode

public void addParentNode(Node parentNode)

Description copied from interface: Node

Adds a parent node to this node

Specified by:

addParentNode in interface Node

Parameters:

parentNode - the parent node to add

removeParentNode

public void removeParentNode(Node parentNode)

Description copied from interface: Node

Removes the reference to the parent from this node

Specified by:

removeParentNode in interface Node

Parameters:

parentNode - the node to remove

addParentNode

public void addParentNode(String tag,
                 String value)

Description copied from interface: Node

Adds a parent node to this Node. The parent node will be a placeholder until all references are correctly resolved, but this placeholder will be equal to the actual node.

Specified by:

addParentNode in interface Node

Parameters:

tag - the type (or column header, or tag) of the node to add

value - the value (or node name) of the node to add

getParentNodes

public Set<Node> getParentNodes()

Description copied from interface: Node

Returns the set of nodes that are parents of this node.

Specified by:

getParentNodes in interface Node

Returns:

the parents of this node

updateParentNode

public boolean updateParentNode(Node nodeToUpdate)

Description copied from interface: Node

Updates a parent node equal to the supplied node with a new object reference. Use this whenever temporary nodes (usually of type UnresolvedPlaceholderNode) have been stored, and are subsequently updated with a correct type.

This method capitalises on the fact that nodes with the same type and name parameter are equal, even if the actual object references are different. Invoking this method updates the node to the new reference.

Specified by:

updateParentNode in interface Node

Parameters:

nodeToUpdate - the new object reference to use

Returns:

true if the node was replaced, false otherwise

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Nodes are determined to be equal() if they are of the same class, have the same Node.getNodeType() value and the same getNodeName() value.

Overrides:

equals in class Object

Parameters:

obj - the object to compare for equality

Returns:

true if these objects are equal, false otherwise

getLog

protected org.slf4j.Logger getLog()