org.h2gis.h2spatialapi.Function Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of h2spatial-api Show documentation

H2 Spatial API define extension point of h2 spatial

The newest version!

/**
 * H2GIS is a library that brings spatial support to the H2 Database Engine
 * .
 *
 * H2GIS is distributed under GPL 3 license. It is produced by CNRS
 * .
 *
 * H2GIS is free software: you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 *
 * H2GIS is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * H2GIS. If not, see .
 *
 * For more information, please consult: 
 * or contact directly: info_at_h2gis.org
 */
package org.h2gis.h2spatialapi;

/**
 * Main interface for SQL Functions services.
 * @author Nicolas Fortin
 */
public interface Function {
    /** SQL function name, take class name by default */
    String PROP_NAME = "name";
    /** SQL Function description */
    String PROP_REMARKS = "remarks";

    /**
     * Optional function properties
     * @param propertyName
     * @return The value or null if not exists
     */
    Object getProperty(String propertyName);
}