VisualizeVideoRequest (Kinetica Java API 5.2.0 API)

java.lang.Object
- com.gpudb.protocol.VisualizeVideoRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class VisualizeVideoRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.visualizeVideo(VisualizeVideoRequest).

Creates raster images of data in the given table based on provided input parameters. Numerous parameters are required to call this function. Some of the important parameters are the attributes of the generated images (bgColor, width, height), the collection of GPUdb table names on which this function is to be applied, for which shapes (point, polygon, tracks) the images are to be created and a user specified session key. This session key is later used to fetch the generated images stored by GPUdb. The operation is synchronous meaning that GPUdb will not return the request until the images for all the frames of the video are fully available.

Once the request has been processed then the generated video frames are available for download via WMS using STYLES=cached. In this request the LAYERS parameter should be populated with the session key passed in sessionKey of the visualize video request and the FRAME parameter indicates which 0-based frame of the video should be returned. All other WMS parameters are ignored for this mode.

For instance, if a 20 frame video with the session key 'MY-SESSION-KEY' was generated, the first frame could be retrieved with the URL::

http://:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=0

and the last frame could be retrieved with::

http://gpudb-ip-address:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=19
The response payload provides, among other things, the number of frames which were created by GPUdb.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`VisualizeVideoRequest.Projection` Spatial Reference System (i.e.
`static class`	`VisualizeVideoRequest.StyleOptions` Styling options for the image.

Constructor Summary

Constructors
Constructor and Description
`VisualizeVideoRequest()` Constructs a VisualizeVideoRequest object with default parameters.
`VisualizeVideoRequest(List<String> tableNames, List<String> worldTableNames, List<List<String>> trackIds, String xColumnName, String yColumnName, double minX, double maxX, double minY, double maxY, int width, int height, String projection, long bgColor, List<List<Double>> timeIntervals, String videoStyle, String sessionKey, Map<String,List<String>> styleOptions, Map<String,String> options)` Constructs a VisualizeVideoRequest object with the specified parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete 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.
`long`	`getBgColor()`
`static org.apache.avro.Schema`	`getClassSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`int`	`getHeight()`
`double`	`getMaxX()`
`double`	`getMaxY()`
`double`	`getMinX()`
`double`	`getMinY()`
`Map<String,String>`	`getOptions()`
`String`	`getProjection()`
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`String`	`getSessionKey()`
`Map<String,List<String>>`	`getStyleOptions()`
`List<String>`	`getTableNames()`
`List<List<Double>>`	`getTimeIntervals()`
`List<List<String>>`	`getTrackIds()`
`String`	`getVideoStyle()`
`int`	`getWidth()`
`List<String>`	`getWorldTableNames()`
`String`	`getXColumnName()`
`String`	`getYColumnName()`
`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.
`VisualizeVideoRequest`	`setBgColor(long bgColor)`
`VisualizeVideoRequest`	`setHeight(int height)`
`VisualizeVideoRequest`	`setMaxX(double maxX)`
`VisualizeVideoRequest`	`setMaxY(double maxY)`
`VisualizeVideoRequest`	`setMinX(double minX)`
`VisualizeVideoRequest`	`setMinY(double minY)`
`VisualizeVideoRequest`	`setOptions(Map<String,String> options)`
`VisualizeVideoRequest`	`setProjection(String projection)`
`VisualizeVideoRequest`	`setSessionKey(String sessionKey)`
`VisualizeVideoRequest`	`setStyleOptions(Map<String,List<String>> styleOptions)`
`VisualizeVideoRequest`	`setTableNames(List<String> tableNames)`
`VisualizeVideoRequest`	`setTimeIntervals(List<List<Double>> timeIntervals)`
`VisualizeVideoRequest`	`setTrackIds(List<List<String>> trackIds)`
`VisualizeVideoRequest`	`setVideoStyle(String videoStyle)`
`VisualizeVideoRequest`	`setWidth(int width)`
`VisualizeVideoRequest`	`setWorldTableNames(List<String> worldTableNames)`
`VisualizeVideoRequest`	`setXColumnName(String xColumnName)`
`VisualizeVideoRequest`	`setYColumnName(String yColumnName)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VisualizeVideoRequest
```
public VisualizeVideoRequest()
```
    Constructs a VisualizeVideoRequest object with default parameters.
  - VisualizeVideoRequest
```
public VisualizeVideoRequest(List<String> tableNames,
                             List<String> worldTableNames,
                             List<List<String>> trackIds,
                             String xColumnName,
                             String yColumnName,
                             double minX,
                             double maxX,
                             double minY,
                             double maxY,
                             int width,
                             int height,
                             String projection,
                             long bgColor,
                             List<List<Double>> timeIntervals,
                             String videoStyle,
                             String sessionKey,
                             Map<String,List<String>> styleOptions,
                             Map<String,String> options)
```
    Constructs a VisualizeVideoRequest object with the specified parameters.
    Parameters:
    
    tableNames - Names of the tables containing the data for various layers of the resulting video.
    
    worldTableNames - Optional name of the tables containing the data for the entire track when the tableNames contains only part of the track data, but the entire track has to be rendered. The number of tables should match the number of tables in the tableNames
    
    trackIds - Tracks from the tableNames to be rendered.
    
    xColumnName - Name of the column containing the x coordinates.
    
    yColumnName - Name of the column containing the y coordinates.
    
    minX - Lower bound for the x values.
    
    maxX - Upper bound for the x values.
    
    minY - Lower bound for the y values.
    
    maxY - Upper bound for the y values.
    
    width - Width of the generated image.
    
    height - Height of the generated image.
    
    projection - Spatial Reference System (i.e. EPSG Code). Values: EPSG:4326, PLATE_CARREE, 900913, EPSG:900913, 102100, EPSG:102100, 3857, EPSG:3857, WEB_MERCATOR.
    
    bgColor - Background color of the generated image.
    
    timeIntervals -
    
    videoStyle -
    
    sessionKey - User Provided session key that is later used to retrieve the generated video from the WMS.
    styleOptions - Styling options for the image.
    
    do_points: Rasterize point data toggle. Values: true, false.
    do_shapes: Rasterize shapes toggle. Values: true, false.
    do_tracks: Rasterize tracks toggle. Values: true, false.
    pointcolors: RGB color value in hex for the points.
    pointsizes: Size of points.
    pointshapes: Shape of the point. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
    shapelinewidths: Width of the lines.
    shapelinecolors: RGB color values in hex for the line.
    shapefillcolors: RGB color values in hex for the fill color of the shapes. Use '-1' for no fill.
    tracklinewidths: Width of the track lines. '0' implies do not draw track lines.
    tracklinecolors: RGB color values for the track lines.
    trackmarkersizes: Size of the track point markers.
    trackmarkercolors: Color of the track point markers.
    trackmarkershapes: Shape of track point markers. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
    trackheadcolors: Color of track head markers.
    trackheadsizes: Size of track head markers.
    trackheadshapes: Shape of track head markers. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
    options - Optional parameters.
- 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.
  - getTableNames
```
public List<String> getTableNames()
```
    Returns:
    
    Names of the tables containing the data for various layers of the resulting video.
  - setTableNames
```
public VisualizeVideoRequest setTableNames(List<String> tableNames)
```
    Parameters:
    
    tableNames - Names of the tables containing the data for various layers of the resulting video.
    
    Returns:
    
    this to mimic the builder pattern.
  - getWorldTableNames
```
public List<String> getWorldTableNames()
```
    Returns:
    
    Optional name of the tables containing the data for the entire track when the tableNames contains only part of the track data, but the entire track has to be rendered. The number of tables should match the number of tables in the tableNames
  - setWorldTableNames
```
public VisualizeVideoRequest setWorldTableNames(List<String> worldTableNames)
```
    Parameters:
    
    worldTableNames - Optional name of the tables containing the data for the entire track when the tableNames contains only part of the track data, but the entire track has to be rendered. The number of tables should match the number of tables in the tableNames
    
    Returns:
    
    this to mimic the builder pattern.
  - getTrackIds
```
public List<List<String>> getTrackIds()
```
    Returns:
    
    Tracks from the tableNames to be rendered.
  - setTrackIds
```
public VisualizeVideoRequest setTrackIds(List<List<String>> trackIds)
```
    Parameters:
    
    trackIds - Tracks from the tableNames to be rendered.
    
    Returns:
    
    this to mimic the builder pattern.
  - getXColumnName
```
public String getXColumnName()
```
    Returns:
    
    Name of the column containing the x coordinates.
  - setXColumnName
```
public VisualizeVideoRequest setXColumnName(String xColumnName)
```
    Parameters:
    
    xColumnName - Name of the column containing the x coordinates.
    
    Returns:
    
    this to mimic the builder pattern.
  - getYColumnName
```
public String getYColumnName()
```
    Returns:
    
    Name of the column containing the y coordinates.
  - setYColumnName
```
public VisualizeVideoRequest setYColumnName(String yColumnName)
```
    Parameters:
    
    yColumnName - Name of the column containing the y coordinates.
    
    Returns:
    
    this to mimic the builder pattern.
  - getMinX
```
public double getMinX()
```
    Returns:
    
    Lower bound for the x values.
  - setMinX
```
public VisualizeVideoRequest setMinX(double minX)
```
    Parameters:
    
    minX - Lower bound for the x values.
    
    Returns:
    
    this to mimic the builder pattern.
  - getMaxX
```
public double getMaxX()
```
    Returns:
    
    Upper bound for the x values.
  - setMaxX
```
public VisualizeVideoRequest setMaxX(double maxX)
```
    Parameters:
    
    maxX - Upper bound for the x values.
    
    Returns:
    
    this to mimic the builder pattern.
  - getMinY
```
public double getMinY()
```
    Returns:
    
    Lower bound for the y values.
  - setMinY
```
public VisualizeVideoRequest setMinY(double minY)
```
    Parameters:
    
    minY - Lower bound for the y values.
    
    Returns:
    
    this to mimic the builder pattern.
  - getMaxY
```
public double getMaxY()
```
    Returns:
    
    Upper bound for the y values.
  - setMaxY
```
public VisualizeVideoRequest setMaxY(double maxY)
```
    Parameters:
    
    maxY - Upper bound for the y values.
    
    Returns:
    
    this to mimic the builder pattern.
  - getWidth
```
public int getWidth()
```
    Returns:
    
    Width of the generated image.
  - setWidth
```
public VisualizeVideoRequest setWidth(int width)
```
    Parameters:
    
    width - Width of the generated image.
    
    Returns:
    
    this to mimic the builder pattern.
  - getHeight
```
public int getHeight()
```
    Returns:
    
    Height of the generated image.
  - setHeight
```
public VisualizeVideoRequest setHeight(int height)
```
    Parameters:
    
    height - Height of the generated image.
    
    Returns:
    
    this to mimic the builder pattern.
  - getProjection
```
public String getProjection()
```
    Returns:
    
    Spatial Reference System (i.e. EPSG Code). Values: EPSG:4326, PLATE_CARREE, 900913, EPSG:900913, 102100, EPSG:102100, 3857, EPSG:3857, WEB_MERCATOR.
  - setProjection
```
public VisualizeVideoRequest setProjection(String projection)
```
    Parameters:
    
    projection - Spatial Reference System (i.e. EPSG Code). Values: EPSG:4326, PLATE_CARREE, 900913, EPSG:900913, 102100, EPSG:102100, 3857, EPSG:3857, WEB_MERCATOR.
    
    Returns:
    
    this to mimic the builder pattern.
  - getBgColor
```
public long getBgColor()
```
    Returns:
    
    Background color of the generated image.
  - setBgColor
```
public VisualizeVideoRequest setBgColor(long bgColor)
```
    Parameters:
    
    bgColor - Background color of the generated image.
    
    Returns:
    
    this to mimic the builder pattern.
  - getTimeIntervals
```
public List<List<Double>> getTimeIntervals()
```
  - setTimeIntervals
```
public VisualizeVideoRequest setTimeIntervals(List<List<Double>> timeIntervals)
```
    Parameters:
    
    timeIntervals -
    
    Returns:
    
    this to mimic the builder pattern.
  - getVideoStyle
```
public String getVideoStyle()
```
  - setVideoStyle
```
public VisualizeVideoRequest setVideoStyle(String videoStyle)
```
    Parameters:
    
    videoStyle -
    
    Returns:
    
    this to mimic the builder pattern.
  - getSessionKey
```
public String getSessionKey()
```
    Returns:
    
    User Provided session key that is later used to retrieve the generated video from the WMS.
  - setSessionKey
```
public VisualizeVideoRequest setSessionKey(String sessionKey)
```
    Parameters:
    
    sessionKey - User Provided session key that is later used to retrieve the generated video from the WMS.
    
    Returns:
    
    this to mimic the builder pattern.
  - getStyleOptions
```
public Map<String,List<String>> getStyleOptions()
```
    Returns:
    Styling options for the image.
    
    do_points: Rasterize point data toggle. Values: true, false.
    do_shapes: Rasterize shapes toggle. Values: true, false.
    do_tracks: Rasterize tracks toggle. Values: true, false.
    pointcolors: RGB color value in hex for the points.
    pointsizes: Size of points.
    pointshapes: Shape of the point. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
    shapelinewidths: Width of the lines.
    shapelinecolors: RGB color values in hex for the line.
    shapefillcolors: RGB color values in hex for the fill color of the shapes. Use '-1' for no fill.
    tracklinewidths: Width of the track lines. '0' implies do not draw track lines.
    tracklinecolors: RGB color values for the track lines.
    trackmarkersizes: Size of the track point markers.
    trackmarkercolors: Color of the track point markers.
    trackmarkershapes: Shape of track point markers. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
    trackheadcolors: Color of track head markers.
    trackheadsizes: Size of track head markers.
    trackheadshapes: Shape of track head markers. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
  - setStyleOptions
```
public VisualizeVideoRequest setStyleOptions(Map<String,List<String>> styleOptions)
```
    Parameters:
    styleOptions - Styling options for the image.
    
    do_points: Rasterize point data toggle. Values: true, false.
    do_shapes: Rasterize shapes toggle. Values: true, false.
    do_tracks: Rasterize tracks toggle. Values: true, false.
    pointcolors: RGB color value in hex for the points.
    pointsizes: Size of points.
    pointshapes: Shape of the point. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
    shapelinewidths: Width of the lines.
    shapelinecolors: RGB color values in hex for the line.
    shapefillcolors: RGB color values in hex for the fill color of the shapes. Use '-1' for no fill.
    tracklinewidths: Width of the track lines. '0' implies do not draw track lines.
    tracklinecolors: RGB color values for the track lines.
    trackmarkersizes: Size of the track point markers.
    trackmarkercolors: Color of the track point markers.
    trackmarkershapes: Shape of track point markers. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
    trackheadcolors: Color of track head markers.
    trackheadsizes: Size of track head markers.
    trackheadshapes: Shape of track head markers. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    Returns:
    
    Optional parameters.
  - setOptions
```
public VisualizeVideoRequest setOptions(Map<String,String> options)
```
    Parameters:
    
    options - Optional parameters.
    
    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

Class VisualizeVideoRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VisualizeVideoRequest

VisualizeVideoRequest

Method Detail

getClassSchema

getTableNames

setTableNames

getWorldTableNames

setWorldTableNames

getTrackIds

setTrackIds

getXColumnName

setXColumnName

getYColumnName

setYColumnName

getMinX

setMinX

getMaxX

setMaxX

getMinY

setMinY

getMaxY

setMaxY

getWidth

setWidth

getHeight

setHeight

getProjection

setProjection

getBgColor

setBgColor

getTimeIntervals

setTimeIntervals

getVideoStyle

setVideoStyle

getSessionKey

setSessionKey

getStyleOptions

setStyleOptions

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode