001/* ======================================================
002 * JFreeChart : a chart library for the Java(tm) platform
003 * ======================================================
004 *
005 * (C) Copyright 2000-present, by David Gilbert and Contributors.
006 *
007 * Project Info:  https://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
022 * USA.
023 *
024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * ---------------
028 * NodeEntity.java
029 * ---------------
030 * (C) Copyright 2021-present, by David Gilbert and Contributors.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.entity;
038
039import java.awt.Shape;
040import org.jfree.chart.plot.flow.FlowPlot;
041import org.jfree.chart.util.Args;
042import org.jfree.data.flow.NodeKey;
043
044/**
045 * A chart entity representing a node in a {@link FlowPlot}.
046 * 
047 * @since 1.5.3
048 */
049public class NodeEntity extends ChartEntity {
050
051    /** The node key. */
052    private NodeKey key;
053    
054    /**
055     * Creates a new instance.
056     * 
057     * @param key  the node key ({@code null} not permitted).
058     * @param area  the outline of the entity ({@code null} not permitted).
059     * @param toolTipText  the tool tip text.
060     */
061    public NodeEntity(NodeKey key, Shape area, String toolTipText) {
062        super(area, toolTipText);
063        Args.nullNotPermitted(key, "key");
064        this.key = key;
065    }
066    
067    /**
068     * Creates a new instance.
069     * 
070     * @param area  the outline of the entity ({@code null} not permitted).
071     * @param toolTipText  the tool tip text.
072     * @param urlText  the URL text.
073     */
074    public NodeEntity(Shape area, String toolTipText, String urlText) {
075        super(area, toolTipText, urlText);
076    }
077
078    /**
079     * Returns the node key.
080     * 
081     * @return The node key (never {@code null}). 
082     */
083    public NodeKey getKey() {
084        return this.key;
085    }
086    
087    /**
088     * Returns a string representation of this instance, primarily for 
089     * debugging purposes.
090     * 
091     * @return A string. 
092     */
093    @Override
094    public String toString() {
095        return "[NodeEntity: " + this.key + "]";
096    }
097
098}