Subversion Repositories hibernate-spatial

Rev

Rev 102 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
200 maesenka 1 
/*
2 
 * $Id: SpatialDialectProvider.java 200 2010-03-31 19:52:12Z maesenka $
2 maesenka 3 
 *
200 maesenka 4 
 * This file is part of Hibernate Spatial, an extension to the
5 
 * hibernate ORM solution for geographic data.
2 maesenka 6 
 *
200 maesenka 7 
 * Copyright © 2007-2010 Geovise BVBA
54 maesenka 8 
 *
20 maesenka 9 
 * This library is free software; you can redistribute it and/or
10 
 * modify it under the terms of the GNU Lesser General Public
11 
 * License as published by the Free Software Foundation; either
12 
 * version 2.1 of the License, or (at your option) any later version.
2 maesenka 13 
 *
20 maesenka 14 
 * This library is distributed in the hope that it will be useful,
2 maesenka 15 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 maesenka 16 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 
 * Lesser General Public License for more details.
2 maesenka 18 
 *
20 maesenka 19 
 * You should have received a copy of the GNU Lesser General Public
20 
 * License along with this library; if not, write to the Free Software
21 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22 
 *
54 maesenka 23 
 * For more information, visit: http://www.hibernatespatial.org/
2 maesenka 24 
 */
40 maesenka 25 
package org.hibernatespatial.spi;
2 maesenka 26 
 
40 maesenka 27 
import org.hibernatespatial.SpatialDialect;
2 maesenka 28 
 
29 
/**
30 
 * Interface that is implemented by a SpatialDialect Provider.
200 maesenka 31 
 * <p/>
11 maesenka 32 
 * A <class>SpatialDialectProvider</class> creates a SpatialDialect for one or
33 
 * more database systems. These databases are identified by a dialect string.
34 
 * Usually this is the fully qualified class name of a
2 maesenka 35 
 * <code>org.hibernate.dialect.Dialect</code> or <code>SpatialDialect</code>
36 
 * implementation
200 maesenka 37 
 *
38 
 * @author Karel Maesen, Geovise BVBA
2 maesenka 39 
 */
40 
 
41 
public interface SpatialDialectProvider {
42 
 
200 maesenka 43 
    /**
44 
     * create Spatial Dialect with the provided name.
45 
     *
46 
     * @param dialect Name of the dialect to create.
47 
     * @return a SpatialDialect
48 
     */
49 
    public SpatialDialect createSpatialDialect(String dialect);
2 maesenka 50 
 
200 maesenka 51 
    /**
52 
     * Returns the default dialect for this provider.
53 
     *
54 
     * @return The Default Dialect provided by the implementation.
55 
     *         <p/>
56 
     *         Implementations should never return null for this method.
57 
     */
58 
    public SpatialDialect getDefaultDialect();
2 maesenka 59 
 
200 maesenka 60 
    /**
61 
     * Returns the Dialect names
62 
     * <p/>
63 
     * This method must return the canonical class names of the Spatialdialect
64 
     * implementations that this provider provides.
65 
     *
66 
     * @return array of dialect names.
67 
     */
68 
    public String[] getSupportedDialects();
11 maesenka 69 
 
2 maesenka 70 
}