Spatial

Introduction

Ricardo Stuven — Wed, 06 Oct 2010 18:51:41 GMT

Current revision posted to Spatial by Ricardo Stuven on 06/10/2010 03:51:41 p.m.

Introduction

NHibernate.Spatial, spatial extensions for NHibernate, allows you to connect NHibernate to a spatially enabled database and manipulate geometries in HQL or in .NET code using NetTopologySuite, providing you with a fully integrated GIS programming experience.

There is also a similar but independent effort for Java: Hibernate Spatial.

Features:

Geometry types: Geometry columns are mapped to .NET geometry types compliant with OGC specifications.
Dialects: MsSqlSpatial, PostGIS MySQL and SQL Server 2008 are supported. The most common spatial functions are registered for use within HQL, providing compatible queries among different dialects.
Criteria: Spatial relations functions such as Intersects, Within, Crosses, etc.
Projections: Spatial aggregate, analysis and tranformation functions.
Schema generation: Support for automatic creation and droping of auxiliary data objects (eg. registering of geometry columns in metadata table).
Metadata mappings: Built-in mappings to spatial metadata through GeometryColumns and SpatialReferenceSystem classes.

Requirements:

.NET 2.0
NHibernate 2.0.1.GA2.1.2.GA

Installation:

Download latest sources and build. Copy the binaries to your project's libraries folder.
In you project, add references to NHibernate.dll, NHibernate.Spatial.dll, NetTopologySuite.dll, GeoAPI.dll and to provider assembly (eg. NHibernate.Spatial.PostGis.dll).

Introduction

Ricardo Stuven — Wed, 08 Oct 2008 17:20:48 GMT

Revision 5 posted to Spatial by Ricardo Stuven on 08/10/2008 02:20:48 p.m.

Introduction

Features:

Geometry types: Geometry columns are mapped to .NET geometry types compliant with OGC specifications.
Dialects: MsSqlSpatial, PostGIS MySQL and SQL Server 2008 are supported. The most common spatial functions are registered for use within HQL, providing compatible queries among different dialects.
Criteria: Spatial relations functions such as Intersects, Within, Crosses, etc.
Projections: Spatial aggregate, analysis and tranformation functions.
Schema generation: Support for automatic creation and droping of auxiliary data objects (eg. registering of geometry columns in metadata table).
Metadata mappings: Built-in mappings to spatial metadata through GeometryColumns and SpatialReferenceSystem classes.

Requirements:

.NET 2.0
NHibernate 2.0.1.GA

Installation:

Download latest sources and build. Copy the binaries to your project's libraries folder.
In you project, add references to NHibernate.dll, NHibernate.Spatial.dll, NetTopologySuite.dll, GeoAPI.dll and to provider assembly (eg. NHibernate.Spatial.PostGis.dll).

Introduction

Ricardo Stuven — Wed, 08 Oct 2008 13:56:04 GMT

Revision 4 posted to Spatial by Ricardo Stuven on 08/10/2008 10:56:04 a.m.

Introduction

Features:

Geometry types: Geometry columns are mapped to .NET geometry types compliant with OGC specifications.
Dialects: MsSqlSpatial, PostGIS MySQL and SQL Server 2008 are supported. The most common spatial functions are registered for use within HQL, providing compatible queries among different dialects.
Criteria: Spatial relations functions such as Intersects, Within, Crosses, etc.
Projections: Spatial aggregate, analysis and tranformation functions.
Schema generation: Support for automatic creation and droping of auxiliary data objects (eg. registering of geometry columns in metadata table).
Metadata mappings: Built-in mappings to spatial metadata through GeometryColumns and SpatialReferenceSystem classes.

Requirements:

.NET 2.0
NHibernate 2.0.1.GA

Installation:

Download latest sources and build. Copy the binaries to your project's libraries folder.
In you project, add references to NHibernate.dll, NHibernate.Spatial.dll, NetTopologySuite.dll, GeoAPI.dll and to provider assembly (eg. NHibernate.Spatial.PostGis.dll).

Introduction

Ricardo Stuven — Wed, 01 Oct 2008 03:09:08 GMT

Revision 3 posted to Spatial by Ricardo Stuven on 01/10/2008 12:09:08 a.m.

Introduction

Features:

Geometry types: Geometry columns are mapped to .NET geometry types compliant with OGC specifications.
Dialects: MsSqlSpatial, PostGIS and SQL Server 2008 are supported. The most common spatial functions are registered for use within HQL, providing compatible queries among different dialects.
Criteria: Spatial relations functions such as Intersects, Within, Crosses, etc.
Projections: Spatial aggregate, analysis and tranformation functions.
Schema generation: Support for automatic creation and droping of auxiliary data objects (eg. registering of geometry columns in metadata table).
Metadata mappings: Built-in mappings to spatial metadata through GeometryColumns and SpatialReferenceSystem classes.

Requirements:

