Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 *

 * This program 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 General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.fmap.geom.complex;

import java.util.Collection;

import java.util.Iterator;

import java.util.function.Predicate;

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.aggregate.Aggregate;

import org.gvsig.fmap.geom.exception.CreateGeometryException;

import org.gvsig.fmap.geom.primitive.Point;

import org.gvsig.fmap.geom.primitive.Primitive;

import org.gvsig.tools.util.IsEmpty;

/**

 * <p>

 * This interface is equivalent to the GM_Complex specified in 

 * <a href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=26012">ISO 19107</a>.

 * A Complex is a collection of geometrically disjoint, simple {@link Primitive}'s. 

 * If a {@link Primitive} (other than a {@link Point}) is in a particular Complex, 

 * then there exists a set of primitives of lower dimension in the same complex 

 * that form the boundary of this primitive.

 * </p>

 * @see <a href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=26012">ISO 19107</a>

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a>

 */

public interface Complex extends Geometry, Iterable<Geometry>, IsEmpty {

    /**

     * Returns the number of {@link Primitive}'s that composes this multi

     * geometry.

     *

     * @return the number of {@link Primitive}'s that composes this multi

     * geometry.

     */

    public int getPrimitivesNumber();

    /**

     * Returns one of the {@link Primitive}'s that is in a concrete position.

     *

     * @param i Geometry position.

     * @return A simple geometry.

     */

    public Primitive getPrimitiveAt(int i);

    /**

     * Adds a new primitive to the primitive

     *

     * @param primitive The primitive to add

     */

    public void addPrimitive(Primitive primitive);

    public void addPrimitives(Aggregate aggregate);

    public void addPrimitives(Geometry geometry);

    public void ensureCapacity(int capacity);

    public Collection<? extends Geometry> getElements();

    public Iterator<Geometry> iterator(Predicate<Geometry> filter);

    public Aggregate createAggregate(int type, Predicate<Geometry> filter) throws CreateGeometryException;

}