Class GeospatialIndexMetadata


  • public final class GeospatialIndexMetadata
    extends java.lang.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 java.lang.String INDEX_SUBDIR
      The location of spatial index
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Metadata read​(java.nio.file.Path theDir)
      Read the index metadata from the given index directory
      static void write​(java.io.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 Detail

      • INDEX_SUBDIR

        public static final java.lang.String INDEX_SUBDIR
        The location of spatial index
        See Also:
        Constant Field Values
    • Method Detail

      • read

        public static Metadata read​(java.nio.file.Path theDir)
                             throws java.io.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:
        java.io.IOException - if there was an error while reading
      • write

        public static void write​(java.io.File theDir,
                                 Metadata theMeta)
                          throws java.io.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:
        java.io.IOException - if there was an error while writing