View Javadoc

1   package org.molwind.view;
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 java.util.Iterator;
21  
22  import org.molwind.model.LayeredPosition;
23  import org.molwind.model.RelationshipResolver;
24  
25  /**
26   * TopologyManager determines visible entities.
27   *
28   * @author <a href="mailto:oliver.karch@molwind.org">Oliver Karch</a>
29   * @version 1.0
30   */
31  
32  public interface TopologyManager {
33  
34      /**
35       * Determines the visible entities for the given position.
36       *
37       * @param position
38       *      the position (longitude/latitude/level)
39       * @return
40       *      an (possibly empty) iterator of entities
41       */
42      Iterator getVisibleEntities(LayeredPosition position);
43  
44      /**
45       * Set the EntityIterator value.
46       *
47       * @param newEntityIterator
48       *      the new EntityIterator value
49       */
50      public void setEntityIterator( Iterator newEntityIterator );
51  
52      /**
53       * Set the RelationshipResolver value.
54       *
55       * @param newRelationshipResolver
56       *      the new RelationshipResolver value
57       */
58      public void setRelationshipResolver( RelationshipResolver newRelationshipResolver);
59  
60  }