.NET 2.0
NHibernate 2.0.12.0.1.GA

Installation:

Download latest sources and build. Copy the binaries to your project's libraries folder.
In you project, add references to NHibernate.dll, NHibernate.Spatial.dll, NetTopologySuite.dll, GeoAPI.dll and to provider assembly (eg. NHibernate.Spatial.PostGis.dll).

Introduction

Ricardo Stuven — Fri, 26 Sep 2008 22:05:59 GMT

Revision 2 posted to Spatial by Ricardo Stuven on 26/09/2008 07:05:59 p.m.

Introduction

Features:

Geometry types: Geometry columns are mapped to .NET geometry types compliant with OGCspecificationsOGC specifications.
Dialects: MsSqlSpatial, PostGIS and SQL Server 2008 are supported. The most common spatial functions are registered for use within HQL, providing compatible queries among different dialects.
Criteria: Spatial relations functions such as Intersects, Within, Crosses, etc.
Projections: Spatial aggregate, analysis and tranformation functions.
Schema generation: Support for automatic creation and droping of auxiliary data objects (eg. registering of geometry columns in metadata table).
Metadata mappings: Built-in mappings to spatial metadata through GeometryColumns and SpatialReferenceSystem classes.

Requirements:

.NET 2.0
NHibernate 2.0.1

Installation:

Download latest sources and build. Copy the binaries to your project's libraries folder.
In you project, add references to NHibernate.dll, NHibernate.Spatial.dll, NetTopologySuite.dll, GeoAPI.dll and to provider assembly (eg. NHibernate.Spatial.PostGis.dll).

Introduction

Ricardo Stuven — Fri, 26 Sep 2008 21:23:13 GMT

Revision 1 posted to Spatial by Ricardo Stuven on 26/09/2008 06:23:13 p.m.

Features:

Geometry types: Geometry columns are mapped to .NET geometry types compliant with OGCspecifications.
Dialects: MsSqlSpatial, PostGIS and SQL Server 2008 are supported. The most common spatial functions are registered for use within HQL, providing compatible queries among different dialects.
Criteria: Spatial relations functions such as Intersects, Within, Crosses, etc.
Projections: Spatial aggregate, analysis and tranformation functions.
Schema generation: Support for automatic creation and droping of auxiliary data objects (eg. registering of geometry columns in metadata table).
Metadata mappings: Built-in mappings to spatial metadata through GeometryColumns and SpatialReferenceSystem classes.

Requirements:

.NET 2.0
NHibernate 2.0.1

Installation:

Download latest sources and build. Copy the binaries to your project's libraries folder.
In you project, add references to NHibernate.dll, NHibernate.Spatial.dll, NetTopologySuite.dll, GeoAPI.dll and to provider assembly (eg. NHibernate.Spatial.PostGis.dll).

Configuration and mapping

Ricardo Stuven — Tue, 21 Jul 2009 20:50:35 GMT

Current revision posted to Spatial by Ricardo Stuven on 21/07/2009 05:50:35 p.m.

Configuration and mapping

Dialect Configuration:

In the NHibernate section of your configuration file add the following entry:

<property name="dialect">NHibernate.Spatial.Dialect.SomeSpatialDialect,SomeSpatialAssembly</property>

If you're using Castle ActiveRecord, the entry will look like this:

<add key="dialect" value="NHibernate.Spatial.Dialect.SomeSpatialDialect,SomeSpatialAssembly" />

Replace SomeSpatialDialect by the spatial dialect to be used (eg. MsSql2008SpatialDialect.) and SomeSpatialAssembly by the assembly name where it is located (eg. NHibernate.Spatial.MsSql2008)

Schema Generation Configuration:

Declarative: Use of <database-object> element is not supported.

Programmatic:

Configuration cfg = new Configuration();
    // Your configuration code (eg. cfg.Configure(); )
    cfg.AddAuxiliaryDatabaseObject(new SpatialAuxiliaryDatabaseObject(cfg));

Then you can use a SchemaExport object or the hibernate.hbm2ddl.auto configuration property for schema generation.

ActiveRecord Schema Generation Configuration:

You will need to add the SpatialAuxiliaryDatabaseObject in the Application_OnStart:

 using NHibernate.Cfg;
 using NHibernate.Spatial.Mapping;

 public void Application_OnStart()
 {
    foreach (Configuration cfg in ActiveRecordMediator.GetSessionFactoryHolder().GetAllConfigurations())
    {
        cfg.AddAuxiliaryDatabaseObject(new SpatialAuxiliaryDatabaseObject(cfg));
        Metadata.AddMapping(cfg, MetadataClass.GeometryColumn);
        Metadata.AddMapping(cfg, MetadataClass.SpatialReferenceSystem);
    }
 }

You can then generate the database schema in the usual way.

Metadata Mappings Configuration:

There are two classes available for metadata mapping in the NHibernate.Spatial.Metadata namespace: GeometryColumn and SpatialReferenceSystem. You can add them selectively:

