oracle.pgx.config

Class TwoTablesSparkGraphConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.GraphConfig

oracle.pgx.config.AbstractSparkGraphConfig

oracle.pgx.config.AbstractTwoTablesSparkGraphConfig

oracle.pgx.config.TwoTablesSparkGraphConfig

All Implemented Interfaces:

TwoTablesGraphConfig

@Generated(value="config_generator.py")
public class TwoTablesSparkGraphConfig
extends AbstractTwoTablesSparkGraphConfig

PGX Engine Two Tables Spark Graph Config

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TwoTablesSparkGraphConfig.Field Fields of PGX Engine Two Tables Spark Graph Config

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method and Description
TwoTablesSparkDataFormat	getDataFormat() type of the spark data format
TwoTablesDatastore	getDatastore() underlying datastore
java.lang.String	getDateFormat() the date format to use when loading and storing date properties.
java.util.List<GraphPropertyConfig>	getEdgeProps() specification of edge properties associated with graph
java.lang.String	getEdgesKeyColumn() name of primary key column in edges table
java.lang.String	getEdgesLabelColumn() column name for edge label
GraphErrorHandlingConfig	getErrorHandling() error handling configuration
Format	getFormat() graph format (Note: bin is deprecated, use pgb instead)
java.lang.String	getFromNidColumn() column name for source node
java.lang.Integer	getListeningSocketTimeout() PGX side listening socket will be expired after this timeout value (default: 30000 ms, 30 secs)
GraphLoadingConfig	getLoading() loading-specific configuration
java.lang.String	getNodesKeyColumn() name of primary key column in nodes table
java.lang.String	getNodesLabelColumn() column name for node label
java.lang.Integer	getNumSparkEdgeWorkers() number of available spark workers for edge table
java.lang.Integer	getNumSparkNodeWorkers() number of available spark workers for node table
java.lang.String	getToNidColumn() column name for destination node
java.util.Map<TwoTablesSparkGraphConfig.Field,java.lang.Object>	getValues() Gets the parsed values.
java.util.Map<TwoTablesSparkGraphConfig.Field,java.lang.Object>	getValuesWithoutDefaults() Gets the values without defaults.
IdType	getVertexIdType() type of the vertex id
java.util.List<GraphPropertyConfig>	getVertexProps() specification of vertex properties associated with graph
boolean	hasDefaultValue(TwoTablesSparkGraphConfig.Field field) Checks for default value.
java.lang.Boolean	hasEdgeLabel() Deprecated.
java.lang.Boolean	hasVertexLabels() Deprecated.
boolean	isEmpty() Checks if it's empty.
java.lang.Boolean	isSkipEdges() skip edges data if set as true
java.lang.Boolean	isSkipNodes() skip nodes data if set as true
static TwoTablesSparkGraphConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) Parses an input stream.
static TwoTablesSparkGraphConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath) Parses a raw key/value mapping.
static TwoTablesSparkGraphConfig	parse(java.util.Properties props, boolean strict) Parses a properties file.
java.lang.String	toString()

Methods inherited from class oracle.pgx.config.AbstractTwoTablesSparkGraphConfig

equals, getName, hasEdgeKeys, hashCode

Methods inherited from class oracle.pgx.config.GraphConfig

createDateFormat, getEdgePropertyDefault, getEdgePropertyDimension, getEdgePropertyName, getEdgePropertyType, getEdgePropertyTypes, getLoadingFilter, getNodeKeyType, getNodePropertyDefault, getNodePropertyDimension, getNodePropertyName, getNodePropertyType, getVertexPropertyTypes, hasVerticesAndEdgesSeparatedFileFormat, hasVerticesAndEdgesSeparatedFileFormat, isEdgeLabelLoadingEnabled, isFileFormat, isFileFormat, isLoadEdgeKeys, isLoadVertexKeys, isMultipleFileFormat, isMultipleFileFormat, isSingleFileFormat, isSingleFileFormat, isVertexLabelsLoadingEnabled, numEdgeProperties, numNodeProperties, supportsEdgeLabel, supportsEdgeLabel, supportsVertexLabels, supportsVertexLabels

Methods inherited from class oracle.pgx.config.AbstractConfig

getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getDataFormat

public TwoTablesSparkDataFormat getDataFormat()

type of the spark data format

Specified by:

getDataFormat in class AbstractTwoTablesSparkGraphConfig

Returns:

the data format

getDatastore

public TwoTablesDatastore getDatastore()

underlying datastore

Returns:

the datastore

getDateFormat

public java.lang.String getDateFormat()

the date format to use when loading and storing date properties. Please see SimpleDateFormat for a documentation of the format string

Specified by:

getDateFormat in class GraphConfig

