VertexNameProvider


1   /* ==========================================
2    * JGraphT : a free Java graph-theory library
3    * ==========================================
4    *
5    * Project Info:  http://jgrapht.sourceforge.net/
6    * Project Creator:  Barak Naveh (http://sourceforge.net/users/barak_naveh)
7    *
8    * (C) Copyright 2003-2006, by Barak Naveh and Contributors.
9    *
10   * This library is free software; you can redistribute it and/or modify it
11   * under the terms of the GNU Lesser General Public License as published by
12   * the Free Software Foundation; either version 2.1 of the License, or
13   * (at your option) any later version.
14   *
15   * This library is distributed in the hope that it will be useful, but
16   * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
17   * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
18   * License for more details.
19   *
20   * You should have received a copy of the GNU Lesser General Public License
21   * along with this library; if not, write to the Free Software Foundation,
22   * Inc.,
23   * 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
24   */
25  /* ------------------
26   * VertexNameProvider.java
27   * ------------------
28   * (C) Copyright 2005-2006, by Avner Linder and Contributors.
29   *
30   * Original Author:  Avner Linder
31   *
32   * $Id: VertexNameProvider.java 504 2006-07-03 02:37:26Z perfecthash $
33   *
34   * Changes
35   * -------
36   * 27-May-2004 : Initial Version (AL);
37   * 13-Dec-2005 : Split out of VisioExporter (CF);
38   *
39   */
40  package org.jgrapht.ext;
41  
42  /**
43   * Assigns a display name for each of the graph vertices.
44   */
45  public interface VertexNameProvider<V>
46  {
47  
48      //~ Methods ---------------------------------------------------------------
49  
50      /**
51       * Returns a unique name for a vertex. This is useful when exporting a a
52       * graph, as it ensures that all vertices are assigned simple, consistant
53       * names.
54       *
55       * @param vertex the vertex to be named
56       *
57       * @return the name of the vertex
58       */
59      public String   getVertexName(V vertex);
60  }
61
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags