Skip to content

Commit

Permalink
2.2.0
Browse files Browse the repository at this point in the history
-some cleanup
-web site update
  • Loading branch information
alatas committed Jan 17, 2017
1 parent 1f54705 commit ef877af
Show file tree
Hide file tree
Showing 6 changed files with 688 additions and 4 deletions.
4 changes: 2 additions & 2 deletions GeoJSON4EntityFramework/GeoJSON4EntityFramework.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<authors>Sukru Alatas</authors>
<owners>Sukru Alatas</owners>
<licenseUrl>https://raw.githubusercontent.com/alatas/GeoJSON4EntityFramework/master/LICENSE</licenseUrl>
<projectUrl>https://github.com/alatas/GeoJSON4EntityFramework</projectUrl>
<projectUrl>https://alatas.github.io/GeoJSON4EntityFramework/</projectUrl>
<iconUrl>https://raw.githubusercontent.com/alatas/GeoJSON4EntityFramework/master/geojson.png</iconUrl>
<requireLicenseAcceptance>true</requireLicenseAcceptance>
<description>
Expand All @@ -28,7 +28,7 @@
2.2.0
-added WKT support
-added geometry transform (thanks to @jumpinjackie)
-added quick start example projects to source
-added quick start and example projects
-reorganized whole code base and unit tests (this means lots of deletions)
-fixed some minor bugs
</releaseNotes>
Expand Down
4 changes: 2 additions & 2 deletions GeoJSON4EntityFramework5/GeoJSON4EntityFramework5.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<authors>Sukru Alatas</authors>
<owners>Sukru Alatas</owners>
<licenseUrl>https://raw.githubusercontent.com/alatas/GeoJSON4EntityFramework/master/LICENSE</licenseUrl>
<projectUrl>https://github.com/alatas/GeoJSON4EntityFramework</projectUrl>
<projectUrl>https://alatas.github.io/GeoJSON4EntityFramework/</projectUrl>
<iconUrl>https://raw.githubusercontent.com/alatas/GeoJSON4EntityFramework/master/geojson.png</iconUrl>
<requireLicenseAcceptance>true</requireLicenseAcceptance>
<description>
Expand All @@ -28,7 +28,7 @@
2.2.0
-added WKT support
-added geometry transform (thanks to @jumpinjackie)
-added quick start example projects to source
-added quick start and example projects
-reorganized whole code base and unit tests (this means lots of deletions)
-fixed some minor bugs
</releaseNotes>
Expand Down
8 changes: 8 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
title: GeoJSON4EntityFramework
description: Create GeoJSON from Entity Framework Spatial Data
google_analytics:
show_downloads: true
theme: jekyll-theme-slate

gems:
- jekyll-mentions
135 changes: 135 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# GeoJSON4EntityFramework ![Logo](https://raw.githubusercontent.com/alatas/GeoJSON4EntityFramework/master/geojson.png) ![BuildStatus](https://sukru.visualstudio.com/_apis/public/build/definitions/ef35124c-d2ad-4375-9c78-8862c095207b/1/badge)
___