Configuration cfg = new Configuration();
// Your configuration code (eg. cfg.Configure(); )
Metadata.AddMapping(cfg, MetadataClass.GeometryColumn);
Metadata.AddMapping(cfg, MetadataClass.SpatialReferenceSystem);

Then you can use them as normal mapped classes. For example, you could execute the following HQL query:

select srs.WellKnownText from SpatialReferenceSystem as srs where srs.SRID=4326

WARNING: DO NOT add metadata class mappings when using the SchemaExport utility. You could lose all contents of metadata tables.

NHibernate Mapping:

In the XML mappings file, map all properties as usual but for geometry columns use the following entry:

<property name="Geometry" column="the_geom" type="NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial" />

Optionally, for schema generation and default values setting, you can use type parameters. The available parameters are srid and subtype. For example:

<property name="Geometry" column="the_geom">
    <type name="NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial">
        <param name="srid">4326</param>
        <param name="subtype">POLYGON</param>
    </type>
</property>

In the mapped class, declare the corresponding property:

private GeoAPI.Geometries.IGeometry _geometry; 
public virtual GeoAPI.Geometries.IGeometry Geometry
{
	get
	{
		return this._geometry;
	}
	set
	{
		this._geometry = value;
	}
}

ActiveRecord Mapping:

private GeoAPI.Geometries.IGeometry _geometry; 
         
[Property("the_geom", ColumnType = "NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial")]
public virtual GeoAPI.Geometries.IGeometry Geometry
{
	get
	{
		return this._geometry;
	}
	set
	{
		this._geometry = value;
	}
}

NOTE: Type parameters (see NHibernate mapping above) are not supported in ActiveRecord.

ActiveWriter Mapping:

ActiveWriter is a tool to visually model entities and relationships, and generate ActiveRecord classes or NHibernate mapping files. Since Preview 3, it supports custom types, so we can use the GeometryType / IGeometry pair..

Example usage:

Drag & drop a MsSqlSpatial table from Server Explorer/Data connections.
In the model, select "the_geom" property.
In the properties window, enter the following values:

</tbody>

Property	Value
Column Type	Custom
Custom Column Type	NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial
Custom Member Type	GeoAPI.Geometries.IGeometry

NOTE: Type parameters (see NHibernate mapping above) are not supported in ActiveRecord, so it is in ActiveWriter.

Configuration and mapping

oharab — Thu, 27 Nov 2008 14:33:13 GMT

Revision 5 posted to Spatial by oharab on 27/11/2008 11:33:13 a.m.

Configuration and mapping

Dialect Configuration:

In the NHibernate section of your configuration file add the following entry:

<property name="dialect">NHibernate.Spatial.Dialect.SomeSpatialDialect,SomeSpatialAssembly</property>

If you're using Castle ActiveRecord, the entry will look like this:

<add key="dialect" value="NHibernate.Spatial.Dialect.SomeSpatialDialect,SomeSpatialAssembly" />

Replace SomeSpatialDialect by the spatial dialect to be used (eg. MsSql2008SpatialDialect.) and SomeSpatialAssembly by the assembly name where it is located (eg. NHibernate.Spatial.MsSql2008)

Schema Generation Configuration:

Declarative: Use of <database-object> element is not supported.

Programmatic:

Configuration cfg = new Configuration();
    // Your configuration code (eg. cfg.Configure(); )
    cfg.AddAuxiliaryDatabaseObject(new SpatialAuxiliaryDatabaseObject(cfg));

Then you can use a SchemaExport object or the hibernate.hbm2ddl.auto configuration property for schema generation.

ActiveRecord Schema Generation Configuration:

You will need to add the SpatialAuxiliaryDatabaseObject in the Application_OnStart:

 using NHibernate.Cfg;
 using NHibernate.Spatial.Mapping;

 public void Application_OnStart()
 {
    foreach (Configuration cfg in ActiveRecordMediator.GetSessionFactoryHolder().GetAllConfigurations())
    {
        cfg.AddAuxiliaryDatabaseObject(new SpatialAuxiliaryDatabaseObject(cfg));
        Metadata.AddMapping(cfg, MetadataClass.GeometryColumn);
        Metadata.AddMapping(cfg, MetadataClass.SpatialReferenceSystem);
    }
 }

You can then generate the database schema in the usual way.

Metadata Mappings Configuration:

There are two classes available for metadata mapping in the NHibernate.Spatial.Metadata namespace: GeometryColumn and SpatialReferenceSystem. You can add them selectively:

Configuration cfg = new Configuration();
// Your configuration code (eg. cfg.Configure(); )
Metadata.AddMapping(cfg, MetadataClass.GeometryColumn);
Metadata.AddMapping(cfg, MetadataClass.SpatialReferenceSystem);

Then you can use them as normal mapped classes. For example, you could execute the following HQL query:

