View Javadoc

1   /**
2    * This file Copyright (c) 2003-2014 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.voters;
35  
36  import org.slf4j.Logger;
37  import org.slf4j.LoggerFactory;
38  
39  
40  /**
41   * Used to create boolean voters which can't return integer values. You can
42   * stear the returned values by setting the trueValue and falseValue. To inverse
43   * the result of the boolVote method use the not property.
44   *
45   * @author philipp
46   * @version $Id$
47   */
48  public abstract class AbstractBoolVoter extends BaseVoterImpl {
49  
50      /**
51       * Logger.
52       */
53      private static Logger log = LoggerFactory.getLogger(AbstractBoolVoter.class);
54  
55      private int trueValue = 1;
56  
57      private int falseValue = 0;
58  
59      private boolean not;
60  
61      @Override
62      public int vote(Object value) {
63          boolean vote = boolVote(value);
64          if(not){
65              vote = !vote;
66          }
67          return vote ? trueValue : falseValue;
68      }
69  
70      public int getFalseValue() {
71          return this.falseValue;
72      }
73  
74      public void setFalseValue(int negativeVoteValue) {
75          this.falseValue = negativeVoteValue;
76      }
77  
78      public int getTrueValue() {
79          return this.trueValue;
80      }
81  
82      public void setTrueValue(int positiveVoteValue) {
83          this.trueValue = positiveVoteValue;
84      }
85  
86      abstract protected boolean boolVote(Object value);
87  
88  
89      public boolean isNot() {
90          return this.not;
91      }
92  
93      public void setNot(boolean not) {
94          this.not = not;
95      }
96  
97      @Override
98      public String toString() {
99          return super.toString() + ": " + (not?"not" : "");
100     }
101 
102     public int getLevel() {
103         return getTrueValue();
104     }
105 
106     public void setLevel(int level) {
107         setTrueValue(level);
108     }
109 }