/* Annotation.java
 * =========================================================================
 * This file is part of the GrInvIn project - http://www.grinvin.org
 * 
 * Copyright (C) 2005-2008 Universiteit Gent
 * 
 * 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 2 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.
 * 
 * A copy of the GNU General Public License can be found in the file
 * LICENSE.txt provided with the source distribution of this program (see
 * the META-INF directory in the source jar). This license can also be
 * found on the GNU website at http://www.gnu.org/licenses/gpl.html.
 * 
 * If you did not receive a copy of the GNU General Public License along
 * with this program, contact the lead developer, or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

package org.grinvin.graphs;

/**
 *
 */
public interface Annotation extends AnnotationView {
    
    /**
     * Sets the annotation for the given {@link Vertex}.
     * @throws IllegalArgumentException when the parameter is not a vertex
     * of the peer graph.
     */
    public void setAnnotation(Vertex vertex, Object annotation);
    
    /**
     * Sets the annotation for the given {@link Edge}.
     * @throws IllegalArgumentException when the parameter is not an edge
     * of the peer graph.
     */
    public void setAnnotation(Edge edge, Object annotation);
    
    /**
     * Make this annotation a copy of the given view using the peer of the original.
     */
    public void copy(AnnotationView original);

    /**
     * Make this annotation a copy of the given view using the given peer. This peer
     * is supposed to be a copy of the peer in the sense of method
     * {@link Graph#copy}.
     */
    public void copy (AnnotationView original, GraphView newPeer);

}