com.gpudb.protocol

Class CreateVideoRequest

java.lang.Object

com.gpudb.protocol.CreateVideoRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.createVideo(CreateVideoRequest).

Creates a job to generate a sequence of raster images that visualize data over a specified time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateVideoRequest.Options Optional parameters.
static class	CreateVideoRequest.Style The name of the visualize mode; should correspond to the schema used for the styleParameters field.

Constructor Summary

Constructors

Constructor and Description
CreateVideoRequest() Constructs a CreateVideoRequest object with default parameters.
CreateVideoRequest(String attribute, String begin, double durationSeconds, String end, double framesPerSecond, String style, String path, String styleParameters, Map<String,String> options) Constructs a CreateVideoRequest 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.
String	getAttribute()
String	getBegin()
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
double	getDurationSeconds()
String	getEnd()
double	getFramesPerSecond()
Map<String,String>	getOptions()
String	getPath()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getStyle()
String	getStyleParameters()
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.
CreateVideoRequest	setAttribute(String attribute)
CreateVideoRequest	setBegin(String begin)
CreateVideoRequest	setDurationSeconds(double durationSeconds)
CreateVideoRequest	setEnd(String end)
CreateVideoRequest	setFramesPerSecond(double framesPerSecond)
CreateVideoRequest	setOptions(Map<String,String> options)
CreateVideoRequest	setPath(String path)
CreateVideoRequest	setStyle(String style)
CreateVideoRequest	setStyleParameters(String styleParameters)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateVideoRequest

public CreateVideoRequest()

Constructs a CreateVideoRequest object with default parameters.

CreateVideoRequest

public CreateVideoRequest(String attribute,
                          String begin,
                          double durationSeconds,
                          String end,
                          double framesPerSecond,
                          String style,
                          String path,
                          String styleParameters,
                          Map<String,String> options)

Constructs a CreateVideoRequest object with the specified parameters.

Parameters:

attribute - The animated attribute to map to the video's frames. Must be present in the LAYERS specified for the visualization. This is often a time-related field but may be any numeric type.

begin - The start point for the video. Accepts an expression evaluable over the attribute.

durationSeconds - Seconds of video to produce

end - The end point for the video. Accepts an expression evaluable over the attribute.

framesPerSecond - The presentation frame rate of the encoded video in frames per second.

style - The name of the visualize mode; should correspond to the schema used for the styleParameters field. Supported values:

• CHART
• RASTER
• CLASSBREAK
• CONTOUR
• HEATMAP
• LABELS

path - Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true.

styleParameters - A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.

options - Optional parameters.

• TTL: Sets the TTL of the video.
• WINDOW: Specified using the data-type corresponding to the attribute. For a window of size W, a video frame rendered for time t will visualize data in the interval [t-W,t]. The minimum window size is the interval between successive frames. The minimum value is the default. If a value less than the minimum value is specified, it is replaced with the minimum window size. Larger values will make changes throughout the video appear more smooth while smaller values will capture fast variations in the data.
• NO_ERROR_IF_EXISTS: If true, does not return an error if the video already exists. Ignored if replace_if_exists is true. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• REPLACE_IF_EXISTS: If true, deletes any existing video with the same path before creating a new video. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.

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.

getAttribute

public String getAttribute()

Returns:

The animated attribute to map to the video's frames. Must be present in the LAYERS specified for the visualization. This is often a time-related field but may be any numeric type.

setAttribute

public CreateVideoRequest setAttribute(String attribute)

Parameters:

attribute - The animated attribute to map to the video's frames. Must be present in the LAYERS specified for the visualization. This is often a time-related field but may be any numeric type.

Returns:

this to mimic the builder pattern.

getBegin

public String getBegin()

Returns:

The start point for the video. Accepts an expression evaluable over the attribute.

setBegin

public CreateVideoRequest setBegin(String begin)

Parameters:

begin - The start point for the video. Accepts an expression evaluable over the attribute.

Returns:

this to mimic the builder pattern.

getDurationSeconds

public double getDurationSeconds()

Returns:

Seconds of video to produce

setDurationSeconds

public CreateVideoRequest setDurationSeconds(double durationSeconds)

Parameters:

durationSeconds - Seconds of video to produce

Returns:

this to mimic the builder pattern.

getEnd

public String getEnd()

Returns:

The end point for the video. Accepts an expression evaluable over the attribute.

setEnd

public CreateVideoRequest setEnd(String end)

Parameters:

end - The end point for the video. Accepts an expression evaluable over the attribute.

Returns:

this to mimic the builder pattern.

getFramesPerSecond

public double getFramesPerSecond()

Returns:

The presentation frame rate of the encoded video in frames per second.

setFramesPerSecond

public CreateVideoRequest setFramesPerSecond(double framesPerSecond)

Parameters:

framesPerSecond - The presentation frame rate of the encoded video in frames per second.

Returns:

this to mimic the builder pattern.

getStyle

public String getStyle()

Returns:

The name of the visualize mode; should correspond to the schema used for the styleParameters field. Supported values:

• CHART
• RASTER
• CLASSBREAK
• CONTOUR
• HEATMAP
• LABELS

setStyle

public CreateVideoRequest setStyle(String style)

Parameters:

style - The name of the visualize mode; should correspond to the schema used for the styleParameters field. Supported values:

• CHART
• RASTER
• CLASSBREAK
• CONTOUR
• HEATMAP
• LABELS

Returns:

this to mimic the builder pattern.

getPath

public String getPath()

Returns:

Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true.

setPath

public CreateVideoRequest setPath(String path)

Parameters:

path - Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true.

Returns:

this to mimic the builder pattern.

getStyleParameters

public String getStyleParameters()

Returns:

A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.

setStyleParameters

public CreateVideoRequest setStyleParameters(String styleParameters)

Parameters:

styleParameters - A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• TTL: Sets the TTL of the video.
• WINDOW: Specified using the data-type corresponding to the attribute. For a window of size W, a video frame rendered for time t will visualize data in the interval [t-W,t]. The minimum window size is the interval between successive frames. The minimum value is the default. If a value less than the minimum value is specified, it is replaced with the minimum window size. Larger values will make changes throughout the video appear more smooth while smaller values will capture fast variations in the data.
• NO_ERROR_IF_EXISTS: If true, does not return an error if the video already exists. Ignored if replace_if_exists is true. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• REPLACE_IF_EXISTS: If true, deletes any existing video with the same path before creating a new video. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.

The default value is an empty Map.

setOptions

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

Parameters:

options - Optional parameters.

• TTL: Sets the TTL of the video.
• WINDOW: Specified using the data-type corresponding to the attribute. For a window of size W, a video frame rendered for time t will visualize data in the interval [t-W,t]. The minimum window size is the interval between successive frames. The minimum value is the default. If a value less than the minimum value is specified, it is replaced with the minimum window size. Larger values will make changes throughout the video appear more smooth while smaller values will capture fast variations in the data.
• NO_ERROR_IF_EXISTS: If true, does not return an error if the video already exists. Ignored if replace_if_exists is true. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• REPLACE_IF_EXISTS: If true, deletes any existing video with the same path before creating a new video. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.

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