oracle.spatial.hadoop.vector.mvsuggest

Class MVSConfig

java.lang.Object

oracle.spatial.hadoop.vector.mvsuggest.MVSConfig

Direct Known Subclasses:

LocalMVSConfig

public class MVSConfig
extends java.lang.Object

Holds the MVSService configuration. An instance of this class can be stored and loaded to/from a job configuration.

Author:

hsaucedo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MVSConfig.ResponseSpatialContent The type of spatial content returned by MVSuggest
static class	MVSConfig.ServiceInterface The type of MVSuggest interface

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONF_MATCH_COUNTRY Job configuration: a country name used as a context for searches
static java.lang.String	CONF_MATCH_LAYERS Job configuration: a comma separated list of layers used by MVSuggest to perform searches
static java.lang.String	CONF_MAX_QUERY_RECORDS Job configuration: an integer number defining the maximum number of records sent to MVSuggest by each request.
static java.lang.String	CONF_PROVIDE_TEMPLATES Job configuration: boolean value that specified whether or not the MVSuggest implementation should keep the templates content in memory.
static java.lang.String	CONF_RESPONCE_SPATIAL_CONTENT Job configuration: the type of spatial content returned by MVSuggest.
static java.lang.String	CONF_SERVCE_LOCATION Job configuration: the MVSuggest location.
static java.lang.String	CONF_SERVICE_INTERFACE Job configuration: the type of MVSuggest interface.

Constructor Summary

Constructors

Constructor and Description
MVSConfig()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMatchCountry() Gets a country name used as context when performing a search
java.lang.String[]	getMatchLayers() Gets the layer names used to narrow MVS searches
int	getMaxQueryRecords() Gets the maximum number of records contained in a request to MVSuggest.
MVSConfig.ResponseSpatialContent	getResponseSpatialContentType() Gets the type of spatial content returned by MVSuggest when a match is found.
MVSConfig.ServiceInterface	getServiceInterfaceType() Gets the MVSuggest interface type
java.lang.String	getServiceLocation() Gets the MVS service location.
boolean	isProvideTemplates() Tells whether the templates should be kept in memory so they can be retrieved by calling MVSService.getTemplate(String)
void	load(Configuration conf) Loads the MVSuggest configuration from the job configuration
void	setMatchCountry(java.lang.String matchCountry) Sets a country name used as context when performing a search
void	setMatchLayers(java.lang.String[] matchLayers) Sets the layer names used to narrow MVS searches.
void	setMaxQueryRecords(int maxQueryRecords) Sets maximum number of records contained in a request to MVSuggest
void	setProvideTemplates(boolean provideTemplates) Sets whether the templates should be kept in memory so they can be retrieved by calling MVSService.getTemplate(String)
void	setResponseSpatialContentType(MVSConfig.ResponseSpatialContent responseSpatialContentType) Sets the type of spatial content returned by MVSuggest when a match is found.
void	setServiceInterfaceType(MVSConfig.ServiceInterface serviceInterfaceType) Sets the MVSuggest interface type
void	setServiceLocation(java.lang.String serviceLocation) Sets the MVS service location
void	store(Configuration conf) Saves the MVSuggest to the job configuration

Methods inherited from class java.lang.Object

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

Field Detail

CONF_MATCH_COUNTRY

public static final java.lang.String CONF_MATCH_COUNTRY

Job configuration: a country name used as a context for searches

See Also:

Constant Field Values

CONF_MATCH_LAYERS

public static final java.lang.String CONF_MATCH_LAYERS

Job configuration: a comma separated list of layers used by MVSuggest to perform searches

See Also:

Constant Field Values

CONF_MAX_QUERY_RECORDS

public static final java.lang.String CONF_MAX_QUERY_RECORDS

Job configuration: an integer number defining the maximum number of records sent to MVSuggest by each request.

See Also:

Constant Field Values

CONF_PROVIDE_TEMPLATES

public static final java.lang.String CONF_PROVIDE_TEMPLATES

Job configuration: boolean value that specified whether or not the MVSuggest implementation should keep the templates content in memory. If false, calls to MVSService.getTemplate(String) will always return null.

