org.geolatte.common.expressions.Expression Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geolatte-common Show documentation

This GeoLatte-common library contains the transformer framework and other common classes used by other GeoLatte modules.

There is a newer version: 0.8

Show newest version

/*
 * This file is part of the GeoLatte project.
 *
 *     GeoLatte 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, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     GeoLatte 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.
 *
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with GeoLatte.  If not, see .
 *
 * Copyright (C) 2010 - 2010 and Ownership of code is shared by:
 * Qmino bvba - Romeinsestraat 18 - 3001 Heverlee  (http://www.qmino.com)
 * Geovise bvba - Generaal Eisenhowerlei 9 - 2140 Antwerpen (http://www.geovise.com)
 */

package org.geolatte.common.expressions;

/**
 * 
 * Base Expression interface. Every expression must implement this interface.
 * 
 * 
 * Creation-Date: 9-apr-2010

 * Creation-Time:  11:48:54

 * 
 *
 * @author Peter Rigole
 * @author Bert Vanhooff
 * @author Qmino bvba
 * @param  The type the expression evaluates to.
 * @since SDK1.5
 */
public interface Expression {

    /**
     * Evaluates the given object against this expression.
     *
     *
     * @param o The object to evaluate.
     * @return True if the given object matches this expression, false otherwise.
     */
    T evaluate(Object o);

    /**
     * Implements the visitor pattern as a switch on the type of this expression.
     * For example, on an Expression, this method calls the {@link BasicTypeSwitch#caseInteger(Expression)} method on the given switcher.
     *
     * @param switcher The class on which a 'case' corresponding to type of this expression will be called.
     */
    void switchOn(BasicTypeSwitch switcher);
}