### What is GeoJSON?
[GeoJSON](http://geojson.org/) is a format for encoding a variety of geographic data structures. A GeoJSON object may represent a geometry, a feature, or a collection of features.

In 2015, the Internet Engineering Task Force (IETF), in conjunction with the original specification authors, formed a GeoJSON WG to standardize GeoJSON. [RFC 7946](https://tools.ietf.org/html/rfc7946) was published in August 2016 and is the new standard specification of the GeoJSON format, replacing the 2008 GeoJSON specification.

GeoJSON supports _Point_, _LineString_, _Polygon_, _MultiPoint_, _MultiLineString_, _MultiPolygon_, and _GeometryCollection_ geometry types.

_Feature_ contain a geometry object and additional properties, and a _FeatureCollection_ represents a list of features.

For example, A house, a road and a bus stop represents three different _Feature_. All of them might have different type of geometries. House could be a _polygon_, road could be a _linestring_ and bus stop could be a _point_. All of them represents a neighbourhood and this called _FeatureCollection_ in GeoJSON.

### What is EntityFramework?
EntityFramework (EF) is an open source object-relational mapping [(ORM)](https://en.wikipedia.org/wiki/Object-relational_mapping) framework for Microsoft .net. It allows us to use database rows as class instances.

### What is Well-known Text (WKT)?
[Well-known Text (WKT)](https://en.wikipedia.org/wiki/Well-known_text) is a text markup language for representing vector geometry objects on a map, spatial reference systems of spatial objects and transformations between spatial reference systems. In summary, It's a text representations of geometrical objects.

### So, What is GeoJSON4EntityFramework ??
_GeoJSON for EntityFramework_ is a .net library that allows you to create GeoJSON output from EntityFramework Spatial Data or WKT inputs. In other words, It serializes different type of geometry objects to GeoJSON. It's not limited to only EF entities but It can serialize WKT inputs as well.

### Features
- [x] Supports Entity Framework v6 (System.Data.Entity.Spatial namespace) and Entity Framework v5 (System.Data.Spatial namespace) objects
- [x] Supports Well-known Text inputs
- [x] Supports DbGeometry (*planar*) and DbGeography (*geodetic "round earth"*) objects
- [x] Supports all types of features defined in geojson specs ([RFC 7946](https://tools.ietf.org/html/rfc7946))
- [x] Supports boundingbox property defined in geojson specs ([RFC 7946](https://tools.ietf.org/html/rfc7946))
- [x] Supports geometry transform

---

### Quick Start

#### EntityFramework Example

**Visual Basic**

```vbnet
Imports alatas.GeoJSON4EntityFramework

Function GetGeoJSONFromDB() As String
Using db As New SpatialExampleEntities
Dim data = From row In db.SampleTables Select row.SpatialData

Dim features as New FeatureCollection(data.ToArray)
Return features.Serialize(prettyPrint:=True)
End Using
End Function
```

**C#**

```csharp
using alatas.GeoJSON4EntityFramework;

public string GetGeoJSONFromDB()
{
using (Entities db = new Entities())
{

DbGeometry[] data = (from row in db.SampleTables select row.SpatialData).ToArray();

FeatureCollection features = new FeatureCollection(data);
return features.Serialize(prettyPrint: true);
}
}
```

#### Well-Known Text (WKT) Example

**Visual Basic**

```vbnet
Imports alatas.GeoJSON4EntityFramework

Function GetGeoJSONFromWKT() As String
Dim WKTs = {"POLYGON ((30 10, 40 40, 20 40, 10 20, 30 10))",
"MULTIPOINT ((10 40), (40 30), (20 20), (30 10))",
"LINESTRING (1 1, 2 2)"}

Dim features as New FeatureCollection(WKTs)
Return features.Serialize(prettyPrint:=True)
End Function
```

**C#**

```csharp
using alatas.GeoJSON4EntityFramework;

public string GetGeoJSONFromWKT()
{
string[] WKTs = {
"POLYGON ((30 10, 40 40, 20 40, 10 20, 30 10))",
"MULTIPOINT ((10 40), (40 30), (20 20), (30 10))",
"LINESTRING (1 1, 2 2)"
};

FeatureCollection features = new FeatureCollection(WKTs);
return features.Serialize(prettyPrint: true);
}
```

---

### Install

#### Install with Package Manager Console - Nuget

To install GeoJSON for Entity Framework, run the following command in the Package Manager Console

**Entity Framework 6**

```powershell
Install-Package GeoJSON4EntityFramework
```

**Entity Framework 5**

```powershell
Install-Package GeoJSON4EntityFramework5
```

#### Manual Install
Download the latest [release](https://github.com/alatas/GeoJSON4EntityFramework/releases) and add to your project references manually

### Prerequisites
* Microsoft® System CLR Types for Microsoft® SQL Server® (x86/x64) [(SQLSysClrTypes.msi)](https://www.microsoft.com/en-us/download/details.aspx?id=49999)

### Tests and Validation
You may validate outputs with http://geojson.io and http://geojsonlint.com
___
Test data extracted from OpenStreetMap®. OpenStreetMap® is open data, licensed under the [Open Data Commons Open Database License](http://opendatacommons.org/licenses/odbl/) (ODbL) by the OpenStreetMap Foundation (OSMF)
116 changes: 116 additions & 0 deletions docs/stylesheets/github-light.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
/*
Copyright 2014 GitHub Inc.
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.
*/

.pl-c /* comment */ {
color: #969896;
}

.pl-c1 /* constant, markup.raw, meta.diff.header, meta.module-reference, meta.property-name, support, support.constant, support.variable, variable.other.constant */,
.pl-s .pl-v /* string variable */ {
color: #0086b3;
}

.pl-e /* entity */,
.pl-en /* entity.name */ {
color: #795da3;
}

.pl-s .pl-s1 /* string source */,
.pl-smi /* storage.modifier.import, storage.modifier.package, storage.type.java, variable.other, variable.parameter.function */ {
color: #333;
}

.pl-ent /* entity.name.tag */ {
color: #63a35c;
}

.pl-k /* keyword, storage, storage.type */ {
color: #a71d5d;
}

.pl-pds /* punctuation.definition.string, string.regexp.character-class */,
.pl-s /* string */,
.pl-s .pl-pse .pl-s1 /* string punctuation.section.embedded source */,
.pl-sr /* string.regexp */,
.pl-sr .pl-cce /* string.regexp constant.character.escape */,
.pl-sr .pl-sra /* string.regexp string.regexp.arbitrary-repitition */,
.pl-sr .pl-sre /* string.regexp source.ruby.embedded */ {
color: #183691;
}

.pl-v /* variable */ {
color: #ed6a43;
}

.pl-id /* invalid.deprecated */ {
color: #b52a1d;
}

.pl-ii /* invalid.illegal */ {
background-color: #b52a1d;
color: #f8f8f8;
}

.pl-sr .pl-cce /* string.regexp constant.character.escape */ {
color: #63a35c;
font-weight: bold;
}

.pl-ml /* markup.list */ {
color: #693a17;
}

.pl-mh /* markup.heading */,
.pl-mh .pl-en /* markup.heading entity.name */,
.pl-ms /* meta.separator */ {
color: #1d3e81;
font-weight: bold;
}

.pl-mq /* markup.quote */ {
color: #008080;
}

.pl-mi /* markup.italic */ {
color: #333;
font-style: italic;
}

.pl-mb /* markup.bold */ {
color: #333;
font-weight: bold;
}

.pl-md /* markup.deleted, meta.diff.header.from-file */ {
background-color: #ffecec;
color: #bd2c00;
}

.pl-mi1 /* markup.inserted, meta.diff.header.to-file */ {
background-color: #eaffea;
color: #55a532;
}

.pl-mdr /* meta.diff.range */ {
color: #795da3;
font-weight: bold;
}

.pl-mo /* meta.output */ {
color: #1d3e81;
}

Loading

0 comments on commit ef877af

Please sign in to comment.