com.gpudb.protocol

Class InsertSymbolRequest

java.lang.Object

com.gpudb.protocol.InsertSymbolRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.insertSymbol(InsertSymbolRequest).

Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually. Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InsertSymbolRequest.Options Optional parameters.
static class	InsertSymbolRequest.SymbolFormat Specifies the symbol format.

Constructor Summary

Constructors

Constructor and Description
InsertSymbolRequest() Constructs an InsertSymbolRequest object with default parameters.
InsertSymbolRequest(String symbolId, String symbolFormat, ByteBuffer symbolData, Map<String,String> options) Constructs an InsertSymbolRequest object with the specified parameters.

Method Summary

Methods

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()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
ByteBuffer	getSymbolData()
String	getSymbolFormat()
String	getSymbolId()
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.
InsertSymbolRequest	setOptions(Map<String,String> options)
InsertSymbolRequest	setSymbolData(ByteBuffer symbolData)
InsertSymbolRequest	setSymbolFormat(String symbolFormat)
InsertSymbolRequest	setSymbolId(String symbolId)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

InsertSymbolRequest

public InsertSymbolRequest()

Constructs an InsertSymbolRequest object with default parameters.

InsertSymbolRequest

public InsertSymbolRequest(String symbolId,
                   String symbolFormat,
                   ByteBuffer symbolData,
                   Map<String,String> options)

Constructs an InsertSymbolRequest object with the specified parameters.

Parameters:

symbolId - The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol

symbolFormat - Specifies the symbol format. Must be either 'svg' or 'svg_path'. Supported values:

• SVG
• SVG_PATH

symbolData - The actual symbol data. If symbolFormat is 'svg' then this should be the raw bytes representing an svg file. If symbolFormat is svg path then this should be an svg path string, for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'

options - Optional parameters.

• COLOR: If symbolFormat is 'svg' this is ignored. If symbolFormat is 'svg_path' then this option specifies the color (in RRGGBB hex format) of the path. For example, to have the path rendered in red, used 'FF0000'. If 'color' is not provided then '00FF00' (i.e. green) is used by default.

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.

getSymbolId

public String getSymbolId()

Returns:

The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol

setSymbolId

public InsertSymbolRequest setSymbolId(String symbolId)

Parameters:

symbolId - The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol

Returns:

this to mimic the builder pattern.

getSymbolFormat

public String getSymbolFormat()

Returns:

Specifies the symbol format. Must be either 'svg' or 'svg_path'. Supported values:

• SVG
• SVG_PATH

setSymbolFormat

public InsertSymbolRequest setSymbolFormat(String symbolFormat)

Parameters:

symbolFormat - Specifies the symbol format. Must be either 'svg' or 'svg_path'. Supported values:

• SVG
• SVG_PATH

Returns:

this to mimic the builder pattern.

getSymbolData

public ByteBuffer getSymbolData()

Returns:

The actual symbol data. If symbolFormat is 'svg' then this should be the raw bytes representing an svg file. If symbolFormat is svg path then this should be an svg path string, for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'

setSymbolData

public InsertSymbolRequest setSymbolData(ByteBuffer symbolData)

Parameters:

symbolData - The actual symbol data. If symbolFormat is 'svg' then this should be the raw bytes representing an svg file. If symbolFormat is svg path then this should be an svg path string, for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• COLOR: If symbolFormat is 'svg' this is ignored. If symbolFormat is 'svg_path' then this option specifies the color (in RRGGBB hex format) of the path. For example, to have the path rendered in red, used 'FF0000'. If 'color' is not provided then '00FF00' (i.e. green) is used by default.

setOptions

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

Parameters:

options - Optional parameters.

• COLOR: If symbolFormat is 'svg' this is ignored. If symbolFormat is 'svg_path' then this option specifies the color (in RRGGBB hex format) of the path. For example, to have the path rendered in red, used 'FF0000'. If 'color' is not provided then '00FF00' (i.e. green) is used by default.

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