select srs.WellKnownText from SpatialReferenceSystem as srs where srs.SRID=4326

WARNING: DO NOT add metadata class mappings when using the SchemaExport utility. You could lose all contents of metadata tables.

NHibernate Mapping:

In the XML mappings file, map all properties as usual but for geometry columns use the following entry:

<property name="Geometry" column="the_geom" type="NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial" />

Optionally, for schema generation and default values setting, you can use type parameters. The available parameters are srid and subtype. For example:

<property name="Geometry" column="the_geom">
    <type name="NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial">
        <param name="srid">4326</param>
        <param name="subtype">POLYGON</param>
    </type>
</property>

In the mapped class, declare the corresponding property:

private GeoAPI.Geometries.IGeometry _geometry; 
public virtual GeoAPI.Geometries.IGeometry Geometry
{
	get
	{
		return this._geometry;
	}
	set
	{
		this._geometry = value;
	}
}

ActiveRecord Mapping:

private GeoAPI.Geometries.IGeometry _geometry; 
         
[Property("the_geom", ColumnType = "NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial")]
public virtual GeoAPI.Geometries.IGeometry Geometry
{
	get
	{
		return this._geometry;
	}
	set
	{
		this._geometry = value;
	}
}

NOTE: Type parameters (see NHibernate mapping above) are not supported in ActiveRecord.

ActiveWriter Mapping:

Drag & drop a MsSqlSpatial table from Server Explorer/Data connections.
In the model, select "the_geom" property.
In the properties window, enter the following values:

Property	Value
Column Type	Custom
Custom Column Type	NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial
Custom Member Type	GeoAPI.Geometries.IGeometry

NOTE: Type parameters (see NHibernate mapping above) are not supported in ActiveRecord, so it is in ActiveWriter.

Configuration and mapping

Ricardo Stuven — Wed, 08 Oct 2008 00:17:54 GMT

Revision 4 posted to Spatial by Ricardo Stuven on 07/10/2008 09:17:54 p.m.

Configuration and mapping

Dialect Configuration:

In the NHibernate section of your configuration file add the following entry:

<property name="hibernate.dialect">NHibernate.Spatial.Dialect.SomeSpatialDialect,NHibernate.Spatial</property>"dialect">NHibernate.Spatial.Dialect.SomeSpatialDialect,SomeSpatialAssembly</property>

If you're using Castle ActiveRecord, the entry will look like this:

<add key="hibernate.dialect" "dialect" value="NHibernate.Spatial.Dialect.SomeSpatialDialect,NHibernate.Spatial" "NHibernate.Spatial.Dialect.SomeSpatialDialect,SomeSpatialAssembly" />

Replace SomeSpatialDialect by the spatial dialect to be used . For example, MsSqlSpatialDialect(eg. MsSql2008SpatialDialect.) and SomeSpatialAssembly by the assembly name where it is located (eg. NHibernate.Spatial.MsSql2008)

Schema Generation Configuration:

Declarative: Use of <database-object> element is not supported.

Programmatic:

Configuration cfg = new Configuration();
    // Your configuration code (eg. cfg.Configure(); )
    cfg.AddAuxiliaryDatabaseObject(new SpatialAuxiliaryDatabaseObject(cfg));

Then you can use a SchemaExport object or the hibernate.hbm2ddl.auto configuration property for schema generation.

Metadata Mappings Configuration:

There are two classes available for metadata mapping in the NHibernate.Spatial.Metadata namespace: GeometryColumn and SpatialReferenceSystem. You can add them selectively:

Configuration cfg = new Configuration();
// Your configuration code (eg. cfg.Configure(); )
Metadata.AddMapping(cfg, MetadataClass.GeometryColumn);
Metadata.AddMapping(cfg, MetadataClass.SpatialReferenceSystem);

Then you can use them as normal mapped classes. For example, you could execute the following HQL query:

select srs.WellKnownText from SpatialReferenceSystem as srs where srs.SRID=4326

WARNING: DO NOT add metadata class mappings when using the SchemaExport utility. You could lose all contents of metadata tables.

NHibernate Mapping:

In the XML mappings file, map all properties as usual but for geometry columns use the following entry:

<property name="Geometry" column="the_geom" type="NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial" />

Optionally, for schema generation and default values setting, you can use type parameters. The available parameters are srid and subtype. For example:

<property name="Geometry" column="the_geom">
    <type name="NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial">
        <param name="srid">4326</param>
        <param name="subtype">POLYGON</param>
    </type>
</property>

In the mapped class, declare the corresponding property:

private GeoAPI.Geometries.IGeometry _geometry; 
public virtual GeoAPI.Geometries.IGeometry Geometry
{
	get
	{
		return this._geometry;
	}
	set
	{
		this._geometry = value;
	}
}

ActiveRecord Mapping:

private GeoAPI.Geometries.IGeometry _geometry; 
         
