oracle.spatial.hadoop.vector.util

Class SpatialIndexUtils

java.lang.Object

oracle.spatial.hadoop.vector.util.SpatialIndexUtils

public class SpatialIndexUtils
extends java.lang.Object

Contains convenient methods used internally by the vector API for generating and reading spatial index metadata

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.hadoop.fs.Path	SPATIAL_INDEX_METADATA_DIR_PATH Default metadata directory path

Constructor Summary

Constructors

Constructor and Description
SpatialIndexUtils()

Method Summary

Modifier and Type	Method and Description
static SpatialIndexMetadata	findSpatialIndexMetadata(java.lang.String indexName, org.apache.hadoop.fs.Path metadataDirPath, org.apache.hadoop.conf.Configuration conf) Searches the metadata file for the given index name
static SpatialIndexMetadata	getSpatialIndexMetadata(java.lang.String indexName, java.lang.String indexMetadataDir, org.apache.hadoop.conf.Configuration conf)
static org.apache.hadoop.fs.Path	getSpatialIndexPath(SpatialIndexMetadata sim)
static boolean	isValidIndexName(java.lang.String indexName) Tells whether the given string is a valid index name
static java.util.List<org.apache.hadoop.fs.Path>	listMetadataFiles(org.apache.hadoop.conf.Configuration conf) Lists the paths to all the spatial index metadata files contained in the currently set metadata folder
static java.util.List<org.apache.hadoop.fs.Path>	listMetadataFiles(org.apache.hadoop.fs.Path metadataDirPath, org.apache.hadoop.conf.Configuration conf) Lists the paths to all the spatial index metadata files contained in the given metadata filder
static SpatialIndexMetadata	readMetadata(java.io.InputStream in) Reads a spatial index metadata from an input stream
static SpatialIndexMetadata	readMetadata(org.apache.hadoop.fs.Path simPath, org.apache.hadoop.conf.Configuration conf)
static void	setMissingSpatialConfig(SpatialConfig spatialConfig, SpatialIndexMetadata sim)
static java.lang.String	toValidIndexName(java.lang.String indexName) Converts an index name to a valid one
static void	validateIndexName(java.lang.String indexName) If the given index name is invalid, it will throw an IllegalArgumentException, otherwise it will do nothing

Methods inherited from class java.lang.Object

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

Field Detail

SPATIAL_INDEX_METADATA_DIR_PATH

public static final org.apache.hadoop.fs.Path SPATIAL_INDEX_METADATA_DIR_PATH

Default metadata directory path

Constructor Detail

SpatialIndexUtils

public SpatialIndexUtils()

Method Detail

readMetadata

public static SpatialIndexMetadata readMetadata(org.apache.hadoop.fs.Path simPath,
                                                org.apache.hadoop.conf.Configuration conf)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

readMetadata

public static SpatialIndexMetadata readMetadata(java.io.InputStream in)
                                         throws java.lang.Exception

Reads a spatial index metadata from an input stream

Parameters:

in -

Returns:

an in-memory representation of a spatial index metadata

Throws:

java.lang.Exception

listMetadataFiles

public static java.util.List<org.apache.hadoop.fs.Path> listMetadataFiles(org.apache.hadoop.conf.Configuration conf)
                                                                   throws java.io.IOException

Lists the paths to all the spatial index metadata files contained in the currently set metadata folder

Parameters:

conf - the job configuration

Returns:

a list of metadata file paths

Throws:

java.io.IOException

listMetadataFiles

public static java.util.List<org.apache.hadoop.fs.Path> listMetadataFiles(org.apache.hadoop.fs.Path metadataDirPath,
                                                                          org.apache.hadoop.conf.Configuration conf)
                                                                   throws java.io.IOException

Lists the paths to all the spatial index metadata files contained in the given metadata filder

Parameters:

metadataDirPath - a metadata directory path

conf - the job configuration

Returns:

a list of metadata file paths

Throws:

java.io.IOException

findSpatialIndexMetadata

public static SpatialIndexMetadata findSpatialIndexMetadata(java.lang.String indexName,
                                                            org.apache.hadoop.fs.Path metadataDirPath,
                                                            org.apache.hadoop.conf.Configuration conf)
                                                     throws java.lang.Exception

Searches the metadata file for the given index name

Parameters:

indexName - a spatial index name

metadataDirPath - the metadata directory

conf - the job configuration

Returns:

the spatial index metadata bean if the metadata was found or null

Throws:

java.lang.Exception

isValidIndexName

public static boolean isValidIndexName(java.lang.String indexName)

Tells whether the given string is a valid index name

Parameters:

indexName - an index name to be validated

Returns:

validateIndexName

public static void validateIndexName(java.lang.String indexName)
                              throws java.lang.IllegalArgumentException

If the given index name is invalid, it will throw an IllegalArgumentException, otherwise it will do nothing

Parameters:

indexName - an index name to be validated

Throws:

java.lang.IllegalArgumentException

toValidIndexName

public static java.lang.String toValidIndexName(java.lang.String indexName)

Converts an index name to a valid one

Parameters:

indexName - an index name

Returns:

getSpatialIndexMetadata

public static SpatialIndexMetadata getSpatialIndexMetadata(java.lang.String indexName,
                                                           java.lang.String indexMetadataDir,
                                                           org.apache.hadoop.conf.Configuration conf)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

getSpatialIndexPath

public static org.apache.hadoop.fs.Path getSpatialIndexPath(SpatialIndexMetadata sim)

setMissingSpatialConfig

public static void setMissingSpatialConfig(SpatialConfig spatialConfig,
                                           SpatialIndexMetadata sim)