View Javadoc
1 /***
2 * GraphProcessor.java
3 *
4 * Project: Dependency Tool
5 *
6 * WHEN WHO WHAT
7 * 06.06.2003 pko initial public release
8 * 10.12.2002 pko creation
9 *
10 * Copyright 2003 ELCA Informatique SA
11 * Av. de la Harpe 22-24, 1000 Lausanne 13, Switzerland
12 * www.elca.ch
13 *
14 * This library is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU Lesser General Public License
16 * as published by the Free Software Foundation; either version 2.1 of
17 * the License, or (at your option) any later version.
18 *
19 * This library is distributed in the hope that it will be useful, but
20 * WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 * Lesser General Public License for more details.
23 *
24 * You should have received a copy of the GNU Lesser General Public
25 * License along with this library; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
27 * USA
28 */
29
30 package ch.elca.dependency.graph;
31
32 import att.grappa.Graph;
33
34 /***
35 * An interface for processing Graphs. Do not forget that changing a
36 * graph without first making a copy of it changes the contents of the
37 * original Graph. If you want to process the original graph, it's
38 * okay, but if you just want to return a graph in function of the
39 * original graph (and leave the original Graph unchanged), copy the
40 * Graph first. For copying a Graph you can use the class
41 * <code>ch.elca.dependency.graph.GraphUtils</code>.
42 *
43 * @see ch.elca.dependency.graph.GraphUtils#copy(Graph)
44 *
45 * @author Pawel Kowalski
46 * @version 1.0-beta
47 */
48 public interface GraphProcessor {
49
50 /***
51 * Process a graph. Copy the Graph passed as parameter if you
52 * don't want to change the original Graph but return a new Graph
53 * in function of the old instead.
54 *
55 * @see ch.elca.dependency.graph.GraphUtils#copy(Graph)
56 *
57 * @param graph a <code>Graph</code> value
58 * @return a <code>Graph</code> value
59 */
60 Graph process(Graph graph);
61
62 }
This page was automatically generated by Maven