Package fiftyone.geolocation.core

Class GeoEngineHelper

  • public class GeoEngineHelper
extends java.lang.Object
    Helper class that contains shared functionality required by geo-location engines. This functionality is here rather than a geo engine base class because different geo-location engines require different engine base class functionality.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  GeoEngineHelper.GeoLookupResult
      The result of a call to performGeoLookup.

    • Constructor Summary

      Constructors 
      Constructor Description
      GeoEngineHelper()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static GeoEngineHelper.GeoLookupResult performGeoLookup​(fiftyone.pipeline.core.data.FlowData data, fiftyone.pipeline.engines.services.HttpClient webClient, RequestFormatter requestFormatter)
      Use evidence from the specified FlowData instance to construct a query

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • GeoEngineHelper

        public GeoEngineHelper()

    • Method Detail

      • performGeoLookup

        public static GeoEngineHelper.GeoLookupResult performGeoLookup​(fiftyone.pipeline.core.data.FlowData data,
                                                               fiftyone.pipeline.engines.services.HttpClient webClient,
                                                               RequestFormatter requestFormatter)
                                                        throws java.io.IOException
        Use evidence from the specified FlowData instance to construct a query
        Parameters:
        data - the flow data to process
        webClient - the HttpClient to use when making a request to the geo-location service.
        requestFormatter - a formatter that will create a URL that can be used to query a web service based on the supplied GeoEvidence
        Returns:
        A new GeoLookupResult instance. If the supplied FlowData contains the required evidence then this will contain the raw response from the web service. If not, it will contain the JavaScript to run on the client device in order to supply the required evidence.
        Throws:
        java.io.IOException