opengis-utils-for-java

---

name: opengis-utils-for-java description: "Use when needing common GIS utility functions in Java — CRS utilities, geometry helpers, format converters, spatial validation. OpenGIS Utils for Java: convenience toolkit for Java GIS projects." tags:

• java
• gis
• geotools
• jts
• gdal
• geometry
• vector
• crs
• cgcs2000

---

项目地址： https://github.com/znlgis/opengis-utils-for-java

官方文档： https://github.com/znlgis/opengis-utils-for-java#readme

Maven 坐标： com.znlgis.ogu4j:ogu4j:1.0.0

许可证： LGPL-2.1-or-later

概述

OGU4J (OpenGIS Utils for Java) is a unified Java GIS toolkit built on GeoTools, JTS, GDAL/OGR, and ESRI Geometry API. It provides:

• A unified layer model (OguLayer) for reading/writing GIS data across formats
• Geometry operations (60+ methods) via GeometryUtil
• Dual-engine architecture (GeoTools pure-Java & GDAL native)
• Coordinate reference system management (CGCS2000 built-in)

Java Version: 17+
Build Tool: Maven
Group ID: com.znlgis.ogu4j | Artifact ID: ogu4j | Version: 1.0.0

---

Project Structure

com.znlgis.ogu4j
├── datasource/                  # High-level data I/O
│   ├── OguLayerUtil             # ★ Primary entry point for reading/writing layers
│   └── GtTxtUtil                # National land TXT format support
├── engine/                      # GIS engine core
│   ├── GisEngine                # Engine interface
│   ├── GisEngineFactory         # Engine factory (auto-selects best engine)
│   ├── GeoToolsEngine           # GeoTools implementation (pure Java, always available)
│   ├── GdalEngine               # GDAL implementation (requires native GDAL)
│   ├── GeoToolsLayerReader/Writer  # GeoTools format I/O
│   ├── GdalLayerReader/Writer      # GDAL format I/O
│   ├── enums/                   # Enumerations
│   │   ├── DataFormatType       # SHP, GEOJSON, FILEGDB, POSTGIS, TXT, WKT, ESRIJSON, ARCSDE
│   │   ├── FieldDataType        # INTEGER, DOUBLE, STRING, BINARY, DATE, TIME, DATETIME, LONG
│   │   ├── GeometryType         # POINT, MULTIPOINT, LINESTRING, POLYGON, etc.
│   │   ├── GisEngineType        # GEOTOOLS, GDAL, AUTO
│   │   └── TopologyValidationErrorType
│   ├── io/                      # Reader/Writer interfaces
│   │   ├── LayerReader          # read(path, layerName, attributeFilter, spatialFilterWkt)
│   │   └── LayerWriter          # write(layer, path, layerName, options)
│   ├── model/
│   │   ├── layer/               # ★ Core data model
│   │   │   ├── OguLayer         # Layer: name, wkid, geometryType, fields, features
│   │   │   ├── OguFeature       # Feature: id, geometry (WKT), attributes
│   │   │   ├── OguField         # Field definition: name, alias, dataType, length
│   │   │   ├── OguFieldValue    # Field value with type conversion methods
│   │   │   ├── OguCoordinate    # Coordinate point (x, y, z)
│   │   │   ├── OguFeatureFilter # Functional interface for filtering
│   │   │   └── OguLayerMetadata # Extended metadata (CRS, projection, etc.)
│   │   ├── DbConnBaseModel      # PostGIS connection configuration
│   │   ├── GdbGroupModel        # FileGDB structure
│   │   ├── TopologyValidationResult
│   │   └── SimpleGeometryResult
│   └── util/
│       ├── CrsUtil              # Coordinate system management & transformation
│       ├── GeotoolsUtil         # GeoTools feature filtering
│       ├── OgrUtil              # GDAL/OGR initialization & resource management
│       ├── PostgisUtil          # PostGIS connection helpers
│       ├── ShpUtil              # Shapefile encoding & field name handling
│       └── GdalCmdUtil          # GDAL command-line wrapper (ogrinfo)
├── geometry/
│   └── GeometryUtil             # ★ 60+ geometry operation methods
├── exception/
│   ├── OguException             # Base checked exception
│   ├── DataSourceException      # Data source connection failures
│   ├── EngineNotSupportedException
│   ├── FormatParseException     # Format parsing failures
│   ├── LayerValidationException # Unchecked (RuntimeException)
│   └── TopologyException
└── utils/
    ├── ZipUtil                  # ZIP compress/decompress
    ├── EncodingUtil             # File encoding detection
    ├── SortUtil                 # Natural string sorting
    └── NumUtil                  # Number formatting (remove scientific notation)

---

常见任务快速参考（Quick Reference: Common Tasks）完整内容见 reference/common-tasks.md

Data Format Support Matrix

