001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.util.tree;
031
032import java.util.ArrayList;
033import java.util.Iterator;
034import java.util.List;
035
036/**
037 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
038 *
039 * Tree node implementation
040 * @param <T> Type of the value object stored in the node.
041 */
042public class TreeNodeImpl<T> implements TreeNode<T> {
043        private static final long serialVersionUID = 1L;
044        
045        /**
046         * The value of the node.
047         */
048        public T value;
049        
050        /**
051     * The list of child nodes.
052     */
053    public List<TreeNode<T>> children = new ArrayList<TreeNode<T>>();
054    
055    /**
056     * Construct an empty node.
057     */
058    public TreeNodeImpl() {}
059    
060    /**
061     * Construct a node holding the given value.
062     * @param value the value.
063     */
064    public TreeNodeImpl(T value) {
065        this.value = value;
066    }
067    
068    @Override
069        public T getValue() {
070        return value;
071    }
072    
073    @Override
074        public void setValue(T value) {
075        this.value = value;
076    }
077    
078    @Override
079        public List<TreeNode<T>> getChildren() {
080        return children;
081    }
082    
083    @Override
084        public void addChild(TreeNode<T> tn) {
085        children.add(tn);
086    }
087    
088    @Override
089        public void removeChild(TreeNode<T> tn) {
090        children.remove(tn);
091    }
092    
093    @Override
094        public Iterator<TreeNode<T>> iterator() {
095        return children.iterator();
096    }
097    
098    @Override
099        public boolean isLeaf() {
100        return children.size() == 0;
101    }
102    
103    @Override
104        public String toString() {
105        String v = "Node("+value+")[";
106        for (TreeNode<T> ch : children)
107                v += ch.toString() +", ";
108        return v + "]";
109    }
110}