MappingDomtreeBuilder


1   /**
2    * JORM: an implementation of a generic mapping system for persistent Java
3    *       objects. Two mapping are supported: to RDBMS and to binary files.
4    * Copyright (C) 2001-2003 France Telecom R&D - INRIA
5    *
6    * This library is free software; you can redistribute it and/or
7    * modify it under the terms of the GNU Lesser General Public
8    * License as published by the Free Software Foundation; either
9    * version 2 of the License, or (at your option) any later version.
10   *
11   * This library is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   * Lesser General Public License for more details.
15   *
16   * You should have received a copy of the GNU Lesser General Public
17   * License along with this library; if not, write to the Free Software
18   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19   *
20   * Contact: jorm-team@objectweb.org
21   *
22   */
23  
24  package org.objectweb.jorm.mi2xml.api;
25  
26  import org.objectweb.jorm.metainfo.api.Class;
27  import org.objectweb.jorm.metainfo.api.ClassMapping;
28  import org.objectweb.jorm.metainfo.api.GenClassMapping;
29  import org.objectweb.jorm.api.PException;
30  import org.w3c.dom.Document  ;
31  import org.w3c.dom.Element  ;
32  
33  import java.util.Map  ;
34  
35  /**
36   * MappingDomtreeBuilder builds a DOMTree representation of a class mapping specification
37   * or a generic class mapping specification.
38   */
39  public interface MappingDomtreeBuilder {
40  
41      /**
42       * Assigns the current Class object to the MappingDomtreeBuilder object.
43       *
44       * @param currentClass  the Jorm meta-object associated to the parsed class.
45       */
46      void setCurrentClass(Class   currentClass);
47  
48      /**
49       * Assigns the current Class object to the MappingDomtreeBuilder object.
50       *
51       * @param metaobject2idvalue    an HashTable that associates a MetaObject with an id value.
52       */
53      void setmetaobject2idvalue(Map   metaobject2idvalue);
54  
55      /**
56       * Adds a class mapping element to a mapping element.
57       * @param   document        an org.w3c.dom.Document object,
58       *          mappingElement  a mapping element,
59       *          classMapping    a <tt>ClassMapping</tt> object.
60       */
61      abstract void processClassMapping(Document   document, Element   mappingElement,
62                                        ClassMapping classMapping) throws PException;
63  
64      /**
65       * Adds a generic class mapping element to a mapping element.
66       * @param   document            an org.w3c.dom.Document object,
67       *          mappingElement      a mapping element,
68       *          genClassMapping     a <tt>GenClassMapping</tt> object.
69       */
70      abstract void processGenClassMapping(Document   document, Element   mappingElement,
71                                           GenClassMapping genClassMapping) throws PException;
72  }
73
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags