View Javadoc

1   package org.molwind.graph;
2   import edu.uci.ics.jung.graph.util.Pair;
3   
4   /*
5    * This file is part of Molwind.
6    *
7    * Molwind is free software: you can redistribute it and/or modify
8    * it under the terms of the GNU General Public License as published by
9    * the Free Software Foundation, either version 3 of the License, or
10   * (at your option) any later version.
11   *
12   * Molwind is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15   * GNU General Public License for more details.
16   *
17   * You should have received a copy of the GNU General Public License
18   * along with Molwind. If not, see <http://www.gnu.org/licenses/>.
19   */
20  
21  import org.molwind.model.Relationship;
22  
23  /**
24   * EntityEdge represents relationships of entities.
25   *
26   * @author <a href="mailto:oliver.karch@molwind.org">Oliver Karch</a>
27   * @version 1.0
28   */
29  public interface EntityEdge {
30  
31      /**
32       * Get the Relationship value.
33       *
34       * @return
35       *      the Relationship value.
36       */
37      Relationship getRelationship();
38  
39      /**
40       * Set the Relationship value.
41       *
42       * @param newRelation
43       *      the new Relationship value
44       */
45      void setRelationship(Relationship newRelation);
46    
47      
48      /**
49       * Get the Weight value.
50       * @return the Weight value.
51       */
52      public int getEdgeWeight() ;
53      
54    
55    /**
56       * Returns the vertices
57       *
58       * @return
59       *     Pair of Vertices
60       */
61      
62      public Pair<EntityVertex> getVerticePair();
63  
64      /**
65       * Get the V1 value.
66       * @return the V1 value.
67       */
68      public EntityVertex getV1() ;
69  
70  
71      
72      /**
73       * Get the V2 value.
74       * @return the V2 value.
75       */
76      public EntityVertex getV2() ;
77  
78     
79      
80  }