001    //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/io/shpapi/shape_new/Shape.java $
002    /*----------------------------------------------------------------------------
003     This file is part of deegree, http://deegree.org/
004     Copyright (C) 2001-2009 by:
005       Department of Geography, University of Bonn
006     and
007       lat/lon GmbH
008    
009     This library is free software; you can redistribute it and/or modify it under
010     the terms of the GNU Lesser General Public License as published by the Free
011     Software Foundation; either version 2.1 of the License, or (at your option)
012     any later version.
013     This library is distributed in the hope that it will be useful, but WITHOUT
014     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
015     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
016     details.
017     You should have received a copy of the GNU Lesser General Public License
018     along with this library; if not, write to the Free Software Foundation, Inc.,
019     59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020    
021     Contact information:
022    
023     lat/lon GmbH
024     Aennchenstr. 19, 53177 Bonn
025     Germany
026     http://lat-lon.de/
027    
028     Department of Geography, University of Bonn
029     Prof. Dr. Klaus Greve
030     Postfach 1147, 53001 Bonn
031     Germany
032     http://www.geographie.uni-bonn.de/deegree/
033    
034     e-mail: info@deegree.org
035    ----------------------------------------------------------------------------*/
036    package org.deegree.io.shpapi.shape_new;
037    
038    import org.deegree.model.spatialschema.Geometry;
039    
040    /**
041     * <code>Shape</code> defines methods to read, write and use objects read from/written to a
042     * shapefile (as well as some basic information).
043     *
044     * @author <a href="mailto:schmitz@lat-lon.de">Andreas Schmitz</a>
045     * @author last edited by: $Author: mschneider $
046     *
047     * @version $Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $
048     */
049    public interface Shape {
050    
051        /**
052         * Reads the object from a byte array.
053         *
054         * @param bytes
055         * @param offset
056         *            where to start reading
057         * @return the new offset or -1, if the type was wrong.
058         */
059        public int read( byte[] bytes, int offset );
060    
061        /**
062         * Writes the object to a byte array.
063         *
064         * @param bytes
065         * @param offset
066         * @return the new offset.
067         */
068        public int write( byte[] bytes, int offset );
069    
070        /**
071         * @return the number of bytes necessary to write this instance.
072         */
073        public int getByteLength();
074    
075        /**
076         * @return the type of the shape
077         */
078        public int getType();
079    
080        /**
081         * @return the shapes' envelope, or null, if it has none
082         */
083        public ShapeEnvelope getEnvelope();
084    
085        /**
086         * @return the shape as deegree Geometry
087         * @throws ShapeGeometryException
088         *             if the deegree geometry could not be constructed
089         */
090        public Geometry getGeometry()
091                                throws ShapeGeometryException;
092    
093    }