kinetica.FilterByBoxGeometryRequest Class Reference

A set of parameters for Kinetica.filterByBoxGeometry(string,string,string,double,double,double,double,IDictionary{string, string}). More...

Inheritance diagram for kinetica.FilterByBoxGeometryRequest:

Collaboration diagram for kinetica.FilterByBoxGeometryRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	FilterByBoxGeometryRequest ()
	Constructs a FilterByBoxGeometryRequest object with default parameters. More...
	FilterByBoxGeometryRequest (string table_name, string view_name, string column_name, double min_x, double max_x, double min_y, double max_y, IDictionary< string, string > options=null)
	Constructs a FilterByBoxGeometryRequest 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 bounding box operation will be performed. More...
string	view_name [get, set]
	Optional name of the result view that will be created containing the results of the query. More...
string	column_name = "" [get, set]
	Name of the geospatial geometry column to be filtered. More...
double	min_x [get, set]
	Lower bound for the x-coordinate of the rectangular box. More...
double	max_x [get, set]
	Upper bound for the x-coordinate of the rectangular box. More...
double	min_y [get, set]
	Lower bound for the y-coordinate of the rectangular box. More...
double	max_y [get, set]
	Upper bound for the y-coordinate of the rectangular box. 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 Kinetica.filterByBoxGeometry(string,string,string,double,double,double,double,IDictionary{string, string}).

Calculates which geospatial geometry objects from a table intersect a rectangular box. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a view_name is passed in as part of the input payload.

Definition at line 25 of file FilterByBoxGeometry.cs.

Constructor & Destructor Documentation

kinetica.FilterByBoxGeometryRequest.FilterByBoxGeometryRequest ( )

inline

Constructs a FilterByBoxGeometryRequest object with default parameters.

Definition at line 104 of file FilterByBoxGeometry.cs.

kinetica.FilterByBoxGeometryRequest.FilterByBoxGeometryRequest ( string  table_name, string  view_name, string  column_name, double  min_x, double  max_x, double  min_y, double  max_y, IDictionary< string, string >  options = null  )

inline

Constructs a FilterByBoxGeometryRequest object with the specified parameters.

Parameters

table_name	Name of the table on which the bounding box operation will be performed. Must be an existing table.
view_name	Optional name of the result view that will be created containing the results of the query. Must not be an already existing collection, table or view. The default value is ''.
column_name	Name of the geospatial geometry column to be filtered.
min_x	Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to .
max_x	Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to .
min_y	Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to .
max_y	Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to .
options	Optional parameters. COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level. The default value is an empty Dictionary.

Definition at line 143 of file FilterByBoxGeometry.cs.

Property Documentation

string kinetica.FilterByBoxGeometryRequest.column_name = ""

getset

Name of the geospatial geometry column to be filtered.

Definition at line 65 of file FilterByBoxGeometry.cs.

double kinetica.FilterByBoxGeometryRequest.max_x

getset

Upper bound for the x-coordinate of the rectangular box.

Must be greater than or equal to .

Definition at line 75 of file FilterByBoxGeometry.cs.

double kinetica.FilterByBoxGeometryRequest.max_y

getset

Upper bound for the y-coordinate of the rectangular box.

Must be greater than or equal to .

Definition at line 85 of file FilterByBoxGeometry.cs.

double kinetica.FilterByBoxGeometryRequest.min_x

getset

Lower bound for the x-coordinate of the rectangular box.

Must be less than or equal to .

Definition at line 70 of file FilterByBoxGeometry.cs.

double kinetica.FilterByBoxGeometryRequest.min_y

getset

Lower bound for the y-coordinate of the rectangular box.

Must be less than or equal to .

Definition at line 80 of file FilterByBoxGeometry.cs.

IDictionary<string, string> kinetica.FilterByBoxGeometryRequest.options

getset

Optional parameters.

• COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.

The default value is an empty Dictionary.

Definition at line 99 of file FilterByBoxGeometry.cs.

string kinetica.FilterByBoxGeometryRequest.table_name

getset

Name of the table on which the bounding box operation will be performed.

Must be an existing table.

Definition at line 55 of file FilterByBoxGeometry.cs.

string kinetica.FilterByBoxGeometryRequest.view_name

getset

Optional name of the result view that will be created containing the results of the query.

Must not be an already existing collection, table or view. The default value is ''.

Definition at line 61 of file FilterByBoxGeometry.cs.

---

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

• Kinetica/Protocol/FilterByBoxGeometry.cs