View Javadoc

1   /*
2    * $Id: IgnoreFieldPopulator.java,v 1.3 2004/04/04 18:26:59 eelco12 Exp $
3    * $Revision: 1.3 $
4    * $Date: 2004/04/04 18:26:59 $
5    *
6    * ====================================================================
7    * Copyright (c) 2003, Open Edge B.V.
8    * All rights reserved.
9    * Redistribution and use in source and binary forms, with or without 
10   * modification, are permitted provided that the following conditions are met:
11   * Redistributions of source code must retain the above copyright notice, 
12   * this list of conditions and the following disclaimer. Redistributions 
13   * in binary form must reproduce the above copyright notice, this list of 
14   * conditions and the following disclaimer in the documentation and/or other 
15   * materials provided with the distribution. Neither the name of OpenEdge B.V. 
16   * nor the names of its contributors may be used to endorse or promote products 
17   * derived from this software without specific prior written permission.
18   * 
19   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
20   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
21   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
22   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
23   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
24   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
25   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
26   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
27   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
28   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 
29   * THE POSSIBILITY OF SUCH DAMAGE.
30   */
31  package nl.openedge.baritus.population;
32  
33  import nl.openedge.baritus.FormBeanContext;
34  
35  import org.infohazard.maverick.flow.ControllerContext;
36  
37  /***
38   * Ignores the population of fields.
39   * Register IgnoreFieldPopulators if you want to ignore the population of certain properties,
40   * for instance id's of persistent objects.
41   * @author Eelco Hillenius
42   */
43  public final class IgnoreFieldPopulator implements FieldPopulator
44  {
45  
46  	private boolean fail;
47  	
48  	/***
49  	 * construct.
50  	 * fail is false
51  	 */
52  	public IgnoreFieldPopulator()
53  	{
54  		setFail(false);
55  	}
56  	
57  	/***
58  	 * construct with parameter fail
59  	 * @param fail If fail == true, setProperty will allways return false,
60  	 *  and thus the population process is flagged as failed, if fail == false,
61  	 * 	setProperty will allways return true, and thus has no effect on the total population.
62  	 */
63  	public IgnoreFieldPopulator(boolean fail)
64  	{
65  		setFail(fail);
66  	}
67  
68  	/***
69  	 * Does nothing at all.
70  	 * Register IgnoreFieldPopulators if you want to ignore the population of certain properties,
71   	 * for instance id's of persistent objects.
72  	 */
73  	public boolean setProperty(
74  		ControllerContext cctx,
75  		FormBeanContext form,
76  		String name,
77  		Object value)
78  		throws Exception
79  	{
80  		return (!fail);
81  	}
82  
83  	/***
84  	 * get the value of property fail
85  	 * @return boolean value of property fail. By default fail == false, which means that this method
86  	 * 		allways returns true. If you set fail to true, this method will allways return false,
87  	 * 		and thus the population process is flagged as failed.
88  	 */
89  	public boolean isFail()
90  	{
91  		return fail;
92  	}
93  
94  	/***
95  	 * set the value of property fail
96  	 * @param b value of property fail. By default fail == false, which means that this method
97  	 * 		allways returns true. If you set fail to true, this method will allways return false,
98  	 * 		and thus the population process is flagged as failed.
99  	 */
100 	public void setFail(boolean b)
101 	{
102 		fail = b;
103 	}
104 
105 }