net.maizegenetics.taxa.tree

Interface AttributeNode

All Superinterfaces:

Node, Serializable

All Known Implementing Classes:

SimpleNode

public interface AttributeNode
extends Node

interface for a node (includes branch) in a binary/non-binary rooted/unrooted tree. Unlike its superclass this node can have an arbitrary number of named attributes associated with it.

Version:

$Id: AttributeNode.java,v 1.1 2007/01/12 03:26:16 tcasstevens Exp $

Author:

Alexei Drummond, Korbinian Strimmer

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLADE_PROBABILITY attribute name for the probability of the clade defined by an internal node.
static String	MEAN_CLADE_HEIGHT attribute name for the mean height of this clade in a group of trees.
static String	NODE_HEIGHT_SE attribute name for the standard error on a node's height.
static String	SUBTREE_PROBABILITY attribute name for the probability of the subtree defined by an internal node.

Method Summary

Modifier and Type	Method and Description
Object	getAttribute(String name)
Enumeration	getAttributeNames()
void	setAttribute(String name, Object value) Sets a named attribute to the given value.

Methods inherited from interface net.maizegenetics.taxa.tree.Node

addChild, getBranchLength, getBranchLengthSE, getChild, getChildCount, getIdentifier, getNodeHeight, getNumber, getParent, getSequence, insertChild, isLeaf, isRoot, removeChild, setBranchLength, setBranchLengthSE, setChild, setIdentifier, setNodeHeight, setNodeHeight, setNumber, setParent, setSequence

Field Detail

NODE_HEIGHT_SE

static final String NODE_HEIGHT_SE

attribute name for the standard error on a node's height.

See Also:

Constant Field Values

CLADE_PROBABILITY

static final String CLADE_PROBABILITY

attribute name for the probability of the clade defined by an internal node.

See Also:

Constant Field Values

SUBTREE_PROBABILITY

static final String SUBTREE_PROBABILITY

attribute name for the probability of the subtree defined by an internal node.

See Also:

Constant Field Values

MEAN_CLADE_HEIGHT

static final String MEAN_CLADE_HEIGHT

attribute name for the mean height of this clade in a group of trees.

See Also:

Constant Field Values

Method Detail

setAttribute

void setAttribute(String name,
                  Object value)

Sets a named attribute to the given value.

Parameters:

name - the name of the attribute

value - the value to set the attribute

getAttribute

Object getAttribute(String name)

Parameters:

name - the name of the attribute.

Returns:

the attribute with the given name or null if it doesn't exist.

getAttributeNames

Enumeration getAttributeNames()

Returns:

an enumeration of the attributes that this node has.