Format	DataFormatType	GeoTools	GDAL	Read	Write	Notes
Shapefile	SHP	✅	✅	✅	✅	Field names limited to 10 chars
GeoJSON	GEOJSON	✅	✅	✅	✅
FileGDB	FILEGDB	❌	✅	✅	✅	Requires GDAL native library
PostGIS	POSTGIS	✅	✅	✅	✅	Connection string as path
National Land TXT	TXT	✅	❌	✅	✅	Use GtTxtUtil directly
WKT	WKT	✅	❌	✅	❌	Geometry-only format
ESRI JSON	ESRIJSON	❌	❌	✅*	❌	*Via GeometryUtil conversion

---

Data Model Reference

OguLayer (Core)

Property	Type	Description
name	String	Layer name
alias	String	Layer display name
wkid	Integer	EPSG code (e.g. 4490 for CGCS2000)
geometryType	GeometryType	POINT, POLYGON, LINESTRING, etc.
tolerance	Double	Geometric tolerance
fields	List<OguField>	Field definitions
features	List<OguFeature>	Feature collection
metadata	OguLayerMetadata	Extended metadata

Methods: fromJSON(String), toJSON(), validate(), filter(OguFeatureFilter), getFeatureCount(), getFieldCount()

OguFeature

Property	Type	Description
id	String	Feature identifier
geometry	String	Geometry in WKT format
attributes	List<OguFieldValue>	Attribute values
coordinates	List<OguCoordinate>	Coordinate points (TXT format)
rawValues	List<String>	Raw values (TXT format)

Methods: getAttribute(String fieldName), getValue(String fieldName), setValue(String fieldName, Object value)

OguField

Property	Type	Description
name	String	Field name
alias	String	Display name
description	String	Description
dataType	FieldDataType	INTEGER, DOUBLE, STRING, DATE, etc.
length	Integer	Max length (for STRING)
nullable	Boolean	Nullable flag
defaultValue	Object	Default value

Constructors: OguField(name, alias, dataType), OguField(name, alias, description, dataType)

OguFieldValue

Property	Type	Description
field	OguField	Field definition
value	Object	Raw value

Methods: getFieldName(), getStringValue(), getIntValue(), getDoubleValue()

OguCoordinate

Property	Type	Description
x	Double	X coordinate (longitude)
y	Double	Y coordinate (latitude)
z	Double	Z coordinate (elevation, optional)
pointNumber	String	Point identifier
ringNumber	Integer	Ring/loop number

Constructors: OguCoordinate(x, y), OguCoordinate(x, y, z)

DbConnBaseModel (PostGIS connection)

Property	Type	Description
dbType	String	Database type
host	String	Host address
port	String	Port number
schema	String	Schema name
database	String	Database name
user	String	Username
passwd	String	Password

---

Enumerations Quick Reference

GeometryType

POINT, MULTIPOINT, LINESTRING, LINEARRING, MULTILINESTRING, POLYGON, MULTIPOLYGON, GEOMETRYCOLLECTION

Lookup methods: valueOfByTypeName(String), valueOfByTypeCode(int), valueOfByTypeClass(Class<?>), valueOfByWkbGeometryType(int)

FieldDataType

INTEGER, DOUBLE, STRING, BINARY, DATE, TIME, DATETIME, LONG

Lookup methods: fieldDataTypeByGdalCode(int), fieldDataTypeByTypeClass(Class<?>)

DataFormatType

WKT, GEOJSON, ESRIJSON, SHP, TXT, FILEGDB, POSTGIS, ARCSDE

Properties per value: desc (description), gdalDriverName (GDAL driver name)

GisEngineType

GEOTOOLS, GDAL, AUTO

---

Exception Hierarchy

Exception
└── OguException                      # Base checked exception
    ├── DataSourceException           # Data source connection/access failure
    ├── EngineNotSupportedException   # Engine doesn't support the operation/format
    ├── FormatParseException          # Data format parsing failure
    └── TopologyException             # Geometry topology error

RuntimeException
└── LayerValidationException          # Layer data validation failure (unchecked)

---

Architecture & Design Patterns

• Factory Pattern: GisEngineFactory creates engine instances; use GisEngineType.AUTO for automatic selection (prefers GDAL if available)
• Strategy Pattern: LayerReader / LayerWriter interfaces define pluggable format-specific I/O strategies
• Adapter Pattern: GisEngine provides a unified API over GeoTools and GDAL
• Functional Interface: OguFeatureFilter enables lambda-based feature filtering
• Geometry is WKT: Features store geometry as WKT strings in OguFeature.geometry; use GeometryUtil for conversion/operations

---

AI 使用建议

推荐工作流

1. 选择引擎：GisEngineType.AUTO 自动选择最优引擎（GDAL 优先）
2. 读取数据：使用 OguLayerUtil.readLayer() 统一入口读取各类矢量格式
3. 空间分析：JTS Geometry 对象用 GeometryUtil（60+ 方法），WKT 字符串用 *Wkt 后缀方法
4. 坐标转换：使用 CrsUtil.transform() 进行 CGCS2000 系列坐标系变换
5. 写出结果：使用 OguLayerUtil.writeLayer() 写出为目标格式

