oracle.spatial.hadoop.vector.mvsuggest

Class LocalMVSService

java.lang.Object

oracle.spatial.hadoop.vector.mvsuggest.LocalMVSService

All Implemented Interfaces:

LocationService, MVSService

public class LocalMVSService
extends java.lang.Object
implements LocationService, MVSService

MVSService implementation used to communicate with a standalone instance of MVSuggest service.

The MVS location can be a path to the a whole MVS directory or only to a repository containing the layer templates.

An MVS repository has the following structure:

• A configuration file called mvsuggest_config.json
• A repository folder, typically called oraclemaps_pub
• Any other folders defined in mvsuggest_config.json

A repository used as service location should contain the layers templates and optionally the templates configurations (_config_), the geonames folder (_geonames_) and the _index_ folder if the repository has been indexed.

Constructor Summary

Constructors

Constructor and Description
LocalMVSService()

Method Summary

Modifier and Type	Method and Description
MVSQueryRequester	createQueryRequester() Creates an instance of MVSQueryRequester used to send match requests
void	environmentCleanup(org.apache.hadoop.conf.Configuration conf) Performs cleanning tasks like removing temporal file.
void	environmentSetup(org.apache.hadoop.conf.Configuration conf) Performs the necessary setup before running a job.
java.lang.String[]	getLayers() Gets the layers indexed by MVSuggest
MVSConfig	getMVSConfig() Gets the MVSuggest configuration bean
java.lang.String	getTemplate(java.lang.String layer) Gets the template content for a single layer
void	init(org.apache.hadoop.conf.Configuration config) Initializes a single instance per task.
protected void	init(java.lang.String mvsLocation, LocalMVSConfig mvsConfig)
void	init(java.lang.String serviceDirLocation, java.lang.String[] matchLayers) Initialize the service with the specified server URL.
protected java.util.List<GeoAreaInfo>	query(oracle.maps.suggest.MGRequest request)
java.util.List<GeoAreaInfo>	searchResult(java.util.List<java.lang.String> datas) Return the geometric area informations of the data strings.
GeoAreaInfo	searchResult(java.lang.String data) Return the geometric area information of the data string.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalMVSService

public LocalMVSService()

Method Detail

environmentSetup

public void environmentSetup(org.apache.hadoop.conf.Configuration conf)
                      throws java.io.IOException

Description copied from interface: MVSService

Performs the necessary setup before running a job. This method should be called only once per job, before the job is executed.

Specified by:

environmentSetup in interface MVSService

Parameters:

conf - the job configuration

Throws:

java.io.IOException

environmentCleanup

public void environmentCleanup(org.apache.hadoop.conf.Configuration conf)
                        throws java.io.IOException

Description copied from interface: MVSService

Performs cleanning tasks like removing temporal file. This method is executed once the job has finished.

Specified by:

environmentCleanup in interface MVSService

Parameters:

conf - the job configuration

Throws:

java.io.IOException

init

public void init(org.apache.hadoop.conf.Configuration config)
          throws java.io.IOException

Description copied from interface: MVSService

Initializes a single instance per task. This method should be called once per instance.

Specified by:

init in interface MVSService

Parameters:

config - the job configuration

Throws:

java.io.IOException

createQueryRequester

public MVSQueryRequester createQueryRequester()

Description copied from interface: MVSService

Creates an instance of MVSQueryRequester used to send match requests

Specified by:

createQueryRequester in interface MVSService

Returns:

getMVSConfig

public MVSConfig getMVSConfig()

Description copied from interface: MVSService

Gets the MVSuggest configuration bean

Specified by:

getMVSConfig in interface MVSService

Returns:

the MVsuggest configuration

init

public void init(java.lang.String serviceDirLocation,
                 java.lang.String[] matchLayers)
          throws java.io.IOException

Description copied from interface: LocationService

Initialize the service with the specified server URL.

Specified by:

init in interface LocationService

Parameters:

serviceDirLocation - the server URL

matchLayers - optional - which layers should be used to search

Throws:

java.io.IOException - thrown if an IOException occurs.

getLayers

public java.lang.String[] getLayers()

Description copied from interface: MVSService

Gets the layers indexed by MVSuggest

Specified by:

getLayers in interface MVSService

Returns:

an array of layer names

getTemplate

public java.lang.String getTemplate(java.lang.String layer)

Description copied from interface: MVSService

Gets the template content for a single layer

Specified by:

getTemplate in interface MVSService

Parameters:

layer - the template content in JSON format

Returns:

init

protected void init(java.lang.String mvsLocation,
                    LocalMVSConfig mvsConfig)
             throws java.io.IOException

Throws:

java.io.IOException

query

protected java.util.List<GeoAreaInfo> query(oracle.maps.suggest.MGRequest request)
                                     throws java.io.IOException

Throws:

java.io.IOException

searchResult

public GeoAreaInfo searchResult(java.lang.String data)
                         throws java.io.IOException

Description copied from interface: LocationService

Return the geometric area information of the data string.

Specified by:

searchResult in interface LocationService

Parameters:

data - data string

Returns:

geometric area information

Throws:

java.io.IOException - thrown if an IOException occurs.

searchResult

public java.util.List<GeoAreaInfo> searchResult(java.util.List<java.lang.String> datas)
                                         throws java.io.IOException

Description copied from interface: LocationService

Return the geometric area informations of the data strings. . Note that querying multiple records by request may produce different results that querying records independently (one by one).

Specified by:

searchResult in interface LocationService

Parameters:

datas - data strings

Returns:

the geometric area informations

Throws:

java.io.IOException - thrown if an IOException occurs.