org.h2gis.api

Class AbstractFunction

java.lang.Object

org.h2gis.api.AbstractFunction

All Implemented Interfaces:

Function

Direct Known Subclasses:

DeterministicScalarFunction

public abstract class AbstractFunction
extends Object
implements Function

Abstract implementation of the Function interface which is able to handle properties into a map.

Author:

Nicolas Fortin, Sylvain PALOMINOS (UBS 2018)

Field Summary

Fields inherited from interface org.h2gis.api.Function

PROP_NAME, PROP_REMARKS

Constructor Summary

Constructors

Constructor and Description
AbstractFunction()

Method Summary

Modifier and Type	Method and Description
void	addProperty(String propertyName, Object value) Add a property to the map.
Object	getProperty(String propertyName) Return the value of optional function property with the specified name
boolean	removeProperty(String propertyName) Remove a property from the map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractFunction

public AbstractFunction()

Method Detail

getProperty

public Object getProperty(String propertyName)

Description copied from interface: Function

Return the value of optional function property with the specified name

Specified by:

getProperty in interface Function

Parameters:

propertyName - Name of the property which value is returned

Returns:

The value or null if the property doesn't not exists

addProperty

public void addProperty(String propertyName,
                        Object value)

Add a property to the map.

Parameters:

propertyName - Property identifier

value - New property value

removeProperty

public boolean removeProperty(String propertyName)

Remove a property from the map.

Parameters:

propertyName - Property identifier

Returns:

True if the property is removed