GraphChangeHandler


1   /* ====================================================================
2    * 
3    * The ObjectStyle Group Software License, version 1.1
4    * ObjectStyle Group - http://objectstyle.org/
5    * 
6    * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7    * of the software. All rights reserved.
8    * 
9    * Redistribution and use in source and binary forms, with or without
10   * modification, are permitted provided that the following conditions
11   * are met:
12   * 
13   * 1. Redistributions of source code must retain the above copyright
14   *    notice, this list of conditions and the following disclaimer.
15   * 
16   * 2. Redistributions in binary form must reproduce the above copyright
17   *    notice, this list of conditions and the following disclaimer in
18   *    the documentation and/or other materials provided with the
19   *    distribution.
20   * 
21   * 3. The end-user documentation included with the redistribution, if any,
22   *    must include the following acknowlegement:
23   *    "This product includes software developed by independent contributors
24   *    and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25   *    Alternately, this acknowlegement may appear in the software itself,
26   *    if and wherever such third-party acknowlegements normally appear.
27   * 
28   * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29   *    or promote products derived from this software without prior written
30   *    permission. For written permission, email
31   *    "andrus at objectstyle dot org".
32   * 
33   * 5. Products derived from this software may not be called "ObjectStyle"
34   *    or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35   *    names without prior written permission.
36   * 
37   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40   * DISCLAIMED.  IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48   * SUCH DAMAGE.
49   * ====================================================================
50   * 
51   * This software consists of voluntary contributions made by many
52   * individuals and hosted on ObjectStyle Group web site.  For more
53   * information on the ObjectStyle Group, please see
54   * <http://objectstyle.org/>.
55   */
56  package org.objectstyle.cayenne.graph;
57  
58  
59  /**
60   * Defines callback API that can be used by object graph nodes to notify of their state
61   * changes. Graph nodes can be any objects as long as each node supports a notion of a
62   * unique id within the graph and each directional arc has a unique identifier within its
63   * source node.
64   * <p>
65   * GraphChangeHandlers can be either "injected" directly into the graph nodes or wrapped in
66   * some event mechanism to collect graph changes.
67   * </p>
68   * 
69   * @since 1.2
70   * @author Andrus Adamchik
71   */
72  public interface GraphChangeHandler {
73  
74      /**
75       * Notifies implementing object that a node was assigned a new id.
76       */
77      void nodeIdChanged(Object   nodeId, Object   newId);
78  
79      /**
80       * Notifies implementing object that a new node was created in the graph.
81       */
82      void nodeCreated(Object   nodeId);
83  
84      /**
85       * Notifies implementing object that a node was removed from the graph.
86       */
87      void nodeRemoved(Object   nodeId);
88  
89      /**
90       * Notifies implementing object that a node's property was modified.
91       */
92      void nodePropertyChanged(
93              Object   nodeId,
94              String   property,
95              Object   oldValue,
96              Object   newValue);
97  
98      /**
99       * Notifies implementing object that a new arc was created between two nodes.
100      */
101     void arcCreated(Object   nodeId, Object   targetNodeId, Object   arcId);
102 
103     /**
104      * Notifies implementing object that an arc between two nodes was deleted.
105      */
106     void arcDeleted(Object   nodeId, Object   targetNodeId, Object   arcId);
107 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags