com.gpudb.protocol

Class CreateGraphRequest

java.lang.Object

com.gpudb.protocol.CreateGraphRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.createGraph(CreateGraphRequest).

Creates a new graph network using given nodes, edges, weights, and restrictions. IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateGraphRequest.DirectedGraph If set to true, the graph will be directed.
static class	CreateGraphRequest.Options Optional parameters.

Constructor Summary

Constructors

Constructor and Description
CreateGraphRequest() Constructs a CreateGraphRequest object with default parameters.
CreateGraphRequest(String graphName, boolean directedGraph, List<String> nodes, List<String> edges, List<String> weights, List<String> restrictions, Map<String,String> options) Constructs a CreateGraphRequest 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.
boolean	getDirectedGraph()
List<String>	getEdges()
String	getGraphName()
List<String>	getNodes()
Map<String,String>	getOptions()
List<String>	getRestrictions()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
List<String>	getWeights()
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.
CreateGraphRequest	setDirectedGraph(boolean directedGraph)
CreateGraphRequest	setEdges(List<String> edges)
CreateGraphRequest	setGraphName(String graphName)
CreateGraphRequest	setNodes(List<String> nodes)
CreateGraphRequest	setOptions(Map<String,String> options)
CreateGraphRequest	setRestrictions(List<String> restrictions)
CreateGraphRequest	setWeights(List<String> weights)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateGraphRequest

public CreateGraphRequest()

Constructs a CreateGraphRequest object with default parameters.

CreateGraphRequest

public CreateGraphRequest(String graphName,
                          boolean directedGraph,
                          List<String> nodes,
                          List<String> edges,
                          List<String> weights,
                          List<String> restrictions,
                          Map<String,String> options)

Constructs a CreateGraphRequest object with the specified parameters.

Parameters:

graphName - Name of the graph resource to generate.

directedGraph - If set to true, the graph will be directed. If set to false, the graph will not be directed. Consult Directed Graphs for more details. Supported values:

• TRUE
• FALSE

The default value is TRUE.

nodes - Nodes represent fundamental topological units of a graph. Nodes must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS NODE_ID', expressions, e.g., 'ST_MAKEPOINT(column1, column2) AS NODE_WKTPOINT', or constant values, e.g., '{9, 10, 11} AS NODE_ID'. If using constant values in an identifier combination, the number of values specified must match across the combination.

edges - Edges represent the required fundamental topological unit of a graph that typically connect nodes. Edges must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS EDGE_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS EDGE_NODE1_NAME', or constant values, e.g., "{'family', 'coworker'} AS EDGE_LABEL". If using constant values in an identifier combination, the number of values specified must match across the combination.

weights - Weights represent a method of informing the graph solver of the cost of including a given edge in a solution. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant values, e.g., '{4, 15} AS WEIGHTS_VALUESPECIFIED'. If using constant values in an identifier combination, the number of values specified must match across the combination.

restrictions - Restrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or constant values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination.

options - Optional parameters.

• RESTRICTION_THRESHOLD_VALUE: Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the graph.
• MERGE_TOLERANCE: If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes. If nodes are within the tolerance of each other, they will be merged as a single node. The default value is '1.0E-4'.
• MIN_X: Minimum x (longitude) value for spatial graph associations. The default value is '-180.0'.
• MAX_X: Maximum x (longitude) value for spatial graph associations. The default value is '180.0'.
• MIN_Y: Minimum y (latitude) value for spatial graph associations. The default value is '-90.0'.
• MAX_Y: Maximum y (latitude) value for spatial graph associations. The default value is '90.0'.
• RECREATE: If set to true and the graph (using graphName) already exists, the graph is deleted and recreated. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• MODIFY: If set to true, recreate is set to true, and the graph (specified using graphName) already exists, the graph is updated with the given components. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• EXPORT_CREATE_RESULTS: If set to true, returns the graph topology in the response as arrays. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ENABLE_GRAPH_DRAW: If set to true, adds a 'EDGE_WKTLINE' column identifier to the specified graph_table so the graph can be viewed via WMS; for social and non-geospatial graphs, the 'EDGE_WKTLINE' column identifier will be populated with spatial coordinates derived from a flattening layout algorithm so the graph can still be viewed. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SAVE_PERSIST: If set to true, the graph will be saved in the persist directory (see the config reference for more information). If set to false, the graph will be removed when the graph server is shutdown. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SYNC_DB: If set to true and save_persist is set to true, the graph will be fully reconstructed upon a database restart and be updated to align with any source table(s) updates made since the creation of the graph. If dynamic graph updates upon table inserts are desired, use add_table_monitor instead. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ADD_TABLE_MONITOR: Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if save_persist is also set to true, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see GPUdb.createTableMonitor(CreateTableMonitorRequest). Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• GRAPH_TABLE: If specified, the created graph is also created as a table with the given name and following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
• REMOVE_LABEL_ONLY: When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but only the label associated with the entity. Otherwise (default), it'll delete the label AND the entity. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ADD_TURNS: Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges). Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• TURN_ANGLE: Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections. It is the vertical deviation angle from the incoming edge to the intersection node. The larger the value, the larger the threshold for sharp turns and intersections; the smaller the value, the larger the threshold for right and left turns; 0 < turn_angle < 90. The default value is '60'.

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.

