Mapping


1   /*
2    * This file belongs to the XQuark distribution.
3    * Copyright (C) 2003 Universite de Versailles Saint-Quentin.
4    * 
5    * This program is free software; you can redistribute it and/or
6    * modify it under the terms of the GNU Lesser General Public
7    * License as published by the Free Software Foundation; either
8    * version 2.1 of the License, or (at your option) any later version.
9    * 
10   * This program is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13   * Lesser General Public License for more details.
14   * 
15   * You should have received a copy of the GNU Lesser General Public
16   * License along with this program; if not, write to the Free Software
17   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307.
18   * You can also get it at http://www.gnu.org/licenses/lgpl.html
19   * 
20   * For more information on this software, see http://www.xquark.org.
21   */
22  
23  package org.xquark.mapper.mapping;
24  
25  import org.xquark.schema.SchemaComponent;
26  
27  /**
28   * Base interface for classes providing information on XML data mapping on
29   * standard relational database management system.
30   *
31  */
32  public interface Mapping extends MappingConstants
33  {
34  
35      /**
36       * Accessor to the W3C XML schema component associated to the mapping.
37       * @return the component (element or attribute declaration or type) on
38       * which the mapping is defined
39       */
40      public SchemaComponent getSchemaComponent();
41      
42      /**
43       * Returns the arbitrary table index allocated during mapping file loading.
44       * @return an integer index beginning with 0.
45       */
46      public int getTableIndex();
47      
48      /**
49       * Accessor to the name of the user table on which the mapping is defined.
50       * @return the user table name
51       */
52      public String   getTableName();
53  }
54
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags