View Javadoc

1   package org.molwind.graph;
2   
3   /*
4    * This file is part of Molwind.
5    *
6    * Molwind is free software: you can redistribute it and/or modify
7    * it under the terms of the GNU General Public License as published by
8    * the Free Software Foundation, either version 3 of the License, or
9    * (at your option) any later version.
10   *
11   * Molwind is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14   * GNU General Public License for more details.
15   *
16   * You should have received a copy of the GNU General Public License
17   * along with Molwind. If not, see <http://www.gnu.org/licenses/>.
18   */
19  
20  import org.molwind.model.WorldEntity;
21  import java.awt.geom.Point2D;
22  
23  /**
24   * EntityVertex represents a vertex of an EntityGraph.
25   *
26   * @author <a href="mailto:denis.knauer@merck.de">Denis Knauer</a>
27   * @version 1.0
28   */
29  public interface EntityVertex {
30  
31      /**
32       * Get the Id value.
33       *
34       * @return
35       *      the Id value
36       */
37      String getId();
38  
39      /**
40       * Set the Id value.
41       *
42       * @param newId
43       *      the new Id value
44       */
45      void setId(String newId);
46  
47      /**
48       * Get the Entity value.
49       *
50       * @return
51       *      the Entity value
52       */
53      WorldEntity getEntity();
54  
55      /**
56       * Set the Entity value.
57       *
58       * @param newEntity
59       *      the new Entity value
60       */
61      void setEntity(WorldEntity newEntity);
62    
63      /**
64       * Returns the position of the vertex
65       *
66       * @return
67       *     The layout position
68       *
69       */
70      public Point2D.Double getPosition();
71  
72       /**
73       * Sets the layout position
74       *
75       * @param
76       *      The posion to be set
77       *
78       */
79      public void setPosition(Point2D.Double position);
80      
81     
82     
83      
84  }