KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cayenne > graph > GraphManager


1 /*****************************************************************
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  ****************************************************************/

19
20 package org.apache.cayenne.graph;
21
22 import java.util.Collection JavaDoc;
23
24 /**
25  * Represents a generic "managed" graph with nodes mapped by their ids. Inherited
26  * GraphChangeHandler methods are intended as callbacks for graph node objects to notify
27  * graph of their changes.
28  *
29  * @since 1.2
30  * @author Andrus Adamchik
31  */

32 public interface GraphManager extends GraphChangeHandler {
33
34     /**
35      * Returns a graph node given an id.
36      */

37     Object JavaDoc getNode(Object JavaDoc nodeId);
38
39     /**
40      * "Registers" a graph node, usually striong the node in some internal map using its
41      * id as a key.
42      */

43     void registerNode(Object JavaDoc nodeId, Object JavaDoc nodeObject);
44
45     /**
46      * "Unregisters" a graph node, forgetting any information associated with nodeId.
47      */

48     Object JavaDoc unregisterNode(Object JavaDoc nodeId);
49
50     /**
51      * Returns all graph nodes regsitered with GraphManager.
52      */

53     Collection JavaDoc registeredNodes();
54 }
55
Popular Tags