View Javadoc

1   /*
2    * $HeadURL: $
3    * $Date: $
4    * $Revision: $
5    * $Author: $
6    * 
7    * Copyright (c) 2006 MindTree Consulting Ltd. 
8    * 
9    * This file is part of Insight.
10   * 
11   * Insight is free software: you can redistribute it and/or modify it under the 
12   * terms of the GNU General Public License as published by the Free Software 
13   * Foundation, either version 3 of the License, or (at your option) any later 
14   * version.
15   * 
16   * Insight is distributed in the hope that it will be useful, but 
17   * WITHOUT ANY WARRANTY; without even the implied warranty of 
18   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General 
19   * Public License for more details.
20   * 
21   * You should have received a copy of the GNU General Public License along with 
22   * Insight.  If not, see <http://www.gnu.org/licenses/>.
23   */
24  package com.mindtree.techworks.insight.reporting.verifiers;
25  
26  /**
27   * Marks a <code>Verifier</code> to be deserializable by the default
28   * <code>VerifierDeserializer</code> implementation -
29   * <code>VerifierDeserializerImpl</code>. Additionaly provides a method used
30   * by the deserializer to populate the fields in the <code>Verifier</code>.
31   * 
32   * @see com.mindtree.techworks.insight.reporting.verifiers.VerifierDeserializerImpl
33   * 
34   * @author <a href="mailto:bindul_bhowmik@mindtree.com">Bindul Bhowmik</a>
35   * @version $Revision: 27 $ $Date: 2007-12-16 04:58:03 -0700 (Sun, 16 Dec 2007) $
36   * @since Insight 1.5
37   */
38  public interface DefaultImplDeserializable {
39  
40  	/**
41  	 * Populates the field passed in the reincarnated <code>Verifier</code>.
42  	 * If a field is of Array type or a <code>Collection</code>, then the
43  	 * method would be called multiple times with the same
44  	 * <code>fieldName</code> with different values of the
45  	 * <code>fieldValue</code>.
46  	 * 
47  	 * @param fieldName
48  	 *            The name of the field to be populated.
49  	 * @param fieldValue
50  	 *            The value of the field.
51  	 */
52  	public void deserializeField (String fieldName, String fieldValue);
53  
54  }