​

Method Details

• ​

  getClassSchema

  public static org.apache.avro.Schema getClassSchema()

  This method supports the Avro framework and is not intended to be called directly by the user.

  Returns:

  The schema for the class.

• ​

  getTableName

  public String getTableName()

  Name of the table on which the filter by geometry will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column.

  Returns:

  The current value of tableName.

• ​

  setTableName

  public FilterByGeometryRequest setTableName(String tableName)

  Name of the table on which the filter by geometry will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column.

  Parameters:

  tableName - The new value for tableName.

  Returns:

  this to mimic the builder pattern.

• ​

  getViewName

  public String getViewName()

  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 ”.

  Returns:

  The current value of viewName.

• ​

  setViewName

  public FilterByGeometryRequest setViewName(String viewName)

  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 ”.

  Parameters:

  viewName - The new value for viewName.

  Returns:

  this to mimic the builder pattern.

• ​

  getColumnName

  public String getColumnName()

  Name of the column to be used in the filter. Must be a geospatial geometry column.

  Returns:

  The current value of columnName.

• ​

  setColumnName

  public FilterByGeometryRequest setColumnName(String columnName)

  Name of the column to be used in the filter. Must be a geospatial geometry column.

  Parameters:

  columnName - The new value for columnName.

  Returns:

  this to mimic the builder pattern.

• ​

  getInputWkt

  public String getInputWkt()

  A geometry in WKT format that will be used to filter the objects in tableName. The default value is ”.

  Returns:

  The current value of inputWkt.

• ​

  setInputWkt

  public FilterByGeometryRequest setInputWkt(String inputWkt)

  A geometry in WKT format that will be used to filter the objects in tableName. The default value is ”.

  Parameters:

  inputWkt - The new value for inputWkt.

  Returns:

  this to mimic the builder pattern.

• ​

  getOperation

  public String getOperation()

  The geometric filtering operation to perform. Supported values:

  • CONTAINS: Matches records that contain the given WKT in inputWkt, i.e. the given WKT is within the bounds of a record’s geometry.
  • CROSSES: Matches records that cross the given WKT.
  • DISJOINT: Matches records that are disjoint from the given WKT.
  • EQUALS: Matches records that are the same as the given WKT.
  • INTERSECTS: Matches records that intersect the given WKT.
  • OVERLAPS: Matches records that overlap the given WKT.
  • TOUCHES: Matches records that touch the given WKT.
  • WITHIN: Matches records that are within the given WKT.

  Returns:

  The current value of operation.

• ​

  setOperation

  public FilterByGeometryRequest setOperation(String operation)

  The geometric filtering operation to perform. Supported values:

  • CONTAINS: Matches records that contain the given WKT in inputWkt, i.e. the given WKT is within the bounds of a record’s geometry.
  • CROSSES: Matches records that cross the given WKT.
  • DISJOINT: Matches records that are disjoint from the given WKT.
  • EQUALS: Matches records that are the same as the given WKT.
  • INTERSECTS: Matches records that intersect the given WKT.
  • OVERLAPS: Matches records that overlap the given WKT.
  • TOUCHES: Matches records that touch the given WKT.
  • WITHIN: Matches records that are within the given WKT.

  Parameters:

  operation - The new value for operation.

  Returns:

  this to mimic the builder pattern.

• ​

  getOptions

  public Map<String,String> getOptions()

  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 viewName. 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:
    • TRUE
    • FALSE
    The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED—please specify the containing schema for the view as part of viewName and use GPUdb.createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.

  The default value is an empty Map.

  Returns:

  The current value of options.

• ​

  setOptions

  public FilterByGeometryRequest setOptions(Map<String,String> options)

  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 viewName. 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:
    • TRUE
    • FALSE
    The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED—please specify the containing schema for the view as part of viewName and use GPUdb.createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.

  The default value is an empty Map.

  Parameters:

  options - The new value for options.

  Returns:

  this to mimic the builder pattern.

• ​

  getSchema

  public org.apache.avro.Schema getSchema()

  This method supports the Avro framework and is not intended to be called directly by the user.

  Specified by:

  getSchema in interface org.apache.avro.generic.GenericContainer

  Returns:

  The schema object describing this class.

• ​

  get

  public Object get(int index)

  This method supports the Avro framework and is not intended to be called directly by the user.

  Specified by:

  get in interface org.apache.avro.generic.IndexedRecord

  Parameters:

  index - the position of the field to get

  Returns:

  value of the field with the given index.

  Throws:

  IndexOutOfBoundsException

• ​

  put

  public void put(int index, Object value)

  This method supports the Avro framework and is not intended to be called directly by the user.

  Specified by:

  put in interface org.apache.avro.generic.IndexedRecord

  Parameters:

  index - the position of the field to set

  value - the value to set

  Throws:

  IndexOutOfBoundsException

• ​

  equals

  public boolean equals(Object obj)

  Overrides:

  equals in class Object

• ​

  toString

  public String toString()

  Overrides:

  toString in class Object

• ​

  hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object