[Property("the_geom", ColumnType = "NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial")]
public virtual GeoAPI.Geometries.IGeometry Geometry
{
	get
	{
		return this._geometry;
	}
	set
	{
		this._geometry = value;
	}
}

NOTE: Type parameters (see NHibernate mapping above) are not supported in ActiveRecord.

ActiveWriter Mapping:

Drag & drop a MsSqlSpatial table from Server Explorer/Data connections.
In the model, select "the_geom" property.
In the properties window, enter the following values:

Property	Value
Column Type	Custom
Custom Column Type	NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial
Custom Member Type	GeoAPI.Geometries.IGeometry

NOTE: Type parameters (see NHibernate mapping above) are not supported in ActiveRecord, so it is in ActiveWriter.

Configuration and mapping

Ricardo Stuven — Fri, 26 Sep 2008 22:20:59 GMT

Revision 3 posted to Spatial by Ricardo Stuven on 26/09/2008 07:20:59 p.m.

Configuration and mapping

Dialect Configuration:

In the NHibernate section of your configuration file add the following entry:

<property name="hibernate.dialect">NHibernate.Spatial.Dialect.SomeSpatialDialect,NHibernate.Spatial</property>

If you're using Castle ActiveRecord, the entry will look like this:

<add key="hibernate.dialect" value="NHibernate.Spatial.Dialect.SomeSpatialDialect,NHibernate.Spatial" />

Replace SomeSpatialDialect by the spatial dialect to be used. For example, MsSqlSpatialDialect.

Schema Generation Configuration:

Declarative: Use of <database-object> element is not supported.

Programmatic:

Configuration cfg = new Configuration();
    // Your configuration code (eg. cfg.Configure(); )
    cfg.AddAuxiliaryDatabaseObject(new SpatialAuxiliaryDatabaseObject(cfg));

Then you can use a SchemaExport object or the hibernate.hbm2ddl.auto configuration property for schema generation.

Metadata Mappings Configuration:

There are two classes available for metadata mapping in the NHibernate.Spatial.Metadata namespace: GeometryColumn and SpatialReferenceSystem. You can add them selectively:

Configuration cfg = new Configuration();
// Your configuration code (eg. cfg.Configure(); )
Metadata.AddMapping(cfg, MetadataClass.GeometryColumn);
Metadata.AddMapping(cfg, MetadataClass.SpatialReferenceSystem);

Then you can use them as normal mapped classes. For example, you could execute the following HQL query:

select srs.WellKnownText from SpatialReferenceSystem as srs where srs.SRID=4326

WARNING: DO NOT add metadata class mappings when using the SchemaExport utility. You could lose all contents of metadata tables.

NHibernate Mapping:

In the XML mappings file, map all properties as usual but for geometry columns use the following entry:

<property name="Geometry" column="the_geom" type="NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial" />

Optionally, for schema generation and default values setting, you can use type parameters. The available parameters are srid and subtype. For example:

<property name="Geometry" column="the_geom">
    <type name="NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial">
        <param name="srid">4326</param>
        <param name="subtype">POLYGON</param>
    </type>
</property>

In the mapped class, declare the corresponding property:

private GeoAPI.Geometries.IGeometry _geometry; 
public virtual GeoAPI.Geometries.IGeometry Geometry
{
	get
	{
		return this._geometry;
	}
	set
	{
		this._geometry = value;
	}
}

ActiveRecord Mapping:

private GeoAPI.Geometries.IGeometry _geometry; 
         
[Property("the_geom", ColumnType = "NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial")]
public virtual GeoAPI.Geometries.IGeometry Geometry
{
	get
	{
		return this._geometry;
	}
	set
	{
		this._geometry = value;
	}
}

NOTE: Type parameters (see NHibernate mapping above) are not supported in ActiveRecord.

ActiveWriter Mapping:

Drag & drop a MsSqlSpatial table from Server Explorer/Data connections.
In the model, select "the_geom" property.
In the properties window, enter the following values:

Property	Value
Column Type	Custom
Custom Column Type	NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial
Custom Member Type	GeoAPI.Geometries.IGeometry

NOTE: Type parameters (see NHibernate mapping above) are not supported in ActiveRecord, so it is in ActiveWriter.

Configuration and mapping

Ricardo Stuven — Fri, 26 Sep 2008 22:18:57 GMT

Revision 2 posted to Spatial by Ricardo Stuven on 26/09/2008 07:18:57 p.m.

Configuration and mapping

Dialect Configuration:

In the NHibernate section of your configuration file add the following entry:

<property name="hibernate.dialect">NHibernate.Spatial.Dialect.SomeSpatialDialect,NHibernate.Spatial</property>

If you're using Castle ActiveRecord, the entry will look like this:

<add key="hibernate.dialect" value="NHibernate.Spatial.Dialect.SomeSpatialDialect,NHibernate.Spatial" />

Replace SomeSpatialDialect by the spatial dialect to be used. For example, MsSqlSpatialDialect.

