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

Go to download
/*
 * H2GIS is a library that brings spatial support to the H2 Database Engine
 * http://www.h2database.com. H2GIS is developed by CNRS
 * http://www.cnrs.fr/.
 *
 * This code is part of the H2GIS project. H2GIS is free software;
 * you can redistribute it and/or modify it under the terms of the GNU
 * Lesser General Public License as published by the Free Software Foundation;
 * version 3.0 of the License.
 *
 * 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 Lesser General Public License
 * for more details .
 *
 *
 * For more information, please consult: http://www.h2gis.org/
 * or contact directly: info_at_h2gis.org
 */

package org.h2gis.api;

/**
 * Main interface for SQL Functions services.
 *
 * @author Nicolas Fortin
 * @author Sylvain PALOMINOS (UBS 2018)
 */
public interface Function {

    /**
     * SQL function name, take class name by default
     */
    String PROP_NAME = "name";

    /**
     * SQL Function description
     */
    String PROP_REMARKS = "remarks";

    /**
     * Return the value of optional function property with the specified name.
     *
     * @param propertyName Name of the property which value is returned.
     * @return The value or null if the property doesn't not exists.
     */
    Object getProperty(String propertyName);
}