Moving GeoJSON into parser package

Need to discuss whether we want all to require constructing a new parser.  I liked the simple `ol.io.geojson.read` function.
This commit is contained in:
Tim Schaub
2013-02-20 00:09:38 -07:00
parent 735f490f56
commit 9cac8ec2f6
2 changed files with 35 additions and 31 deletions
@@ -1,4 +1,4 @@
goog.provide('ol.io.geojson'); goog.provide('ol.parser.geojson');
goog.require('ol.Feature'); goog.require('ol.Feature');
goog.require('ol.geom.Geometry'); goog.require('ol.geom.Geometry');
@@ -17,10 +17,10 @@ goog.require('ol.geom.Polygon');
* ol.geom.Geometry|Array.<ol.geom.Geometry>} Parsed geometry or array * ol.geom.Geometry|Array.<ol.geom.Geometry>} Parsed geometry or array
* of geometries. * of geometries.
*/ */
ol.io.geojson.read = function(str) { ol.parser.geojson.read = function(str) {
// TODO: add options and accept projection // TODO: add options and accept projection
var json = /** @type {GeoJSONObject} */ (JSON.parse(str)); var json = /** @type {GeoJSONObject} */ (JSON.parse(str));
return ol.io.geojson.parse_(json); return ol.parser.geojson.parse_(json);
}; };
@@ -31,43 +31,43 @@ ol.io.geojson.read = function(str) {
* of geometries. * of geometries.
* @private * @private
*/ */
ol.io.geojson.parse_ = function(json) { ol.parser.geojson.parse_ = function(json) {
var result; var result;
switch (json.type) { switch (json.type) {
case 'FeatureCollection': case 'FeatureCollection':
result = ol.io.geojson.parseFeatureCollection_( result = ol.parser.geojson.parseFeatureCollection_(
/** @type {GeoJSONFeatureCollection} */ (json)); /** @type {GeoJSONFeatureCollection} */ (json));
break; break;
case 'Feature': case 'Feature':
result = ol.io.geojson.parseFeature_( result = ol.parser.geojson.parseFeature_(
/** @type {GeoJSONFeature} */ (json)); /** @type {GeoJSONFeature} */ (json));
break; break;
case 'GeometryCollection': case 'GeometryCollection':
result = ol.io.geojson.parseGeometryCollection_( result = ol.parser.geojson.parseGeometryCollection_(
/** @type {GeoJSONGeometryCollection} */ (json)); /** @type {GeoJSONGeometryCollection} */ (json));
break; break;
case 'Point': case 'Point':
result = ol.io.geojson.parsePoint_( result = ol.parser.geojson.parsePoint_(
/** @type {GeoJSONGeometry} */ (json)); /** @type {GeoJSONGeometry} */ (json));
break; break;
case 'LineString': case 'LineString':
result = ol.io.geojson.parseLineString_( result = ol.parser.geojson.parseLineString_(
/** @type {GeoJSONGeometry} */ (json)); /** @type {GeoJSONGeometry} */ (json));
break; break;
case 'Polygon': case 'Polygon':
result = ol.io.geojson.parsePolygon_( result = ol.parser.geojson.parsePolygon_(
/** @type {GeoJSONGeometry} */ (json)); /** @type {GeoJSONGeometry} */ (json));
break; break;
case 'MultiPoint': case 'MultiPoint':
result = ol.io.geojson.parseMultiPoint_( result = ol.parser.geojson.parseMultiPoint_(
/** @type {GeoJSONGeometry} */ (json)); /** @type {GeoJSONGeometry} */ (json));
break; break;
case 'MultiLineString': case 'MultiLineString':
result = ol.io.geojson.parseMultiLineString_( result = ol.parser.geojson.parseMultiLineString_(
/** @type {GeoJSONGeometry} */ (json)); /** @type {GeoJSONGeometry} */ (json));
break; break;
case 'MultiPolygon': case 'MultiPolygon':
result = ol.io.geojson.parseMultiPolygon_( result = ol.parser.geojson.parseMultiPolygon_(
/** @type {GeoJSONGeometry} */ (json)); /** @type {GeoJSONGeometry} */ (json));
break; break;
default: default:
@@ -82,11 +82,11 @@ ol.io.geojson.parse_ = function(json) {
* @return {ol.Feature} Parsed feature. * @return {ol.Feature} Parsed feature.
* @private * @private
*/ */
ol.io.geojson.parseFeature_ = function(json) { ol.parser.geojson.parseFeature_ = function(json) {
var geomJson = json.geometry, var geomJson = json.geometry,
geometry = null; geometry = null;
if (geomJson) { if (geomJson) {
geometry = /** @type {ol.geom.Geometry} */ (ol.io.geojson.parse_( geometry = /** @type {ol.geom.Geometry} */ (ol.parser.geojson.parse_(
/** @type {GeoJSONGeometry} */ (geomJson))); /** @type {GeoJSONGeometry} */ (geomJson)));
} }
var feature = new ol.Feature(); var feature = new ol.Feature();
@@ -101,14 +101,14 @@ ol.io.geojson.parseFeature_ = function(json) {
* @return {Array.<ol.Feature>} Parsed array of features. * @return {Array.<ol.Feature>} Parsed array of features.
* @private * @private
*/ */
ol.io.geojson.parseFeatureCollection_ = function(json) { ol.parser.geojson.parseFeatureCollection_ = function(json) {
var features = json.features, var features = json.features,
len = features.length, len = features.length,
result = new Array(len), result = new Array(len),
i; i;
for (i = 0; i < len; ++i) { for (i = 0; i < len; ++i) {
result[i] = ol.io.geojson.parse_( result[i] = ol.parser.geojson.parse_(
/** @type {GeoJSONFeature} */ (features[i])); /** @type {GeoJSONFeature} */ (features[i]));
} }
return result; return result;
@@ -120,14 +120,14 @@ ol.io.geojson.parseFeatureCollection_ = function(json) {
* @return {Array.<ol.geom.Geometry>} Parsed array of geometries. * @return {Array.<ol.geom.Geometry>} Parsed array of geometries.
* @private * @private
*/ */
ol.io.geojson.parseGeometryCollection_ = function(json) { ol.parser.geojson.parseGeometryCollection_ = function(json) {
var geometries = json.geometries, var geometries = json.geometries,
len = geometries.length, len = geometries.length,
result = new Array(len), result = new Array(len),
i; i;
for (i = 0; i < len; ++i) { for (i = 0; i < len; ++i) {
result[i] = ol.io.geojson.parse_( result[i] = ol.parser.geojson.parse_(
/** @type {GeoJSONGeometry} */ (geometries[i])); /** @type {GeoJSONGeometry} */ (geometries[i]));
} }
return result; return result;
@@ -139,7 +139,7 @@ ol.io.geojson.parseGeometryCollection_ = function(json) {
* @return {ol.geom.LineString} Parsed linestring. * @return {ol.geom.LineString} Parsed linestring.
* @private * @private
*/ */
ol.io.geojson.parseLineString_ = function(json) { ol.parser.geojson.parseLineString_ = function(json) {
return new ol.geom.LineString(json.coordinates); return new ol.geom.LineString(json.coordinates);
}; };
@@ -149,7 +149,7 @@ ol.io.geojson.parseLineString_ = function(json) {
* @return {ol.geom.MultiLineString} Parsed multi-linestring. * @return {ol.geom.MultiLineString} Parsed multi-linestring.
* @private * @private
*/ */
ol.io.geojson.parseMultiLineString_ = function(json) { ol.parser.geojson.parseMultiLineString_ = function(json) {
return new ol.geom.MultiLineString(json.coordinates); return new ol.geom.MultiLineString(json.coordinates);
}; };
@@ -159,7 +159,7 @@ ol.io.geojson.parseMultiLineString_ = function(json) {
* @return {ol.geom.MultiPoint} Parsed multi-point. * @return {ol.geom.MultiPoint} Parsed multi-point.
* @private * @private
*/ */
ol.io.geojson.parseMultiPoint_ = function(json) { ol.parser.geojson.parseMultiPoint_ = function(json) {
return new ol.geom.MultiPoint(json.coordinates); return new ol.geom.MultiPoint(json.coordinates);
}; };
@@ -169,7 +169,7 @@ ol.io.geojson.parseMultiPoint_ = function(json) {
* @return {ol.geom.MultiPolygon} Parsed multi-polygon. * @return {ol.geom.MultiPolygon} Parsed multi-polygon.
* @private * @private
*/ */
ol.io.geojson.parseMultiPolygon_ = function(json) { ol.parser.geojson.parseMultiPolygon_ = function(json) {
return new ol.geom.MultiPolygon(json.coordinates); return new ol.geom.MultiPolygon(json.coordinates);
}; };
@@ -179,7 +179,7 @@ ol.io.geojson.parseMultiPolygon_ = function(json) {
* @return {ol.geom.Point} Parsed multi-point. * @return {ol.geom.Point} Parsed multi-point.
* @private * @private
*/ */
ol.io.geojson.parsePoint_ = function(json) { ol.parser.geojson.parsePoint_ = function(json) {
return new ol.geom.Point(json.coordinates); return new ol.geom.Point(json.coordinates);
}; };
@@ -189,6 +189,6 @@ ol.io.geojson.parsePoint_ = function(json) {
* @return {ol.geom.Polygon} Parsed polygon. * @return {ol.geom.Polygon} Parsed polygon.
* @private * @private
*/ */
ol.io.geojson.parsePolygon_ = function(json) { ol.parser.geojson.parsePolygon_ = function(json) {
return new ol.geom.Polygon(json.coordinates); return new ol.geom.Polygon(json.coordinates);
}; };
@@ -1,4 +1,6 @@
describe('ol.io.geojson', function() { goog.provide('ol.test.parser.geojson');
describe('ol.parser.geojson', function() {
var data = { var data = {
'type': 'FeatureCollection', 'type': 'FeatureCollection',
@@ -72,7 +74,7 @@ describe('ol.io.geojson', function() {
coordinates: [10, 20] coordinates: [10, 20]
}); });
var obj = ol.io.geojson.read(str); var obj = ol.parser.geojson.read(str);
expect(obj).toBeA(ol.geom.Point); expect(obj).toBeA(ol.geom.Point);
expect(obj.coordinates[0]).toBe(10); expect(obj.coordinates[0]).toBe(10);
expect(obj.coordinates[1]).toBe(20); expect(obj.coordinates[1]).toBe(20);
@@ -84,7 +86,7 @@ describe('ol.io.geojson', function() {
coordinates: [[10, 20], [30, 40]] coordinates: [[10, 20], [30, 40]]
}); });
var obj = ol.io.geojson.read(str); var obj = ol.parser.geojson.read(str);
expect(obj).toBeA(ol.geom.LineString); expect(obj).toBeA(ol.geom.LineString);
expect(obj.coordinates[0]).toBe(10); expect(obj.coordinates[0]).toBe(10);
expect(obj.coordinates[1]).toBe(20); expect(obj.coordinates[1]).toBe(20);
@@ -101,7 +103,7 @@ describe('ol.io.geojson', function() {
coordinates: [outer, inner1, inner2] coordinates: [outer, inner1, inner2]
}); });
var obj = ol.io.geojson.read(str); var obj = ol.parser.geojson.read(str);
expect(obj).toBeA(ol.geom.Polygon); expect(obj).toBeA(ol.geom.Polygon);
expect(obj.rings.length).toBe(3); expect(obj.rings.length).toBe(3);
expect(obj.rings[0]).toBeA(ol.geom.LinearRing); expect(obj.rings[0]).toBeA(ol.geom.LinearRing);
@@ -118,7 +120,7 @@ describe('ol.io.geojson', function() {
] ]
}); });
var array = ol.io.geojson.read(str); var array = ol.parser.geojson.read(str);
expect(array.length).toBe(2); expect(array.length).toBe(2);
expect(array[0]).toBeA(ol.geom.Point); expect(array[0]).toBeA(ol.geom.Point);
expect(array[1]).toBeA(ol.geom.LineString); expect(array[1]).toBeA(ol.geom.LineString);
@@ -126,7 +128,7 @@ describe('ol.io.geojson', function() {
it('parses feature collection', function() { it('parses feature collection', function() {
var str = JSON.stringify(data), var str = JSON.stringify(data),
array = ol.io.geojson.read(str); array = ol.parser.geojson.read(str);
expect(array.length).toBe(2); expect(array.length).toBe(2);
@@ -146,3 +148,5 @@ describe('ol.io.geojson', function() {
}); });
}); });
goog.require('ol.parser.geojson');