关键注意事项

• 始终使用 OguLayerUtil 作为主入口：自动处理引擎选择和格式路由
• 几何以 WKT 存储：OguFeature.geometry 存储 WKT 字符串；空间运算时转为 JTS Geometry
• 引擎选择：GEOTOOLS（纯 Java，无原生依赖）vs GDAL（需本地库，支持 FileGDB）
• CGCS2000 坐标系：EPSG:4490 为默认地理 CRS，投影 CRS 范围 EPSG:4502-4554
• Shapefile 字段名限 10 字符：使用 ShpUtil.formatFieldName() 自动截断
• 资源释放：DataStore 和 OGR DataSource 必须在 finally 块中释放

Important Notes for AI Developers

1. Always use OguLayerUtil as the primary entry point for reading/writing GIS data. It handles engine selection and format routing.

2. Geometry in features is stored as WKT strings. Convert to JTS Geometry objects via GeometryUtil.wkt2Geometry() when you need spatial operations.

3. Engine selection:

   • GisEngineType.AUTO — library auto-selects (prefers GDAL if available)
   • GisEngineType.GEOTOOLS — pure Java, always available, no native dependencies
   • GisEngineType.GDAL — requires native GDAL library installed; needed for FileGDB format

4. CGCS2000 coordinate system (EPSG:4490) is the default/primary CRS. Projected CRS range: EPSG 4502-4554 (3-degree zones). Use CrsUtil for transformation.

5. PostGIS connection strings follow the format: "PG: host=<host> port=<port> dbname=<db> user=<user> password=<pwd> active_schema=<schema>"

6. Resource management:

   • DataStore objects (ShapefileDataStore, JDBCDataStore) must be disposed in finally blocks
   • OGR DataSource objects must be closed via OgrUtil.closeDataSource()

7. Shapefile field names are limited to 10 characters. Use ShpUtil.formatFieldName() to auto-truncate.

8. OguLayer can be serialized to/from JSON using layer.toJSON() and OguLayer.fromJSON(json) (backed by FastJSON2).

9. Attribute filtering uses CQL expression syntax (e.g., "population > 1000000 AND name LIKE '%京%'").

10. Spatial filtering accepts WKT geometry strings (e.g., "POLYGON((115 39, 117 39, 117 41, 115 41, 115 39))").

11. Two geometry operation styles:

    • JTS-based: Pass Geometry objects, get Geometry back (e.g., GeometryUtil.buffer(geom, dist))
    • WKT-based (suffix Wkt): Pass WKT strings and WKID, get WKT back (e.g., GeometryUtil.bufferWkt(wkt, wkid, dist))

12. Build with Maven: mvn compile — requires the OSGeo repository for GeoTools dependencies:

    <repository>
        <id>osgeo</id>
        <url>https://repo.osgeo.org/repository/release/</url>
    </repository>
    

---

相关技能

• geotools — Java GIS 工具库：../geotools/SKILL.md
• jts — JTS Topology Suite：../jts/SKILL.md
• geometry-api-java — Esri Geometry API：../geometry-api-java/SKILL.md
• gdal — 命令行数据处理：../gdal/SKILL.md
• gdal-api — GDAL 编程 API：../gdal-api/SKILL.md

Typical Workflow Example

import com.znlgis.ogu4j.datasource.OguLayerUtil;
import com.znlgis.ogu4j.engine.enums.*;
import com.znlgis.ogu4j.engine.model.layer.*;
import com.znlgis.ogu4j.engine.util.CrsUtil;
import com.znlgis.ogu4j.geometry.GeometryUtil;
import org.locationtech.jts.geom.Geometry;

// Step 1: Read a Shapefile
OguLayer layer = OguLayerUtil.readLayer(
    DataFormatType.SHP, "/data/parcels.shp",
    null, null, null, GisEngineType.AUTO
);

// Step 2: Filter features by area > 10,000 square units
List<OguFeature> largeParcels = layer.filter(f -> {
    Geometry geom = GeometryUtil.wkt2Geometry(f.getGeometry());
    return GeometryUtil.area(geom) > 10000;
});

// Step 3: Buffer each geometry
for (OguFeature f : largeParcels) {
    Geometry geom = GeometryUtil.wkt2Geometry(f.getGeometry());
    Geometry buffered = GeometryUtil.buffer(geom, 50.0);
    f.setGeometry(GeometryUtil.geometry2Wkt(buffered));
}

// Step 4: Reproject to projected CRS
OguLayer projected = CrsUtil.reproject(layer, 4528);

// Step 5: Export to GeoJSON
OguLayerUtil.writeLayer(
    DataFormatType.GEOJSON, projected,
    "/data/output.geojson", null, null, GisEngineType.AUTO
);