Returns:

the date format

getEdgeProps

public java.util.List<GraphPropertyConfig> getEdgeProps()

specification of edge properties associated with graph

Specified by:

getEdgeProps in class GraphConfig

Returns:

the list of vertex properties

getEdgesKeyColumn

public java.lang.String getEdgesKeyColumn()

name of primary key column in edges table

getEdgesLabelColumn

public java.lang.String getEdgesLabelColumn()

column name for edge label

getErrorHandling

public GraphErrorHandlingConfig getErrorHandling()

error handling configuration

Specified by:

getErrorHandling in class GraphConfig

Returns:

the error handling configuration

getFormat

public Format getFormat()

graph format (Note: bin is deprecated, use pgb instead)

Specified by:

getFormat in class GraphConfig

Returns:

the format

getFromNidColumn

public java.lang.String getFromNidColumn()

column name for source node

getListeningSocketTimeout

public java.lang.Integer getListeningSocketTimeout()

PGX side listening socket will be expired after this timeout value (default: 30000 ms, 30 secs)

getLoading

public GraphLoadingConfig getLoading()

loading-specific configuration

Specified by:

getLoading in class GraphConfig

Returns:

the loading configuration

getNodesKeyColumn

public java.lang.String getNodesKeyColumn()

name of primary key column in nodes table

getNodesLabelColumn

public java.lang.String getNodesLabelColumn()

column name for node label

getNumSparkEdgeWorkers

public java.lang.Integer getNumSparkEdgeWorkers()

number of available spark workers for edge table

Specified by:

getNumSparkEdgeWorkers in class AbstractSparkGraphConfig

getNumSparkNodeWorkers

public java.lang.Integer getNumSparkNodeWorkers()

number of available spark workers for node table

Specified by:

getNumSparkNodeWorkers in class AbstractSparkGraphConfig

getToNidColumn

public java.lang.String getToNidColumn()

column name for destination node

getValues

public java.util.Map<TwoTablesSparkGraphConfig.Field,java.lang.Object> getValues()

Gets the parsed values.

Returns:

the parsed values

getValuesWithoutDefaults

public java.util.Map<TwoTablesSparkGraphConfig.Field,java.lang.Object> getValuesWithoutDefaults()

Gets the values without defaults.

Returns:

the values without defaults

getVertexIdType

public IdType getVertexIdType()

type of the vertex id

Specified by:

getVertexIdType in class GraphConfig

Returns:

the vertex ID type

getVertexProps

public java.util.List<GraphPropertyConfig> getVertexProps()

specification of vertex properties associated with graph

Specified by:

getVertexProps in class GraphConfig

Returns:

the list of vertex properties

hasDefaultValue

public boolean hasDefaultValue(TwoTablesSparkGraphConfig.Field field)

Checks for default value.

Parameters:

field - the field

Returns:

true, if value for given field is the default value

hasEdgeLabel

@Deprecated
public java.lang.Boolean hasEdgeLabel()

Deprecated.

whether the graph has the edge label or not

Specified by:

hasEdgeLabel in class GraphConfig

Returns:

true if this graph configuration has the edge label, false otherwise

hasVertexLabels

@Deprecated
public java.lang.Boolean hasVertexLabels()

Deprecated.

whether the graph has the vertex label or not

Specified by:

hasVertexLabels in class GraphConfig

Returns:

true if this graph configuration has the vertex label, false otherwise

isEmpty

public boolean isEmpty()

Checks if it's empty.

Returns:

true, if the Map 'values' is empty.

isSkipEdges

public java.lang.Boolean isSkipEdges()

skip edges data if set as true

isSkipNodes

public java.lang.Boolean isSkipNodes()

skip nodes data if set as true

parse

public static TwoTablesSparkGraphConfig parse(java.io.InputStream is,
                                              boolean strict,
                                              java.lang.String parentPath)
                                       throws java.io.IOException

Parses an input stream.

Parameters:

is - the input stream

strict - if true, parses in strict mode

parentPath - if not null, resolves relative paths against this parentPath

Returns:

the parsed graph config

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

parse

public static TwoTablesSparkGraphConfig parse(java.util.Map<java.lang.String,java.lang.Object> raw,
                                              boolean strict,
                                              java.lang.String parentPath)

Parses a raw key/value mapping.

Parameters:

raw - the raw key/value mapping to parse

strict - if true, parses in strict mode

parentPath - if not null, resolves relative paths against this parentPath

Returns:

the parsed graph config

parse

public static TwoTablesSparkGraphConfig parse(java.util.Properties props,
                                              boolean strict)

Parses a properties file.

Parameters:

props - the properties to parse

strict - if true, parses in strict mode

Returns:

the parsed graph config

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object