Schema Generation Configuration:

Declarative: Use of <database-object> element is not supported.

Programmatic:

Configuration cfg = new Configuration();
    // Your configuration code (eg. cfg.Configure(); )
    cfg.AddAuxiliaryDatabaseObject(new SpatialAuxiliaryDatabaseObject(cfg));

Then you can use a SchemaExport object or the hibernate.hbm2ddl.auto configuration property for schema generation.

Metadata Mappings Configuration:

There are two classes available for metadata mapping in the NHibernate.Spatial.Metadata namespace: GeometryColumn and SpatialReferenceSystem. You can add them selectively:

Configuration cfg = new Configuration();
// Your configuration code (eg. cfg.Configure(); )
Metadata.AddMapping(cfg, MetadataClass.GeometryColumn);
Metadata.AddMapping(cfg, MetadataClass.SpatialReferenceSystem);

Then you can use them as normal mapped classes. For example, you could execute the following HQL query:

select srs.WellKnownText from SpatialReferenceSystem as srs where srs.SRID=4326

WARNING: DO NOT add metadata class mappings when using the SchemaExport utility. You could lose all contents of metadata tables.

NHibernate Mapping:

In the XML mappings file, map all properties as usual but for geometry columns use the following entry:

<property name="Geometry" column="the_geom" type="NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial" />

Optionally, for schema generation and default values setting, you can use type parameters. The available parameters are srid and subtype. For example:

<property name="Geometry" column="the_geom">
    <type name="NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial">
        <param name="srid">4326</param>
        <param name="subtype">POLYGON</param>
    </type>
</property>

In the mapped class, declare the corresponding property:

private GeoAPI.Geometries.IGeometry _geometry; 
public virtual GeoAPI.Geometries.IGeometry Geometry
{
	get
	{
		return this._geometry;
	}
	set
	{
		this._geometry = value;
	}
}

ActiveRecord Mapping:

private GeoAPI.Geometries.IGeometry _geometry; 
         
[Property("the_geom", ColumnType = "NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial")]
public virtual GeoAPI.Geometries.IGeometry Geometry
{
	get
	{
		return this._geometry;
	}
	set
	{
		this._geometry = value;
	}
}

NOTE: Type parameters (see NHibernate mapping above) are not supported in ActiveRecord.

ActiveWriter Mapping:

Drag & drop a MsSqlSpatial table from Server Explorer/Data connections.
In the model, select "the_geom" property.
In the properties window, enter the following values:

Property	Value
Column Type	Custom
Custom Column Type	NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial
Custom Member Type	GeoAPI.Geometries.IGeometry

NOTE: Type parameters (see NHibernate mapping above) are not supported in ActiveRecord, so it is in ActiveWriter.

Configuration and mapping

Ricardo Stuven — Fri, 26 Sep 2008 21:29:14 GMT

Revision 1 posted to Spatial by Ricardo Stuven on 26/09/2008 06:29:14 p.m.

Dialect Configuration:

In the NHibernate section of your configuration file add the following entry:

<property name="hibernate.dialect">NHibernate.Spatial.Dialect.SomeSpatialDialect,NHibernate.Spatial</property>

If you're using Castle ActiveRecord, the entry will look like this:

<add key="hibernate.dialect" value="NHibernate.Spatial.Dialect.SomeSpatialDialect,NHibernate.Spatial" />

Replace SomeSpatialDialect by the spatial dialect to be used. For example, MsSqlSpatialDialect.

Schema Generation Configuration:

Declarative: Use of <database-object> element is not supported.
Programmatic:

    Configuration cfg = new Configuration();
    // Your configuration code (eg. cfg.Configure(); )
    cfg.AddAuxiliaryDatabaseObject(new SpatialAuxiliaryDatabaseObject(cfg));

Then you can use a SchemaExport object or the hibernate.hbm2ddl.auto configuration property for schema generation.

Metadata Mappings Configuration:

There are two classes available for metadata mapping in the NHibernate.Spatial.Metadata namespace: GeometryColumn and SpatialReferenceSystem. You can add them selectively:

Configuration cfg = new Configuration();
// Your configuration code (eg. cfg.Configure(); )
Metadata.AddMapping(cfg, MetadataClass.GeometryColumn);
Metadata.AddMapping(cfg, MetadataClass.SpatialReferenceSystem);

Then you can use them as normal mapped classes. For example, you could execute the following HQL query:

select srs.WellKnownText from SpatialReferenceSystem as srs where srs.SRID=4326

WARNING: DO NOT add metadata class mappings when using the SchemaExport utility. You could lose all contents of metadata tables.

NHibernate Mapping:

In the XML mappings file, map all properties as usual but for geometry columns use the following entry:

<property name="Geometry" column="the_geom" type="NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial" />

Optionally, for schema generation and default values setting, you can use type parameters. The available parameters are srid and subtype. For example:

