001/* A model for a Ptolemy II object as a node in a diva graph.
002
003 Copyright (c) 1999-2013 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026 */
027package ptolemy.vergil.basic;
028
029import diva.graph.modular.NodeModel;
030
031///////////////////////////////////////////////////////////////////
032//// NamedObjNodeModel
033
034/**
035 A model for a Ptolemy II object as a node in a diva graph.
036
037 @author Steve Neuendorffer and Edward A. Lee
038 @version $Id$
039 @since Ptolemy II 2.0
040 @Pt.ProposedRating Red (yourname)
041 @Pt.AcceptedRating Red (reviewmoderator)
042 */
043public abstract class NamedObjNodeModel implements NodeModel {
044    ///////////////////////////////////////////////////////////////////
045    ////                         public methods                    ////
046
047    /** Return a MoML String that will delete the given node from the
048     *  Ptolemy model.
049     *  @param node The given node to be deleted.
050     *  @return A valid MoML string.
051     */
052    public abstract String getDeleteNodeMoML(Object node);
053
054    /** Remove the specified node from the model.
055     *  @param eventSource The event source.
056     *  @param node The given node to be deleted.
057     */
058    public abstract void removeNode(Object eventSource, Object node);
059}