Package com.complexible.stardog.spatial

# Class GeospatialIndexMetadata

java.lang.Object
com.complexible.stardog.spatial.GeospatialIndexMetadata

public final class GeospatialIndexMetadata extends Object

Utility class for reading the metadata about a spatial index

Since:
  4.0
Version:
  4.0
Author:
  Michael Grove

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static final String`
  `INDEX_SUBDIR`
  The location of spatial index

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static Metadata`
  `read(Path theDir)`
  Read the index metadata from the given index directory
  `static void`
  `write(File theDir, Metadata theMeta)`
  Write the metadata to the given metadata file in the given directory

  ### Methods inherited from class java.lang.Object

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

- ## Field Details

  - ### INDEX_SUBDIR

    public static final String INDEX_SUBDIR
    The location of spatial index
    See Also:
      - Constant Field Values

- ## Method Details

  - ### read

    public static Metadata read(Path theDir) throws IOException
    Read the index metadata from the given index directory
    Parameters:
      `theDir` - the index directory to read from
    Returns:
      the metadata in the file
    Throws:
      `IOException` - if there was an error while reading

  - ### write

    public static void write(File theDir, Metadata theMeta) throws IOException
    Write the metadata to the given metadata file in the given directory
    Parameters:
      `theDir` - the index directory to save the metadata information to
      `theMeta` - the metadata to write
    Throws:
      `IOException` - if there was an error while writing