See Also:

Constant Field Values

CONF_RESPONCE_SPATIAL_CONTENT

public static final java.lang.String CONF_RESPONCE_SPATIAL_CONTENT

Job configuration: the type of spatial content returned by MVSuggest. Supported types are defined in MVSConfig.ResponseSpatialContent

See Also:

Constant Field Values

CONF_SERVCE_LOCATION

public static final java.lang.String CONF_SERVCE_LOCATION

Job configuration: the MVSuggest location. Depending on the MVSuggest interface it may be a path or a URL

See Also:

Constant Field Values

CONF_SERVICE_INTERFACE

public static final java.lang.String CONF_SERVICE_INTERFACE

Job configuration: the type of MVSuggest interface. Supported types are defined in MVSConfig.ServiceInterface

See Also:

Constant Field Values

Constructor Detail

MVSConfig

public MVSConfig()

Method Detail

getMatchCountry

public java.lang.String getMatchCountry()

Gets a country name used as context when performing a search

Returns:

a country name

getMatchLayers

public java.lang.String[] getMatchLayers()

Gets the layer names used to narrow MVS searches

Returns:

an array of layer names

getMaxQueryRecords

public int getMaxQueryRecords()

Gets the maximum number of records contained in a request to MVSuggest. The default value is 1

Returns:

maxQueryRecords the maximum number of query records per request

getResponseSpatialContentType

public MVSConfig.ResponseSpatialContent getResponseSpatialContentType()

Gets the type of spatial content returned by MVSuggest when a match is found. It can return the whole geometry of the matched feature, a centroid or nothing.

Returns:

the features spatial content type contained in a response

getServiceInterfaceType

public MVSConfig.ServiceInterface getServiceInterfaceType()

Gets the MVSuggest interface type

Returns:

the MVSuggest interface type

getServiceLocation

public java.lang.String getServiceLocation()

Gets the MVS service location.

Returns:

the MVS service location. When MVSuggest interface is local it is a path. When the interface is web it is a URL.

isProvideTemplates

public boolean isProvideTemplates()

Tells whether the templates should be kept in memory so they can be retrieved by calling MVSService.getTemplate(String)

Returns:

true if templates are provided by MVSService

load

public void load(Configuration conf)

Loads the MVSuggest configuration from the job configuration

Parameters:

conf - a job configuration

setMatchCountry

public void setMatchCountry(java.lang.String matchCountry)

Sets a country name used as context when performing a search

Parameters:

matchCountry - a country name

setMatchLayers

public void setMatchLayers(java.lang.String[] matchLayers)

Sets the layer names used to narrow MVS searches. If null is set, all the layers indexed by MVSuggest will be used.

Parameters:

matchLayers - an array of layer names

setMaxQueryRecords

public void setMaxQueryRecords(int maxQueryRecords)

Sets maximum number of records contained in a request to MVSuggest

Parameters:

maxQueryRecords - the maximum number of query records per request

setProvideTemplates

public void setProvideTemplates(boolean provideTemplates)

Sets whether the templates should be kept in memory so they can be retrieved by calling MVSService.getTemplate(String)

Parameters:

provideTemplates - true if templates are provided by MVSService

setResponseSpatialContentType

public void setResponseSpatialContentType(MVSConfig.ResponseSpatialContent responseSpatialContentType)

Sets the type of spatial content returned by MVSuggest when a match is found. It can return the whole geometry of the matched feature, a centroid or nothing.

Parameters:

responseSpatialContentType - the features spatial content type contained in a response

setServiceInterfaceType

public void setServiceInterfaceType(MVSConfig.ServiceInterface serviceInterfaceType)

Sets the MVSuggest interface type

Parameters:

serviceInterfaceType - the MVSuggest interface type

setServiceLocation

public void setServiceLocation(java.lang.String serviceLocation)

Sets the MVS service location

Parameters:

serviceLocation - the MVS service location. When MVSuggest interface is local it is a path. When the interface is web it is a URL.

store

public void store(Configuration conf)

Saves the MVSuggest to the job configuration

Parameters:

conf - a job configuration