<property name="Geometry" column="the_geom">
    <type name="NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial">
        <param name="srid">4326</param>
        <param name="subtype">POLYGON</param>
    </type>
</property>

In the mapped class, declare the corresponding property:

private GeoAPI.Geometries.IGeometry _geometry; 
public virtual GeoAPI.Geometries.IGeometry Geometry
{
	get
	{
		return this._geometry;
	}
	set
	{
		this._geometry = value;
	}
}

ActiveRecord Mapping:

private GeoAPI.Geometries.IGeometry _geometry; 
         
[Property("the_geom", ColumnType = "NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial")]
public virtual GeoAPI.Geometries.IGeometry Geometry
{
	get
	{
		return this._geometry;
	}
	set
	{
		this._geometry = value;
	}
}

NOTE: Type parameters (see NHibernate mapping above) are not supported in ActiveRecord.

ActiveWriter Mapping:

Drag & drop a MsSqlSpatial table from Server Explorer/Data connections.
In the model, select "the_geom" property.
In the properties window, enter the following values:

Property	Value
Column Type	Custom
Custom Column Type	NHibernate.Spatial.Type.GeometryType, NHibernate.Spatial
Custom Member Type	GeoAPI.Geometries.IGeometry

NOTE: Type parameters (see NHibernate mapping above) are not supported in ActiveRecord, so it is in ActiveWriter.

Sample usage

Ricardo Stuven — Wed, 01 Oct 2008 17:37:00 GMT

Current revision posted to Spatial by Ricardo Stuven on 01/10/2008 02:37:00 p.m.

Sample usage

Find a country by coordinates:

Using NHibernate:

Country country = session.CreateCriteria(typeof(Country))
    .Add(SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24)))
    .UniqueResult() as Country;

Using ActiveRecord:

Country country = Country.FindOne(
    SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24))
);

Find all the towns in a bounding box, except the one located at some coordinates:

Using NHibernate:

IList towns = session.CreateCriteria(typeof(Town))
    .Add(SpatialExpression.Filter("Boundaries", new Envelope(-70, -68, -32, -34)))
    .Add(Expression.Not(SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24))))
    .List();

Using ActiveRecord:

Town[] towns = Town.FindAll(
    SpatialExpression.Filter("Boundaries", new Envelope(-70, -68, -32, -34)),
    Expression.Not(SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24)))
);

The previous example just shows how to combine a spatial criterion (Contains) with a normal criterion (Not), but in this case we could use simply Disjoint.

Get states boundaries grouping counties by state:

Using ActiveRecord:

ProjectionQuery<County> query = new ProjectionQuery<County>(
    Projections.ProjectionList()
        .Add(Projections.GroupProperty("State"))
        .Add(SpatialProjections.Union("Boundaries"))
    );
IList<object[]> stateBoundaries= query.Execute();

Note: For people with a GIS backgroud, the "projection" term could be confusing. In this context, it has nothing to do with cartographic projections. It's rather a term borrowed from relational algebra.

Create a new vehicle GPS position:

Using NHibernate:

public void TrackVehicule(Vehicle vehicule, double longitude, double latitude, DateTime when)
{
    Tracking tracking = new Tracking();
    tracking.Vehicle = vehicle;
    tracking.Position = new Point(longitude, latitude);
    tracking.When = when;
    session.Save(tracking);
}

More, please!

You also will find lots of sample usage code in the tests project (Tests.NHibernate.Spatial). Check out:

Sample usage

Ricardo Stuven — Wed, 01 Oct 2008 01:22:23 GMT

Revision 3 posted to Spatial by Ricardo Stuven on 30/09/2008 10:22:23 p.m.

Sample usage

Find a country by coordinates:

Using NHibernate:

Country country = session.CreateCriteria(typeof(Country))
    .Add(SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24)))
    .UniqueResult() as Country;

Using ActiveRecord:

Country country = Country.FindOne(
    SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24))
);

Find all the towns in a bounding box, except the one located at some coordinates:

Using NHibernate:

IList towns = session.CreateCriteria(typeof(Town))
    .Add(SpatialExpression.Filter("Boundaries", new Envelope(-70, -68, -32, -34)))
    .Add(Expression.Not(SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24))))
    .List();

Using ActiveRecord:

Town[] towns = Town.FindAll(
    SpatialExpression.Filter("Boundaries", new Envelope(-70, -68, -32, -34)),
    Expression.Not(SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24)))
);

The previous example just shows how to combine a spatial criterion (Contains) with a normal criterion (Not), but in this case we could use simply Disjoint.

Get states boundaries grouping counties by state:

Using ActiveRecord:

ProjectionQuery<County> query = new ProjectionQuery<County>(
    Projections.ProjectionList()
        .Add(Projections.GroupProperty("State"))
        .Add(SpatialProjections.Union("Boundaries"))
    );
IList<object[]> stateBoundaries= query.Execute();

