com.github.qbetti.petitpoucet.ProvenanceNode Maven / Gradle / Ivy

Go to download
/*
  Little Poucet - Trace data elements back to their sources
  Copyright (C) 2017 Sylvain Hallé

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program. If not, see .
 */
package com.github.qbetti.petitpoucet;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

public class ProvenanceNode
{	
	/**
	 * The ID of the data point
	 */
	protected final NodeFunction m_nodeFunction;
	
	/**
	 * A set of points this data point depends on
	 */
	protected final List m_parents;
	
	/**
	 * A set of points that depend on this data point
	 */
	protected final List m_children;
	
	/**
	 * Creates a new provenance node
	 * @param node The ID of the data point
	 */
	public ProvenanceNode(NodeFunction node)
	{
		super();
		m_nodeFunction = node;
		m_parents = new ArrayList();
		m_children = new ArrayList();
	}
	
	/**
	 * Adds a parent to this node. Note that this does not add the
	 * current node as a child in {@code p}.
	 * @param p The parent
	 */
	public void addParent(ProvenanceNode p)
	{
		m_parents.add(p);
	}
	
	/**
	 * Adds a parent to this node. Note that this does not add the
	 * current node as a parent in {@code p}.
	 * @param p The parent
	 */
	public void addChild(ProvenanceNode p)
	{
		m_children.add(p);
	}
	
	/**
	 * Replaces a parent node by another
	 * @param position The position where to perform the replacement. The
	 * operation is ignored is this value is out of bounds.
	 * @param p The parent
	 */
	public void replaceParent(int position, ProvenanceNode p)
	{
		
		m_parents.set(position, p);
	}
	
	public NodeFunction getNodeFunction()
	{
		return m_nodeFunction;
	}
	
	public List getParents()
	{
		return m_parents;
	}
	
	public List getChildren()
	{
		return m_children;
	}
	
	@Override
	public String toString()
	{
		if (m_nodeFunction != null)
		{
			return m_nodeFunction.toString();
		}
		return "?";
	}

	public void addParents(Collection parents)
	{
		m_parents.addAll(parents);
		
	}
}