public class SpatialIndexUtils
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SPATIAL_INDEX_METADATA_DIR
Default metadata directory path
|
static Path |
SPATIAL_INDEX_METADATA_DIR_PATH |
Constructor and Description |
---|
SpatialIndexUtils() |
Modifier and Type | Method and Description |
---|---|
static SpatialIndexMetadata |
findSpatialIndexMetadata(java.lang.String indexName, Path metadataDirPath, Configuration conf)
Searches the metadata file for the given index name
|
static SpatialIndexMetadata |
getSpatialIndexMetadata(java.lang.String indexName, java.lang.String indexMetadataDir, Configuration conf) |
static 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<Path> |
listMetadataFiles(Configuration conf)
Lists the paths to all the spatial index metadata files contained in the currently set metadata folder
|
static java.util.List<Path> |
listMetadataFiles(Path metadataDirPath, 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(Path simPath, Configuration conf) |
static boolean |
removeSpatialIndex(java.lang.String indexName, java.lang.String indexMetadataDir, boolean removeIndexFiles) |
static boolean |
removeSpatialIndex(java.lang.String indexName, java.lang.String indexMetadataDir, boolean removeIndexFiles, Configuration config) |
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 |
public static final java.lang.String SPATIAL_INDEX_METADATA_DIR
public static final Path SPATIAL_INDEX_METADATA_DIR_PATH
public static SpatialIndexMetadata findSpatialIndexMetadata(java.lang.String indexName, Path metadataDirPath, Configuration conf) throws java.lang.Exception
indexName
- a spatial index namemetadataDirPath
- the metadata directoryconf
- the job configurationjava.lang.Exception
public static SpatialIndexMetadata getSpatialIndexMetadata(java.lang.String indexName, java.lang.String indexMetadataDir, Configuration conf) throws java.lang.Exception
java.lang.Exception
public static Path getSpatialIndexPath(SpatialIndexMetadata sim)
public static boolean isValidIndexName(java.lang.String indexName)
indexName
- an index name to be validatedpublic static java.util.List<Path> listMetadataFiles(Configuration conf) throws java.io.IOException
conf
- the job configurationjava.io.IOException
public static java.util.List<Path> listMetadataFiles(Path metadataDirPath, Configuration conf) throws java.io.IOException
metadataDirPath
- a metadata directory pathconf
- the job configurationjava.io.IOException
public static SpatialIndexMetadata readMetadata(java.io.InputStream in) throws java.lang.Exception
in
-java.lang.Exception
public static SpatialIndexMetadata readMetadata(Path simPath, Configuration conf) throws java.lang.Exception
java.lang.Exception
public static boolean removeSpatialIndex(java.lang.String indexName, java.lang.String indexMetadataDir, boolean removeIndexFiles) throws java.lang.Exception
java.lang.Exception
public static boolean removeSpatialIndex(java.lang.String indexName, java.lang.String indexMetadataDir, boolean removeIndexFiles, Configuration config) throws java.lang.Exception
java.lang.Exception
public static void setMissingSpatialConfig(SpatialConfig spatialConfig, SpatialIndexMetadata sim)
public static java.lang.String toValidIndexName(java.lang.String indexName)
indexName
- an index namepublic static void validateIndexName(java.lang.String indexName) throws java.lang.IllegalArgumentException
IllegalArgumentException
, otherwise it will do nothingindexName
- an index name to be validatedjava.lang.IllegalArgumentException
Copyright © 2017, 2019 Oracle and/or its affiliates. All Rights Reserved.