Package org.geotools.data.geoparquet

Class GeoParquetMetadata

Object

GeoParquetMetadata

Direct Known Subclasses:

GeoParquetMetadataV1_1_0, GeoParquetMetadataV1_2_0Dev

public abstract class GeoParquetMetadata
extends Object

Base class for GeoParquet metadata, representing the common structure of the "geo" metadata field in a GeoParquet file. This includes the version, primary geometry column, and column metadata. Subclasses define specific version constraints (e.g., 1.1.0, 1.2.0-dev).

The GeoParquet metadata is stored as a key-value metadata entry in the Parquet file, with the key "geo" and the value being a JSON string. This class and its subclasses provide the object mapping for that JSON data structure, following the GeoParquet specification.

Key components of the metadata include:

• Specification version (e.g., "1.1.0")
• Primary geometry column name
• Geometry encoding details
• Geometry types supported in each geometry column
• CRS information
• Bounding box data
• Optional covering information for spatial indexing

This implementation handles deserialization of the metadata and provides access to its various components, enabling optimized operations such as bounds calculation and schema detection.

See Also:

GeoParquet Metadata Specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeoParquetMetadata.BboxCovering	Represents the bounding box covering structure, mapping min/max coordinates to column names.
static class	GeoParquetMetadata.Covering	Represents the covering metadata for a geometry column.
static class	GeoParquetMetadata.Geometry	Represents the metadata for a geometry column in a GeoParquet file, including required encoding and geometry types, and optional attributes like bounding box, CRS, and edge type.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,GeoParquetMetadata.Geometry>	columns
protected String	primaryColumn
protected String	version

Constructor Summary

Constructors

Constructor	Description
GeoParquetMetadata()

Method Summary

Modifier and Type	Method	Description
Map<String,GeoParquetMetadata.Geometry>	getColumns()	Gets the column metadata, mapping column names to their geometry details.
String	getPrimaryColumn()	Gets the name of the primary geometry column.
String	getVersion()	Gets the GeoParquet specification version.
static GeoParquetMetadata	readValue(String geo)
void	setColumns(Map<String,GeoParquetMetadata.Geometry> columns)	Sets the column metadata (must contain at least one entry).
void	setPrimaryColumn(String primaryColumn)	Sets the name of the primary geometry column (must be non-empty).
void	setVersion(String version)	Sets the GeoParquet specification version.

Methods inherited from class Object

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

Field Detail

version

protected String version

primaryColumn

protected String primaryColumn

columns

protected Map<String,GeoParquetMetadata.Geometry> columns

Constructor Detail

GeoParquetMetadata

public GeoParquetMetadata()

Method Detail

readValue

public static GeoParquetMetadata readValue(String geo)
                                    throws IOException

Throws:

IOException

getVersion

public String getVersion()

Gets the GeoParquet specification version.

Returns:

the version string

setVersion

public void setVersion(String version)

Sets the GeoParquet specification version.

Parameters:

version - the version string

getPrimaryColumn

public String getPrimaryColumn()

Gets the name of the primary geometry column.

Returns:

the primary column name

setPrimaryColumn

public void setPrimaryColumn(String primaryColumn)

Sets the name of the primary geometry column (must be non-empty).

Parameters:

primaryColumn - the primary column name

getColumns

public Map<String,GeoParquetMetadata.Geometry> getColumns()

Gets the column metadata, mapping column names to their geometry details.

Returns:

a map of column names to geometry metadata

setColumns

public void setColumns(Map<String,GeoParquetMetadata.Geometry> columns)

Sets the column metadata (must contain at least one entry).

Parameters:

columns - a map of column names to geometry metadata