oracle.spatial.hadoop.vector.mvsuggest

Class LocalMVSConfig

java.lang.Object

oracle.spatial.hadoop.vector.mvsuggest.MVSConfig

oracle.spatial.hadoop.vector.mvsuggest.LocalMVSConfig

public class LocalMVSConfig
extends MVSConfig

Holds the configuration values for a Local MVSuggest instance additionally to the general configuration in MVSConfig

Author:

hsaucedo

Nested Class Summary

Nested classes/interfaces inherited from class oracle.spatial.hadoop.vector.mvsuggest.MVSConfig

MVSConfig.ResponseSpatialContent, MVSConfig.ServiceInterface

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONF_ENV_IS_REPO_LOC Job configuration: boolean value that specifies whether the service location refers to a repository (true) or to a whole MVS directory (false)
static java.lang.String	CONF_ENV_OVERWRITE_PERSIST_SERV_LOC Job configuration: boolean value that specifies whether CONF_ENV_PERSIST_SERV_LOC should be overwritten by the content pointed by MVSConfig.CONF_SERVCE_LOCATION (true) or not (false)
static java.lang.String	CONF_ENV_PERSIST_SERV_LOC Job configuration: the name of the HDFS path where the MVS directory should be saved.
static java.lang.String	CONF_ENV_REBUILD_INDEX Job configuration: boolean value indicating if the MVS directory index should be rebuilt (true) or not (false).
static java.lang.String	DEFAULT_REPOSITORY_NAME
static java.lang.String	MVS_CONFIG_FILE MVS configuration file name
static java.lang.String	REPOSITORY_CONFIG_DIR Repository configuration folder name
static java.lang.String	REPOSITORY_GEONAMES_DIR Geonames folder name
static java.lang.String	REPOSITORY_INDEX_DIR MVS index folder name

Fields inherited from class oracle.spatial.hadoop.vector.mvsuggest.MVSConfig

CONF_MATCH_COUNTRY, CONF_MATCH_LAYERS, CONF_MAX_QUERY_RECORDS, CONF_PROVIDE_TEMPLATES, CONF_RESPONCE_SPATIAL_CONTENT, CONF_SERVCE_LOCATION, CONF_SERVICE_INTERFACE

Constructor Summary

Constructors

Constructor and Description
LocalMVSConfig()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPersistentServiceLocation() Gets the path where the MVS folder should be saved in HDFS.
java.lang.String	getRepositoryName() Gets the name of the repository folder name in an MVS location
boolean	isOverwritePersistentServiceLocation() Tells whether CONF_ENV_PERSIST_SERV_LOC should be overwritten by MVSConfig.CONF_SERVCE_LOCATION
boolean	isRebuildIndex() Tells whether the MVS index should be rebuilt when it does not exist.
boolean	isRepositoryLocation() Tells whether the current MVS location refers to a repository or not.
void	load(Configuration conf) Loads the MVSuggest configuration from the job configuration
void	setOverwritePersistentServiceLocation(boolean overwritePersistentServiceLocation) Sets whether CONF_ENV_PERSIST_SERV_LOC should be overwritten by MVSConfig.CONF_SERVCE_LOCATION
void	setPersistentServiceLocation(java.lang.String persistentServiceLocation) Sets the path where the MVS folder should be saved in HDFS.
void	setRebuildIndex(boolean rebuildIndex) Sets whether the MVS index should be rebuilt when it does not exist.
void	setRepositoryLocation(boolean repositoryLocation) Sets whether the current MVS location refers to a repository or not.
void	setRepositoryName(java.lang.String repositoryName) Sets the name of the repository folder name in an MVS location
void	store(Configuration conf) Saves the MVSuggest to the job configuration

Methods inherited from class oracle.spatial.hadoop.vector.mvsuggest.MVSConfig

getMatchCountry, getMatchLayers, getMaxQueryRecords, getResponseSpatialContentType, getServiceInterfaceType, getServiceLocation, isProvideTemplates, setMatchCountry, setMatchLayers, setMaxQueryRecords, setProvideTemplates, setResponseSpatialContentType, setServiceInterfaceType, setServiceLocation

Methods inherited from class java.lang.Object

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

Field Detail

CONF_ENV_IS_REPO_LOC

public static final java.lang.String CONF_ENV_IS_REPO_LOC

Job configuration: boolean value that specifies whether the service location refers to a repository (true) or to a whole MVS directory (false)

See Also:

Constant Field Values

CONF_ENV_OVERWRITE_PERSIST_SERV_LOC

