com.gpudb.protocol

Class CreateTriggerByAreaRequest

java.lang.Object

com.gpudb.protocol.CreateTriggerByAreaRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class CreateTriggerByAreaRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.createTriggerByArea(CreateTriggerByAreaRequest).

Sets up an area trigger mechanism for two column_names for one or more tables. (This function is essentially the two-dimensional version of GPUdb.createTriggerByRange(CreateTriggerByRangeRequest).) Once the trigger has been activated, any record added to the listed tables(s) via GPUdb.insertRecordsRaw(RawInsertRecordsRequest) with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via GPUdb.showSystemStatus(ShowSystemStatusRequest)) for any listening client to collect. Active triggers can be cancelled by using the GPUdb.clearTrigger(ClearTriggerRequest) endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Constructor Summary

Constructors

Constructor and Description
CreateTriggerByAreaRequest() Constructs a CreateTriggerByAreaRequest object with default parameters.
CreateTriggerByAreaRequest(String requestId, List<String> tableNames, String xColumnName, List<Double> xVector, String yColumnName, List<Double> yVector, Map<String,String> options) Constructs a CreateTriggerByAreaRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
Map<String,String>	getOptions()
String	getRequestId()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
List<String>	getTableNames()
String	getXColumnName()
List<Double>	getXVector()
String	getYColumnName()
List<Double>	getYVector()
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
CreateTriggerByAreaRequest	setOptions(Map<String,String> options)
CreateTriggerByAreaRequest	setRequestId(String requestId)
CreateTriggerByAreaRequest	setTableNames(List<String> tableNames)
CreateTriggerByAreaRequest	setXColumnName(String xColumnName)
CreateTriggerByAreaRequest	setXVector(List<Double> xVector)
CreateTriggerByAreaRequest	setYColumnName(String yColumnName)
CreateTriggerByAreaRequest	setYVector(List<Double> yVector)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateTriggerByAreaRequest

public CreateTriggerByAreaRequest()

Constructs a CreateTriggerByAreaRequest object with default parameters.

CreateTriggerByAreaRequest

public CreateTriggerByAreaRequest(String requestId,
                                  List<String> tableNames,
                                  String xColumnName,
                                  List<Double> xVector,
                                  String yColumnName,
                                  List<Double> yVector,
                                  Map<String,String> options)

Constructs a CreateTriggerByAreaRequest object with the specified parameters.

Parameters:

requestId - User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.

tableNames - Names of the tables on which the trigger will be activated and maintained.

xColumnName - Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points.

xVector - The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region.

yColumnName - Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points.

yVector - The respective coordinate values for the region on which the trigger is activated. This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals.

options - Optional parameters. The default value is an empty Map.

Method Detail

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.

getRequestId

public String getRequestId()

Returns:

User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.

setRequestId

public CreateTriggerByAreaRequest setRequestId(String requestId)

Parameters:

requestId - User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.

Returns:

this to mimic the builder pattern.

getTableNames

public List<String> getTableNames()

Returns:

Names of the tables on which the trigger will be activated and maintained.

setTableNames

public CreateTriggerByAreaRequest setTableNames(List<String> tableNames)

Parameters:

tableNames - Names of the tables on which the trigger will be activated and maintained.

Returns:

this to mimic the builder pattern.

getXColumnName

public String getXColumnName()

Returns:

Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points.

setXColumnName

public CreateTriggerByAreaRequest setXColumnName(String xColumnName)

Parameters:

xColumnName - Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points.

Returns:

this to mimic the builder pattern.

getXVector

public List<Double> getXVector()

Returns:

The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region.

setXVector

public CreateTriggerByAreaRequest setXVector(List<Double> xVector)

Parameters:

xVector - The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region.

Returns:

this to mimic the builder pattern.

getYColumnName

public String getYColumnName()

Returns:

Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points.

setYColumnName

public CreateTriggerByAreaRequest setYColumnName(String yColumnName)

Parameters:

yColumnName - Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points.

Returns:

this to mimic the builder pattern.

getYVector

public List<Double> getYVector()

Returns:

The respective coordinate values for the region on which the trigger is activated. This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals.

setYVector

public CreateTriggerByAreaRequest setYVector(List<Double> yVector)

Parameters:

yVector - The respective coordinate values for the region on which the trigger is activated. This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters. The default value is an empty Map.

setOptions

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

Parameters:

options - Optional parameters. The default value is an empty Map.

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