getGraphName

public String getGraphName()

Returns:

Name of the graph resource to generate.

setGraphName

public CreateGraphRequest setGraphName(String graphName)

Parameters:

graphName - Name of the graph resource to generate.

Returns:

this to mimic the builder pattern.

getDirectedGraph

public boolean getDirectedGraph()

Returns:

If set to true, the graph will be directed. If set to false, the graph will not be directed. Consult Directed Graphs for more details. Supported values:

• TRUE
• FALSE

The default value is TRUE.

setDirectedGraph

public CreateGraphRequest setDirectedGraph(boolean directedGraph)

Parameters:

directedGraph - If set to true, the graph will be directed. If set to false, the graph will not be directed. Consult Directed Graphs for more details. Supported values:

• TRUE
• FALSE

The default value is TRUE.

Returns:

this to mimic the builder pattern.

getNodes

public List<String> getNodes()

Returns:

Nodes represent fundamental topological units of a graph. Nodes must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS NODE_ID', expressions, e.g., 'ST_MAKEPOINT(column1, column2) AS NODE_WKTPOINT', or constant values, e.g., '{9, 10, 11} AS NODE_ID'. If using constant values in an identifier combination, the number of values specified must match across the combination.

setNodes

public CreateGraphRequest setNodes(List<String> nodes)

Parameters:

nodes - Nodes represent fundamental topological units of a graph. Nodes must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS NODE_ID', expressions, e.g., 'ST_MAKEPOINT(column1, column2) AS NODE_WKTPOINT', or constant values, e.g., '{9, 10, 11} AS NODE_ID'. If using constant values in an identifier combination, the number of values specified must match across the combination.

Returns:

this to mimic the builder pattern.

getEdges

public List<String> getEdges()

Returns:

Edges represent the required fundamental topological unit of a graph that typically connect nodes. Edges must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS EDGE_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS EDGE_NODE1_NAME', or constant values, e.g., "{'family', 'coworker'} AS EDGE_LABEL". If using constant values in an identifier combination, the number of values specified must match across the combination.

setEdges

public CreateGraphRequest setEdges(List<String> edges)

Parameters:

edges - Edges represent the required fundamental topological unit of a graph that typically connect nodes. Edges must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS EDGE_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS EDGE_NODE1_NAME', or constant values, e.g., "{'family', 'coworker'} AS EDGE_LABEL". If using constant values in an identifier combination, the number of values specified must match across the combination.

Returns:

this to mimic the builder pattern.

getWeights

public List<String> getWeights()

Returns:

Weights represent a method of informing the graph solver of the cost of including a given edge in a solution. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant values, e.g., '{4, 15} AS WEIGHTS_VALUESPECIFIED'. If using constant values in an identifier combination, the number of values specified must match across the combination.

setWeights

public CreateGraphRequest setWeights(List<String> weights)

Parameters:

weights - Weights represent a method of informing the graph solver of the cost of including a given edge in a solution. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant values, e.g., '{4, 15} AS WEIGHTS_VALUESPECIFIED'. If using constant values in an identifier combination, the number of values specified must match across the combination.

Returns:

this to mimic the builder pattern.

getRestrictions

public List<String> getRestrictions()

Returns:

Restrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or constant values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination.

setRestrictions

public CreateGraphRequest setRestrictions(List<String> restrictions)

Parameters:

