Package org.heigit.ohsome.ohsomeapi.output.ratio

Class RatioGroupByBoundaryResponse

java.lang.Object

org.heigit.ohsome.ohsomeapi.output.ratio.RatioGroupByBoundaryResponse

All Implemented Interfaces:

Response

public class RatioGroupByBoundaryResponse
extends Object
implements Response

Represents the whole JSON response object for the data aggregation response using the /ratio/groupBy/boundary resource. It contains an optional Metadata object, the requested RatioGroupByResult for a JSON response and an identifier of the object. If the output format is GeoJSON, the response includes a Feature array, which holds the respective objects with their timestamp-value pairs.

Constructor Summary

Constructors

Constructor	Description
RatioGroupByBoundaryResponse(Attribution attribution, String apiVersion, Metadata metadata, RatioGroupByResult[] groupByBoundaryResult)

Method Summary

Modifier and Type	Method	Description
String	getApiVersion()
Attribution	getAttribution()
org.geojson.Feature[]	getFeatures()
RatioGroupByResult[]	getGroupByBoundaryResult()
Metadata	getMetadata()
String	getType()
static RatioGroupByBoundaryResponse	of(Attribution attribution, String apiVersion, Metadata metadata, String type, org.geojson.Feature[] features)	Static factory method returning the whole GeoJSON response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RatioGroupByBoundaryResponse

public RatioGroupByBoundaryResponse(Attribution attribution,
 String apiVersion,
 Metadata metadata,
 RatioGroupByResult[] groupByBoundaryResult)

Method Details

of

public static RatioGroupByBoundaryResponse of(Attribution attribution,
 String apiVersion,
 Metadata metadata,
 String type,
 org.geojson.Feature[] features)

Static factory method returning the whole GeoJSON response.

getAttribution

public Attribution getAttribution()

Specified by:

getAttribution in interface Response

getApiVersion

public String getApiVersion()

Specified by:

getApiVersion in interface Response

getMetadata

public Metadata getMetadata()

Specified by:

getMetadata in interface Response

getType

public String getType()

getFeatures

public org.geojson.Feature[] getFeatures()

getGroupByBoundaryResult

public RatioGroupByResult[] getGroupByBoundaryResult()