org.deegree.model.geometry
Interface GM_MultiSurface

All Superinterfaces:
GM_Aggregate, GM_MultiPrimitive, GM_Object
All Known Implementing Classes:
GM_MultiSurface_Impl

public interface GM_MultiSurface
extends GM_MultiPrimitive

This Interface defines the Aggregation of GM_Surfaces. The implementing class should capsulate a java.util.Vector or a comarative data structure.

-----------------------------------------------------

Version:
$Revision: 1.2 $ $Date: 2004/01/26 08:15:37 $

Author:
Andreas Poth

Method Summary
 void addSurface(GM_Surface gms)
          adds an GM_Surface to the aggregation
 GM_Surface[] getAllSurfaces()
          returns all GM_Surfaces as array
 GM_Surface getSurfaceAt(int index)
          returns the GM_Surface at the submitted index.
 void insertSurfaceAt(GM_Surface gms, int index)
          inserts a GM_Surface in the aggregation. all elements with an index equal or larger index will be moved. if index is larger then getSize() - 1 or smaller then 0 or gms equals null an exception will be thrown.
 GM_Surface removeSurface(GM_Surface gms)
          removes the submitted GM_Surface from the aggregation
 GM_Surface removeSurfaceAt(int index)
          removes the GM_Surface at the submitted index from the aggregation.
 void setSurfaceAt(GM_Surface gms, int index)
          sets the submitted GM_Surface at the submitted index. the element at the position index will be removed. if index is larger then getSize() - 1 or smaller then 0 or gms equals null an exception will be thrown.
 
Methods inherited from interface org.deegree.model.geometry.GM_MultiPrimitive
getAllPrimitives, getPrimitiveAt
 
Methods inherited from interface org.deegree.model.geometry.GM_Aggregate
add, getAll, getIterator, getObjectAt, getSize, insertObjectAt, isMember, merge, removeAll, removeObject, removeObjectAt, setObjectAt
 
Methods inherited from interface org.deegree.model.geometry.GM_Object
contains, contains, difference, distance, getBoundary, getBuffer, getCentroid, getConvexHull, getCoordinateDimension, getCoordinateSystem, getDimension, getEnvelope, intersection, intersects, isEmpty, isWithinDistance, translate, union
 

Method Detail

addSurface

public void addSurface(GM_Surface gms)
adds an GM_Surface to the aggregation


insertSurfaceAt

public void insertSurfaceAt(GM_Surface gms,
                            int index)
                     throws GM_Exception
inserts a GM_Surface in the aggregation. all elements with an index equal or larger index will be moved. if index is larger then getSize() - 1 or smaller then 0 or gms equals null an exception will be thrown.

Parameters:
gms - GM_Surface to insert.
index - position where to insert the new GM_Surface
Throws:
GM_Exception

setSurfaceAt

public void setSurfaceAt(GM_Surface gms,
                         int index)
                  throws GM_Exception
sets the submitted GM_Surface at the submitted index. the element at the position index will be removed. if index is larger then getSize() - 1 or smaller then 0 or gms equals null an exception will be thrown.

Parameters:
gms - GM_Surface to set.
index - position where to set the new GM_Surface
Throws:
GM_Exception

removeSurface

public GM_Surface removeSurface(GM_Surface gms)
removes the submitted GM_Surface from the aggregation

Returns:
the removed GM_Surface

removeSurfaceAt

public GM_Surface removeSurfaceAt(int index)
                           throws GM_Exception
removes the GM_Surface at the submitted index from the aggregation. if index is larger then getSize() - 1 or smaller then 0 an exception will be thrown.

Returns:
the removed GM_Surface
Throws:
GM_Exception

getSurfaceAt

public GM_Surface getSurfaceAt(int index)
returns the GM_Surface at the submitted index.


getAllSurfaces

public GM_Surface[] getAllSurfaces()
returns all GM_Surfaces as array