Skip to main content
Package 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.

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.

  • ​
    Constructor Details

    • ​
      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:
      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.
      The default value is an empty Map.

  • ​
    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.

    • ​
      getSymbolId

      public String getSymbolId()
      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:
      The current value of symbolId.

    • ​
      setSymbolId

      public InsertSymbolRequest setSymbolId(String 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.
      Parameters:
      symbolId - The new value for symbolId.
      Returns:
      this to mimic the builder pattern.

    • ​
      getSymbolFormat

      public String getSymbolFormat()
      Specifies the symbol format. Must be either ‘svg’ or ‘svg_path’. Supported values:
      Returns:
      The current value of symbolFormat.

    • ​
      setSymbolFormat

      public InsertSymbolRequest setSymbolFormat(String symbolFormat)
      Specifies the symbol format. Must be either ‘svg’ or ‘svg_path’. Supported values:
      Parameters:
      symbolFormat - The new value for symbolFormat.
      Returns:
      this to mimic the builder pattern.

    • ​
      getSymbolData

      public ByteBuffer getSymbolData()
      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:
      The current value of symbolData.

    • ​
      setSymbolData

      public InsertSymbolRequest setSymbolData(ByteBuffer 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’.
      Parameters:
      symbolData - The new value for symbolData.
      Returns:
      this to mimic the builder pattern.

    • ​
      getOptions

      public Map<String,String> getOptions()
      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.
      The default value is an empty Map.
      Returns:
      The current value of options.

    • ​
      setOptions

      public InsertSymbolRequest setOptions(Map<String,String> 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.
      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