org.geolatte.geom.codec.WkbDecoder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geolatte-geom Show documentation

This geoLatte-geom library offers a geometry model that conforms to the OGC Simple Features for SQL specification.

The 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 - 2012 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.geom.codec;

import org.geolatte.geom.ByteBuffer;
import org.geolatte.geom.Geometry;
import org.geolatte.geom.Position;
import org.geolatte.geom.crs.CoordinateReferenceSystem;

/**
 * A decoder for WKB (Well-Known Binary) encoded Geometries.
 *
 * In general WkbDecoder implementations are not be thread-safe.
 *
 * @author Karel Maesen, Geovise BVBA
 * creation-date: 9/29/12
 */
public interface WkbDecoder {

    /**
     * Decodes a WKB encoded representation of a Geometry
     *
     * @param byteBuffer the WKB encoded binary representation
     * @return the represented Geometry
     * @throws WkbDecodeException if the specified ByteBuffer is an illegal or unsupported WKB representation
     */
    default Geometry decode(ByteBuffer byteBuffer) {
        return decode(byteBuffer, null);
    }


    /**
     * Decodes a WKB encoded representation of a Geometry, assuming the specified
     * {@code CoordinateReferenceSystem}
     *
     * @param byteBuffer the WKB encoded binary representation
     * @param crs        the base coordinate reference system assumed for the wkt
     * @param         the Position type for the (base)
     * @return the represented Geometry
     * @throws WkbDecodeException if the specified ByteBuffer is an illegal or unsupported WKB representation
     */
    
 Geometry
 decode(ByteBuffer byteBuffer, CoordinateReferenceSystem crs);
}