net.sf.eBusx.geo.package-info Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of extensions Show documentation
The newest version!
//
// Copyright 2021 Charles W. Rapp
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

/**
 * This package defines
 * {@link net.sf.eBus.messages.EField eBus message fields}
 * implementing GeoJSON data types as defined in
 * GeoJSON specification..
 * These data types include three fundamental geometry
 * constructs:
 * 
 *   
 *     {@link net.sf.eBusx.geo.Position Position}:
 *     Contains three values: latitude (required), longitude
 *     (required), and elevation (optional).
 *   
 *   
 *     {@link net.sf.eBusx.geo.LineString Line String}:
 *     Contains two or more positions.
 *   
 *   
 *     {@link net.sf.eBusx.geo.BoundingBox Bounding Box}:
 *     Contains four postions: two latitudes and two longitudes.
 *   
 * 
 * 
 * The above types are used to create the following
 * {@link net.sf.eBusx.geo.GeoObject.GeoType GeoJSON complex types}:
 * 
 * 
 *   
 *     {@link net.sf.eBusx.geo.GeoPoint GeoPoint}:
 *     Contains a single position.
 *   
 *   
 *     {@link net.sf.eBusx.geo.GeoMultiPoint GeoMultiPoint}:
 *     Contains zero or more positions.
 *   
 *   
 *     {@link net.sf.eBusx.geo.GeoLineString GeoLineString}:
 *     Contains a single line string.
 *   
 *   
 *     {@link net.sf.eBusx.geo.GeoMultiLineString GeoMultiLineString}:
 *     Contains zero or more line strings.
 *   
 *   
 *     {@link net.sf.eBusx.geo.GeoPolygon GeoPolygon}:
 *     Contains at least one linear ring. A linear ring is a
 *     closed line string containing at least four positions.
 *   
 * 
 * 
 * GeoJSON types {@code FeatureCollection}, {@code Feature},
 * {@code MultiPolygon}, and {@code GeometryCollection} are
 * not implemented.
 * 
 * 
 * For more information on each GeoJSON type please see the
 * type's javadoc page.
 * 
 */

package net.sf.eBusx.geo;