View Javadoc
1   /**
2    * This file Copyright (c) 2003-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.voting;
35  
36  import org.slf4j.Logger;
37  import org.slf4j.LoggerFactory;
38  
39  
40  /**
41   * The highest returned vote is taken (8 or -10, ..) and returned. The voting
42   * can return 0 if no voter has anything to say.
43   *
44   * @param <T> the type of object passed to vote
45   */
46  public class DefaultVoting<T> implements Voting<T> {
47  
48      Logger log = LoggerFactory.getLogger(DefaultVoting.class);
49  
50      @Override
51      public int vote(Voter<T>[] voters, T value) {
52          int highestVote = 0;
53          for (int i = 0; i < voters.length; i++) {
54              Voter voter = voters[i];
55              if (voter.isEnabled()) {
56                  int vote = voter.vote(value);
57                  log.debug("voter [{}] fired {}", voter, vote);
58  
59                  if (Math.abs(vote) > Math.abs(highestVote)) {
60                      highestVote = vote;
61                      log.debug("highest vote is now {}", Integer.toString(highestVote));
62                  }
63                  // same value but not same sign
64                  else if (vote == -highestVote) {
65                      highestVote = Math.abs(vote);
66                      log.debug("highest vote is now {}", Integer.toString(highestVote));
67                  }
68              }
69          }
70          return highestVote;
71      }
72  }