Returns the K nearest elements to a given geometry.
post
/spatialviewer/api/v1/spark/nearestNeighbors
Returns a list containing the K nearest elements from an RDD or distributed spatial index to a given geometry. Note that for none asynchronous jobs you can use the service response as data source for the Map API to display the results on map.
Request
Supported Media Types
- application/json
Query Parameters
-
asynchronous: boolean
if true the operation is runned asynchronously.Default Value:
false
Job details
Root Schema : NearestNeighborsJobInfo
Type:
Show Source
object-
dataPath(optional):
string
Path of the file or files in HDFS. Specify this property if useIndex is false.Example:
/user/oracle/spatialviewer/tweetsJune.json -
geometry(optional):
string
The geometry to determine the nearest neighbors. The geometry has to be in GeoJSON format.Example:
{"type":"Point", "coordinates":[2.33139, 48.86864]} -
indexPath(optional):
string
The index path in HDFS. Specify this property if useIndex is true.Example:
/user/oracle/spatialviewer/TweetsJune -
inputFormatClass(optional):
string
The input format class. Optional property that can be set if useIndex is false. If the input format class is not specified then the SparkContext's textFile is used.Example:
oracle.spatial.hadoop.vector.geojson.mapred.GeoJsonInputFormat -
jarWithNeededClasses(optional):
string
jar name with the user-defined classes like custom RecordInfoProvider or InputFormat. If the InputFormat class or the RecordInfoProvider class is not in the API, or in the hadoop API classes, then a jar with the user-defined classes must be provided. To be able to use this jar the user must add it in the /opt/oracle/oracle-spatial-graph/spatial/web-server/spatialviewer/WEB-INF/lib directory and restart the server. Optional property that can be set if useIndex is false.Example:
myjar.jar -
k(optional):
integer(int32)
Number of nearest neighbors.Example:
10 -
keyClass(optional):
string
Class of the input format keys. This property is required if an input format is defined.Example:
org.apache.hadoop.io.LongWritable -
outputPath(optional):
string
The job output path. Specify this property if asynchronous is true.Example:
/user/oracle/spatialviewer/NNResult -
recordInfoProviderClass(optional):
string
The class that provides the spatial information. Specify this property if useIndex is false.Example:
oracle.spatial.spark.vector.recordinfoprovider.GeoJsonRecordInfoProvider -
srid(optional):
integer(int32)
SRID of the geometries.Example:
8307 -
tolerance(optional):
number(double)
Double value that represents the tolerance used when performing spatial operations.Example:
0.05 -
useIndex(optional):
boolean
true if an index is used as input, false otherwiseExample:
true -
valueClass(optional):
string
Class of the input format values. This property is required if an input format is defined.Example:
org.apache.hadoop.io.Text
Response
Supported Media Types
- application/json
200 Response
successful request
Root Schema : RecordsInfo
Type:
Show Source
object-
copyright(optional):
string
Example:
Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved. -
features(optional):
array features
-
geodetic(optional):
boolean
true if the geometries are geodetic, false otherwise.Example:
true -
srs(optional):
integer(int32)
SRID of the geometries.Example:
8307 -
type(optional):
string
Example:
FeatureCollection
Nested Schema : Feature
Type:
Show Source
object-
_id(optional):
string
Feature id.Example:
1 -
geometry(optional):
object Geometry
-
type(optional):
string
Example:
Feature
Nested Schema : Geometry
Type:
Show Source
object-
coordinates(optional):
array coordinates
-
properties(optional):
object properties
Extra fields of the filtered records (see 2.8.2.1 Spatial Indexing Class Structure). For example we can have extra fields named followers_count, friends_count, location and user_id
-
type(optional):
string
Example:
Point
Nested Schema : properties
Type:
objectExtra fields of the filtered records (see 2.8.2.1 Spatial Indexing Class Structure). For example we can have extra fields named followers_count, friends_count, location and user_id
Show Source
-
followers_count(optional):
string
Example:
70 -
friends_count(optional):
string
Example:
51 -
location(optional):
string
Example:
Canada -
user_id(optional):
string
Example:
5039703
202 Response
accepted asynchronous request
Root Schema : AsyncNearestNeighborsJobResponse
Type:
Show Source
object-
o:successCode(optional):
string
The success code.Example:
SV-05009 -
response(optional):
string
The response contains the location of the resource manager web application URL to track the job (see in the configuration the Hadoop parameter yarn.resourcemanager.webapp.address).Example:
http://resource.manager.webapp:8088 -
status(optional):
string
success or errorExample:
success -
title(optional):
string
Service title.Example:
Create nearest neighbors job.
Examples
The following example shows how to perform a nearest neighbors analysis by submitting a POST request on the REST resource using cURL.
curl -v -X POST "http://localhost:8045/spatialviewer/api/v1/spark/nearestNeighbors" -H "accept: application/json" -H "content-type: application/json" -d "{ \"useIndex\": true, \"k\": 10, \"geometry\": \"{\\\"type\\\":\\\"Point\\\", \\\"coordinates\\\":[2.33139, 48.86864]}\", \"srid\": 8307, \"tolerance\": 0.05, \"indexPath\": \"/user/oracle/HOL/tweetsJune\"}"
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Wed, 15 Nov 2017 17:50:38 GMT Access-Control-Allow-Origin: * Access-Control-Allow-Credentials: true Access-Control-Allow-Methods: GET, POST, DELETE, PUT Access-Control-Allow-Headers: Content-Type, Accept Transfer-Encoding: chunked Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format, including one record:
{"type":"FeatureCollection","copyright":"Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.","srs":8307,"geodetic":true,"features":[{"type":"Feature","_id":"e8fd9cb3-8d1a-4c54-8583-9a4b682de2fd","geometry":{"type":"Point","coordinates":[-105.49998,28.19997]},"properties":{"RECORD_ID":"4789","followers_count":"13","friends_count":"199","location":"Chihuahua","user_id":"4092140"}}]}