org.opengis.geometry.complex.ComplexFactory Maven / Gradle / Ivy

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2003-2005, Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.geometry.complex;

import java.util.List;
import org.opengis.geometry.primitive.OrientableCurve;
import org.opengis.geometry.primitive.OrientableSurface;
import org.opengis.geometry.primitive.Point;

/**
 * A factory of {@linkplain Complex complex} geometric objects. All complexes created through this
 * interface will use the {@linkplain #getCoordinateReferenceSystem factory's coordinate reference
 * system}. Creating complexes in a different CRS may requires a different instance of {@code
 * ComplexFactory}.
 *
 * @version ISO 19107
 * @author Sanjay Jena
 * @author Prof. Dr. Jackson Roehrig
 * @since GeoAPI 2.1
 * @todo Need to check if ISO 19107 defines constructors for complexes.
 */
public interface ComplexFactory {
    /**
     * Creates a {@linkplain CompositePoint composite point} from a {@linkplain Point point}. The
     * constructed composite point is backed by the given point. That is, the composite point holds
     * a reference to the point instance.
     *
     * @param generator a point.
     * @return a composite point.
     */
    CompositePoint createCompositePoint(Point generator);

    /**
     * Creates a {@linkplain CompositeCurve composite curve} from a list of {@linkplain
     * OrientableCurve orientable curves}. The constructed composite curve is backed by the given
     * curves. That is, the composite curve holds references to the curve instances.
     *
     * @param generator a list of orientable curves.
     * @return a composite curve.
     */
    CompositeCurve createCompositeCurve(List generator);

    /**
     * Creates a {@linkplain CompositeSurface composite surface} from a list of {@linkplain
     * OrientableSurface orientable surfaces}. The constructed composite surface is backed by the
     * given surface. That is, the composite surface holds references to the surface instances.
     *
     * @param generator a list of orientable surface.
     * @return a composite surface.
     */
    CompositeSurface createCompositeSurface(List generator);
}