Create a new vehicle GPS position:

Using NHibernate:

public void TrackVehicule(Vehicle vehicule, double longitude, double latitude, DateTime when)
{
    Tracking tracking = new Tracking();
    tracking.Vehicle = vehicle;
    tracking.Position = new Point(longitude, latitude);
    tracking.When = when;
    session.Save(tracking);
}

More, please!

You also will find lots of sample usage code in the tests project (Tests.NHibernate.Spatial). Check out:

CriteriaFixture.cs
ProjectionsFixture.cs
OgcSfSql11Compliance/ConformanceItemsFixture.cs
RandomGeometries/SpatialQueriesFixture.cs

Sample usage

Ricardo Stuven — Wed, 01 Oct 2008 01:17:22 GMT

Revision 2 posted to Spatial by Ricardo Stuven on 30/09/2008 10:17:22 p.m.

Sample usage

Find a country by coordinates:

Using NHibernate:

Country country = session.CreateCriteria(typeof(Country))
    .Add(SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24)))
    .UniqueResult() as Country;

Using ActiveRecord:

Country country = Country.FindOne(
    SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24))
);

Find all the towns in a bounding box, except the one located at some coordinates:

Using NHibernate:

IList towns = session.CreateCriteria(typeof(Town))
    .Add(SpatialExpression.Filter("Boundaries", new Envelope(-70, -68, -32, -34)))
    .Add(Expression.Not(SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24))))
    .List();

Using ActiveRecord:

Town[] towns = Town.FindAll(
    SpatialExpression.Filter("Boundaries", new Envelope(-70, -68, -32, -34)),
    Expression.Not(SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24)))
);


The previous example just shows how to combine a spatial criterion (Contains) with a normal criterion (Not), but in this case we could use simply Disjoint.

Get states boundaries grouping counties by state:

Using ActiveRecord:

ProjectionQuery<County> query = new ProjectionQuery<County>(
    Projections.ProjectionList()
        .Add(Projections.GroupProperty("State"))
        .Add(SpatialProjections.Union("Boundaries"))
    );
IList<object[]> stateBoundaries= query.Execute();

Create a new vehicle GPS position:

Using NHibernate:

public void TrackVehicule(Vehicle vehicule, double longitude, double latitude, DateTime when)
{
    Tracking tracking = new Tracking();
    tracking.Vehicle = vehicle;
    tracking.Position = new Point(longitude, latitude);
    tracking.When = when;
    session.Save(tracking);
}

More, please!

You also will find lots of sample usage code in the tests project (Tests.NHibernate.Spatial). Check out:

CriteriaFixture.cs
ProjectionsFixture.cs
OgcSfSql11Compliance/ConformanceItemsFixture.cs
RandomGeometries/SpatialQueriesFixture.cs

Sample usage

Ricardo Stuven — Fri, 26 Sep 2008 21:35:40 GMT

Revision 1 posted to Spatial by Ricardo Stuven on 26/09/2008 06:35:40 p.m.

Find a country by coordinates:

Using NHibernate:

Country country = session.CreateCriteria(typeof(Country))
    .Add(SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24)))
    .UniqueResult() as Country;

Using ActiveRecord:

Country country = Country.FindOne(
    SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24))
);

Find all the towns in a bounding box, except the one located at some coordinates:

Using NHibernate:

IList towns = session.CreateCriteria(typeof(Town))
    .Add(SpatialExpression.Filter("Boundaries", new Envelope(-70, -68, -32, -34)))
    .Add(Expression.Not(SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24))))
    .List();

Using ActiveRecord:

Town[] towns = Town.FindAll(
    SpatialExpression.Filter("Boundaries", new Envelope(-70, -68, -32, -34)),
    Expression.Not(SpatialExpression.Contains("Boundaries", new Point(-70.40, -33.24)))
);


The previous example just shows how to combine a spatial criterion (Contains) with a normal criterion (Not), but in this case we could use simply Disjoint.

Get states boundaries grouping counties by state:

Using ActiveRecord:

ProjectionQuery<County> query = new ProjectionQuery<County>(
    Projections.ProjectionList()
        .Add(Projections.GroupProperty("State"))
        .Add(SpatialProjections.Union("Boundaries"))
    );
IList<object[]> stateBoundaries= query.Execute();

Create a new vehicle GPS position:

Using NHibernate:

public void TrackVehicule(Vehicle vehicule, double longitude, double latitude, DateTime when)
{
    Tracking tracking = new Tracking();
    tracking.Vehicle = vehicle;
    tracking.Position = new Point(longitude, latitude);
    tracking.When = when;
    session.Save(tracking);
}

More, please!

You also will find lots of sample usage code in the tests project (Tests.NHibernate.Spatial). Check out:

CriteriaFixture.cs
ProjectionsFixture.cs
OgcSfSql11Compliance/ConformanceItemsFixture.cs
RandomGeometries/SpatialQueriesFixture.cs