restrictions - Restrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or constant values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• RESTRICTION_THRESHOLD_VALUE: Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the graph.
• MERGE_TOLERANCE: If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes. If nodes are within the tolerance of each other, they will be merged as a single node. The default value is '1.0E-4'.
• MIN_X: Minimum x (longitude) value for spatial graph associations. The default value is '-180.0'.
• MAX_X: Maximum x (longitude) value for spatial graph associations. The default value is '180.0'.
• MIN_Y: Minimum y (latitude) value for spatial graph associations. The default value is '-90.0'.
• MAX_Y: Maximum y (latitude) value for spatial graph associations. The default value is '90.0'.
• RECREATE: If set to true and the graph (using graphName) already exists, the graph is deleted and recreated. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• MODIFY: If set to true, recreate is set to true, and the graph (specified using graphName) already exists, the graph is updated with the given components. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• EXPORT_CREATE_RESULTS: If set to true, returns the graph topology in the response as arrays. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ENABLE_GRAPH_DRAW: If set to true, adds a 'EDGE_WKTLINE' column identifier to the specified graph_table so the graph can be viewed via WMS; for social and non-geospatial graphs, the 'EDGE_WKTLINE' column identifier will be populated with spatial coordinates derived from a flattening layout algorithm so the graph can still be viewed. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SAVE_PERSIST: If set to true, the graph will be saved in the persist directory (see the config reference for more information). If set to false, the graph will be removed when the graph server is shutdown. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SYNC_DB: If set to true and save_persist is set to true, the graph will be fully reconstructed upon a database restart and be updated to align with any source table(s) updates made since the creation of the graph. If dynamic graph updates upon table inserts are desired, use add_table_monitor instead. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ADD_TABLE_MONITOR: Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if save_persist is also set to true, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see GPUdb.createTableMonitor(CreateTableMonitorRequest). Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• GRAPH_TABLE: If specified, the created graph is also created as a table with the given name and following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
• REMOVE_LABEL_ONLY: When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but only the label associated with the entity. Otherwise (default), it'll delete the label AND the entity. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ADD_TURNS: Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges). Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• TURN_ANGLE: Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections. It is the vertical deviation angle from the incoming edge to the intersection node. The larger the value, the larger the threshold for sharp turns and intersections; the smaller the value, the larger the threshold for right and left turns; 0 < turn_angle < 90. The default value is '60'.

The default value is an empty Map.

setOptions

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

Parameters:

options - Optional parameters.

• RESTRICTION_THRESHOLD_VALUE: Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the graph.
• MERGE_TOLERANCE: If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes. If nodes are within the tolerance of each other, they will be merged as a single node. The default value is '1.0E-4'.
• MIN_X: Minimum x (longitude) value for spatial graph associations. The default value is '-180.0'.
• MAX_X: Maximum x (longitude) value for spatial graph associations. The default value is '180.0'.
• MIN_Y: Minimum y (latitude) value for spatial graph associations. The default value is '-90.0'.
• MAX_Y: Maximum y (latitude) value for spatial graph associations. The default value is '90.0'.
• RECREATE: If set to true and the graph (using graphName) already exists, the graph is deleted and recreated. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• MODIFY: If set to true, recreate is set to true, and the graph (specified using graphName) already exists, the graph is updated with the given components. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• EXPORT_CREATE_RESULTS: If set to true, returns the graph topology in the response as arrays. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ENABLE_GRAPH_DRAW: If set to true, adds a 'EDGE_WKTLINE' column identifier to the specified graph_table so the graph can be viewed via WMS; for social and non-geospatial graphs, the 'EDGE_WKTLINE' column identifier will be populated with spatial coordinates derived from a flattening layout algorithm so the graph can still be viewed. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SAVE_PERSIST: If set to true, the graph will be saved in the persist directory (see the config reference for more information). If set to false, the graph will be removed when the graph server is shutdown. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SYNC_DB: If set to true and save_persist is set to true, the graph will be fully reconstructed upon a database restart and be updated to align with any source table(s) updates made since the creation of the graph. If dynamic graph updates upon table inserts are desired, use add_table_monitor instead. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ADD_TABLE_MONITOR: Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if save_persist is also set to true, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see GPUdb.createTableMonitor(CreateTableMonitorRequest). Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• GRAPH_TABLE: If specified, the created graph is also created as a table with the given name and following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
• REMOVE_LABEL_ONLY: When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but only the label associated with the entity. Otherwise (default), it'll delete the label AND the entity. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ADD_TURNS: Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges). Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• TURN_ANGLE: Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections. It is the vertical deviation angle from the incoming edge to the intersection node. The larger the value, the larger the threshold for sharp turns and intersections; the smaller the value, the larger the threshold for right and left turns; 0 < turn_angle < 90. The default value is '60'.

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