oracle.spatial.hadoop.vector.mvsuggest

Class MVSHelper

java.lang.Object

oracle.spatial.hadoop.vector.mvsuggest.MVSHelper

public class MVSHelper
extends java.lang.Object

This class encapsulates an MVSuggest web client and helps performing configuration tasks and managing the requests.

Author:

hsaucedo

Constructor Summary

Constructors

Constructor and Description
MVSHelper(java.lang.String mvsUrl, java.lang.String[] matchingLayers) Creates a new instance with the given MVSuggest configuration.

Method Summary

Modifier and Type	Method and Description
long	consumeLastRequestTime() Gets the last request time and sets the time to zero so if it is called again before execution other request it will always return zero.
static MVSHelper	getConfiguredInstance(JobConf conf) Creates a MVSHelper instance using the current job configuration
java.util.List<GeoAreaInfo>	pushRequest(java.lang.String location) Adds a field to the current request.
java.util.List<GeoAreaInfo>	request() Sends a request to MVSuggest using the location texts contained in the buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

MVSHelper

public MVSHelper(java.lang.String mvsUrl,
                 java.lang.String[] matchingLayers)
          throws java.io.IOException

Creates a new instance with the given MVSuggest configuration.

Parameters:

mvsUrl - the MVSuggest service URL

matchingLayers - the layers MVSuggest should use

Throws:

java.io.IOException

Method Detail

consumeLastRequestTime

public long consumeLastRequestTime()

Gets the last request time and sets the time to zero so if it is called again before execution other request it will always return zero.

Returns:

the time spent performing the last request.

getConfiguredInstance

public static MVSHelper getConfiguredInstance(JobConf conf)
                                       throws java.io.IOException

Creates a MVSHelper instance using the current job configuration

Parameters:

conf - the job configuration

Returns:

a new MVSHelper instance or null if no MVSuggest service configuration was found

Throws:

java.io.IOException

pushRequest

public java.util.List<GeoAreaInfo> pushRequest(java.lang.String location)
                                        throws java.io.IOException

Adds a field to the current request. If the request buffer is full the request is performed and a result is returned, otherwise. To force sending a request with the current buffer's location texts call the request() method

Parameters:

location - a location text

Returns:

if the request is performed it will return a value for the last locations added except the last one. Otherwise it returns null.

Throws:

java.io.IOException

request

public java.util.List<GeoAreaInfo> request()
                                    throws java.io.IOException

Sends a request to MVSuggest using the location texts contained in the buffer. After executing a request the buffer is cleared.

Returns:

a list of results for the location texts contained in the buffer

Throws:

java.io.IOException