A set of parameters for Kinetica.filterByAreaGeometry. More…
Classes | |
| struct | Options |
| A set of string constants for the parameter FilterByAreaGeometryRequest.options. More… | |
Public Member Functions | |
| FilterByAreaGeometryRequest () | |
| Constructs a FilterByAreaGeometryRequest object with default parameters. | |
| FilterByAreaGeometryRequest (string table_name, string view_name, string column_name, IList< double > x_vector, IList< double > y_vector, IDictionary< string, string > options=null) | |
| Constructs a FilterByAreaGeometryRequest object with the specified parameters. | |
| FilterByAreaGeometryRequest () | |
| Constructs a FilterByAreaGeometryRequest object with default parameters. | |
| FilterByAreaGeometryRequest (string table_name, string view_name, string column_name, IList< double > x_vector, IList< double > y_vector, IDictionary< string, string > options=null) | |
| Constructs a FilterByAreaGeometryRequest object with the specified parameters. | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
Properties | |
| string | table_name [get, set] |
| Name of the table to filter, in [schema_name. | |
| string | view_name = "" [get, set] |
| If provided, then this will be the name of the view containing the results, in [schema_name. | |
| string | column_name [get, set] |
| Name of the geospatial geometry column to be filtered. | |
| IList< double > | x_vector = new List<double>() [get, set] |
| List of x coordinates of the vertices of the polygon representing the area to be filtered. | |
| IList< double > | y_vector = new List<double>() [get, set] |
| List of y coordinates of the vertices of the polygon representing the area to be filtered. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
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. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
Detailed Description
A set of parameters for Kinetica.filterByAreaGeometry.
Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name FilterByAreaGeometryRequest.view_name passed in as part of the input.
Definition at line 22 of file FilterByAreaGeometry.cs.
Constructor & Destructor Documentation
◆ FilterByAreaGeometryRequest() [1/4]
| inline |
Constructs a FilterByAreaGeometryRequest object with default parameters.
Definition at line 154 of file FilterByAreaGeometry.cs.
◆ FilterByAreaGeometryRequest() [2/4]
| inline |
Constructs a FilterByAreaGeometryRequest object with the specified parameters.
| table_name | Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries). |
| view_name | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ”. |
| column_name | Name of the geospatial geometry column to be filtered. |
| x_vector | List of x coordinates of the vertices of the polygon representing the area to be filtered. |
| y_vector | List of y coordinates of the vertices of the polygon representing the area to be filtered. |
| options | Optional parameters.
|
Definition at line 221 of file FilterByAreaGeometry.cs.
◆ FilterByAreaGeometryRequest() [3/4]
| inline |
Constructs a FilterByAreaGeometryRequest object with default parameters.
Definition at line 154 of file FilterByAreaGeometry.cs.
◆ FilterByAreaGeometryRequest() [4/4]
| inline |
Constructs a FilterByAreaGeometryRequest object with the specified parameters.
| table_name | Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries). |
| view_name | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ”. |
| column_name | Name of the geospatial geometry column to be filtered. |
| x_vector | List of x coordinates of the vertices of the polygon representing the area to be filtered. |
| y_vector | List of y coordinates of the vertices of the polygon representing the area to be filtered. |
| options | Optional parameters.
|
Definition at line 221 of file FilterByAreaGeometry.cs.
Property Documentation
◆ column_name
| getset |
Name of the geospatial geometry column to be filtered.
Definition at line 95 of file FilterByAreaGeometry.cs.
◆ options
| getset |
Optional parameters.
- CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of FilterByAreaGeometryRequest.view_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_VIEW_NAME. Supported values:The default value is FALSE.
- COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of FilterByAreaGeometryRequest.view_name and use Kinetica.createSchema to create the schema if non-existent] The schema for the newly created view. If the schema is non-existent, it will be automatically created.
The default value is an empty Dictionary.
Definition at line 150 of file FilterByAreaGeometry.cs.
◆ table_name
| getset |
Name of the table to filter, in [schema_name.
]table_name format, using standard name resolution rules.
This may be the name of a table or a view (when chaining queries).
Definition at line 81 of file FilterByAreaGeometry.cs.
◆ view_name
| getset |
If provided, then this will be the name of the view containing the results, in [schema_name.
]view_name format, using standard name resolution rules and meeting table naming criteria.
Must not be an already existing table or view. The default value is ”.
Definition at line 91 of file FilterByAreaGeometry.cs.
◆ x_vector
| getset |
List of x coordinates of the vertices of the polygon representing the area to be filtered.
Definition at line 99 of file FilterByAreaGeometry.cs.
◆ y_vector
| getset |
List of y coordinates of the vertices of the polygon representing the area to be filtered.
Definition at line 103 of file FilterByAreaGeometry.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/FilterByAreaGeometry.cs
- Kinetica/Protocol/FilterByAreaGeometry.cs