View Javadoc

1   /*
2    * This file is part of Domingo
3    * an Open Source Java-API to Lotus Notes/Domino
4    * hosted at http://domingo.sourceforge.net
5    *
6    * Copyright (c) 2003-2007 Beck et al. projects GmbH Munich, Germany (http://www.bea.de)
7    *
8    * This library is free software; you can redistribute it and/or
9    * modify it under the terms of the GNU Lesser General Public
10   * License as published by the Free Software Foundation; either
11   * version 2.1 of the License, or (at your option) any later version.
12   *
13   * This library is distributed in the hope that it will be useful,
14   * but WITHOUT ANY WARRANTY; without even the implied warranty of
15   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16   * Lesser General Public License for more details.
17   *
18   * You should have received a copy of the GNU Lesser General Public
19   * License along with this library; if not, write to the Free Software
20   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21   */
22  
23  package de.bea.domingo.map;
24  
25  import de.bea.domingo.DViewEntry;
26  
27  /***
28   * Interface for mappers from business objects to domingo and vice versa.
29   *
30   * @author <a href="mailto:kriede@users.sourceforge.net">Kurt Riede</a>
31   */
32  public interface DMapper extends Mapper {
33  
34      /***
35       * Returns the class of business objects handled by this mapper.
36       *
37       * @return class of handled business objects
38       */
39      Class getInstanceClass();
40  
41      /***
42       * Returns the class of digests of business objects handled by this mapper.
43       *
44       * @return digests class of handled business objects
45       */
46      Class getDigestClass();
47  
48      /***
49       * Creates a new instance of the business object.
50       *
51       * @return new instance
52       */
53      Object newInstance();
54  
55      /***
56       * Creates a new digest instance of the business object.
57       *
58       * @return new instance
59       */
60      Object newDigest();
61  
62      /***
63       * Maps a Domingo ViewEntry to a business object.
64       *
65       * @param viewEntry the domingo ViewEntry
66       * @param object the business object
67       * @throws MappingException if an error occurred during mapping
68       */
69      void map(DViewEntry viewEntry, Object object) throws MappingException;
70  }