A set of parameters for /filter/bygeometry. More...

Inheritance diagram for kinetica.FilterByGeometryRequest:

Collaboration diagram for kinetica.FilterByGeometryRequest:

Classes
struct	Operation
	The geometric filtering operation to perform Values: contains, crosses, disjoint, equals, intersects, overlaps, touches, within. More...

Public Member Functions
	FilterByGeometryRequest ()
	Constructs a FilterByGeometryRequest object with default parameters. More...

	FilterByGeometryRequest (string table_name, string view_name, string column_name, string input_wkt, string operation, IDictionary< string, string > options=null)
	Constructs a FilterByGeometryRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	table_name `[get, set]`
	Name of the table on which the filter by geometry will be performed. More...

string	view_name `[get, set]`
	If provided, then this will be the name of the view containing the results. More...

string	column_name = "" `[get, set]`
	Name of the column to be used in the filter. More...

string	input_wkt `[get, set]`
	A geometry in WKT format that will be used to filter the objects in . More...

string	operation = "" `[get, set]`
	The geometric filtering operation to perform Values: contains, crosses, disjoint, equals, intersects, overlaps, touches, within. More...

IDictionary< string, string >	options `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for /filter/bygeometry.

Applies a geometry filter against a spatial column named WKT in a given table, collection or view. The filtering geometry is provided by <member name="input_wkt">.

Definition at line 19 of file FilterByGeometry.cs.

Constructor & Destructor Documentation

kinetica.FilterByGeometryRequest.FilterByGeometryRequest ( )

inline

Constructs a FilterByGeometryRequest object with default parameters.

Definition at line 95 of file FilterByGeometry.cs.

kinetica.FilterByGeometryRequest.FilterByGeometryRequest	(	string	table_name,
		string	view_name,
		string	column_name,
		string	input_wkt,
		string	operation,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a FilterByGeometryRequest object with the specified parameters.

Parameters

table_name	Name of the table on which the filter by geometry will be performed. Must be an existing table, collection or view containing a column named WKT.
view_name	If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
column_name	Name of the column to be used in the filter. Must be 'WKT'
input_wkt	A geometry in WKT format that will be used to filter the objects in .
operation	The geometric filtering operation to perform Values: contains, crosses, disjoint, equals, intersects, overlaps, touches, within.
options	Optional parameters.

Definition at line 118 of file FilterByGeometry.cs.

Property Documentation

string kinetica.FilterByGeometryRequest.column_name = ""

getset

Name of the column to be used in the filter.

Must be 'WKT'

Definition at line 76 of file FilterByGeometry.cs.

string kinetica.FilterByGeometryRequest.input_wkt

getset

A geometry in WKT format that will be used to filter the objects in .

Definition at line 81 of file FilterByGeometry.cs.

string kinetica.FilterByGeometryRequest.operation = ""

getset

The geometric filtering operation to perform Values: contains, crosses, disjoint, equals, intersects, overlaps, touches, within.

Definition at line 87 of file FilterByGeometry.cs.

IDictionary<string, string> kinetica.FilterByGeometryRequest.options

getset

Optional parameters.

Definition at line 90 of file FilterByGeometry.cs.

string kinetica.FilterByGeometryRequest.table_name

getset

Name of the table on which the filter by geometry will be performed.

Must be an existing table, collection or view containing a column named WKT.

Definition at line 66 of file FilterByGeometry.cs.

string kinetica.FilterByGeometryRequest.view_name

getset

If provided, then this will be the name of the view containing the results.

Has the same naming restrictions as tables.

Definition at line 72 of file FilterByGeometry.cs.

The documentation for this class was generated from the following file:

Kinetica/Protocol/FilterByGeometry.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation