org.geolatte.common.transformer.TransformerSource 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.transformer;

/**
 * Represents a source of transformer data.
 * @param  The type of provided data.
 *
 * 
 * Creation-Date: 19-Mar-2010

 * Creation-Time:  14:10:07

 * 
 *
 * @author Bert Vanhooff
 * @author Qmino bvba
 * @since SDK1.5
 */
public abstract class TransformerSource {

    /**
     * On each "next()", the transformer pulls an element from the currentInput and pulls it through the transformation.
     * Mind that the remove() method on the iterator has no effect.
     *
     * This method should never be called directly by clients when the TransformerSource is intended to be used in a transformer chain.
     *
     *
     * @return An Iterable which contains the result of the transformation (constructed on the fly) or null if no input has been set.
     */
    protected abstract Iterable output();
}