public static final java.lang.String CONF_ENV_OVERWRITE_PERSIST_SERV_LOC

Job configuration: boolean value that specifies whether CONF_ENV_PERSIST_SERV_LOC should be overwritten by the content pointed by MVSConfig.CONF_SERVCE_LOCATION (true) or not (false)

See Also:

Constant Field Values

CONF_ENV_PERSIST_SERV_LOC

public static final java.lang.String CONF_ENV_PERSIST_SERV_LOC

Job configuration: the name of the HDFS path where the MVS directory should be saved. If the path already exists, it will be used as the service location instead of MVSConfig.CONF_SERVCE_LOCATION

See Also:

Constant Field Values

CONF_ENV_REBUILD_INDEX

public static final java.lang.String CONF_ENV_REBUILD_INDEX

Job configuration: boolean value indicating if the MVS directory index should be rebuilt (true) or not (false). Default value is false.

See Also:

Constant Field Values

DEFAULT_REPOSITORY_NAME

public static final java.lang.String DEFAULT_REPOSITORY_NAME

See Also:

Constant Field Values

MVS_CONFIG_FILE

public static final java.lang.String MVS_CONFIG_FILE

MVS configuration file name

See Also:

Constant Field Values

REPOSITORY_CONFIG_DIR

public static final java.lang.String REPOSITORY_CONFIG_DIR

Repository configuration folder name

See Also:

Constant Field Values

REPOSITORY_GEONAMES_DIR

public static final java.lang.String REPOSITORY_GEONAMES_DIR

Geonames folder name

See Also:

Constant Field Values

REPOSITORY_INDEX_DIR

public static final java.lang.String REPOSITORY_INDEX_DIR

MVS index folder name

See Also:

Constant Field Values

Constructor Detail

LocalMVSConfig

public LocalMVSConfig()

Method Detail

getPersistentServiceLocation

public java.lang.String getPersistentServiceLocation()

Gets the path where the MVS folder should be saved in HDFS.

Returns:

an HDFS path or null if the MVS location is not saved in HDFS.

getRepositoryName

public java.lang.String getRepositoryName()

Gets the name of the repository folder name in an MVS location

Returns:

the repository name

isOverwritePersistentServiceLocation

public boolean isOverwritePersistentServiceLocation()

Tells whether CONF_ENV_PERSIST_SERV_LOC should be overwritten by MVSConfig.CONF_SERVCE_LOCATION

Returns:

true if the persistent location should be overwritten

isRebuildIndex

public boolean isRebuildIndex()

Tells whether the MVS index should be rebuilt when it does not exist. Default is false.

Returns:

true if the index should be rebuilt.

isRepositoryLocation

public boolean isRepositoryLocation()

Tells whether the current MVS location refers to a repository or not. A repository contains only templates and no MVSuggest configuration file.

Returns:

true if the current MVS location is a repository

load

public void load(Configuration conf)

Description copied from class: MVSConfig

Loads the MVSuggest configuration from the job configuration

Overrides:

load in class MVSConfig

Parameters:

conf - a job configuration

setOverwritePersistentServiceLocation

public void setOverwritePersistentServiceLocation(boolean overwritePersistentServiceLocation)

Sets whether CONF_ENV_PERSIST_SERV_LOC should be overwritten by MVSConfig.CONF_SERVCE_LOCATION

Parameters:

overwritePersistentServiceLocation - true if the persistent location should be overwritten

setPersistentServiceLocation

public void setPersistentServiceLocation(java.lang.String persistentServiceLocation)

Sets the path where the MVS folder should be saved in HDFS.

Parameters:

persistentServiceLocation - an HDFS path or null if the MVS location is not saved in HDFS.

setRebuildIndex

public void setRebuildIndex(boolean rebuildIndex)

Sets whether the MVS index should be rebuilt when it does not exist. Default is false.

Parameters:

rebuildIndex - true if the index should be rebuilt

setRepositoryLocation

public void setRepositoryLocation(boolean repositoryLocation)

Sets whether the current MVS location refers to a repository or not. A repository contains only templates and no MVSuggest configuration file.

Parameters:

repositoryLocation - true if the current MVS location is a repository

setRepositoryName

public void setRepositoryName(java.lang.String repositoryName)

Sets the name of the repository folder name in an MVS location

Parameters:

repositoryName - the repository name

store

public void store(Configuration conf)

Description copied from class: MVSConfig

Saves the MVSuggest to the job configuration

Overrides:

store in class MVSConfig

Parameters:

conf - a job configuration