oracle.pgx.config

Class PgRdbmsGraphConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.GraphConfig

oracle.pgx.config.AbstractPgGraphConfig

oracle.pgx.config.PgRdbmsGraphConfig

@Generated(value="config_generator.py")
public class PgRdbmsGraphConfig
extends AbstractPgGraphConfig

PGX Engine PG RDBMS Graph Config

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PgRdbmsGraphConfig.Field Fields of PGX Engine PG RDBMS 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
boolean	equals(java.lang.Object obj)
java.util.Map	getAttributes() additional attributes
java.lang.String	getDataSourceId() the data source id to use to connect to database
java.lang.String	getDateFormat() the date format to use when loading and storing date properties.
DbEngine	getDbEngine() underlying database engine
java.util.List<GraphPropertyConfig>	getEdgeProps() specification of edge properties associated with graph
java.lang.String	getEdgesViewName() the name of view for edges
GraphErrorHandlingConfig	getErrorHandling() error handling configuration
Format	getFormat() graph format (Note: bin is deprecated, use pgb instead)
java.lang.String	getJdbcUrl() jdbc URL pointing to database
java.lang.String	getLabel() the label to use when reading the graph
GraphLoadingConfig	getLoading() loading-specific configuration
java.lang.Integer	getMaxNumConnections() maximum number of database connections to use when reading the graph
java.lang.String	getName() prefix of the table name (for edge and vertex tables)
java.lang.String	getOptions() a parameter that is used by the data access layer (and the underlying database) to change default behaviors of graph instance creation or initialization.
java.lang.String	getOwner() owner (username) of graph in case it differs from given username
java.lang.String	getPassword() password to use when connecting to database
java.lang.String	getRowLabel() the row label to use when reading the graph
java.lang.String	getSecurityPolicy() the policy for the given label or row label
java.lang.String	getUsername() username to use when connecting to database
java.util.Map<PgRdbmsGraphConfig.Field,java.lang.Object>	getValues() Gets the parsed values.
java.util.Map<PgRdbmsGraphConfig.Field,java.lang.Object>	getValuesWithoutDefaults() Gets the values without defaults.
java.util.List<GraphPropertyConfig>	getVertexProps() specification of vertex properties associated with graph
java.lang.String	getVerticesViewName() the name of view for vertices
java.lang.Integer	getViewParallelHintDegree() if view names are given, the resulting query will be hinted to run in parallel with the given degree.
boolean	hasDefaultValue(PgRdbmsGraphConfig.Field field) Checks for default value.
java.lang.Boolean	hasEdgeLabel() Deprecated.
int	hashCode()
java.lang.Boolean	hasVertexLabels() Deprecated.
boolean	isEmpty() Checks if it's empty.
static PgRdbmsGraphConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) Parses an input stream.
static PgRdbmsGraphConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath) Parses a raw key/value mapping.
static PgRdbmsGraphConfig	parse(java.util.Properties props, boolean strict) Parses a properties file.
java.lang.String	toString()

Methods inherited from class oracle.pgx.config.AbstractPgGraphConfig

getOraclePropertyGraph, getVertexIdType, setOraclePropertyGraph

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

getAttributes

public java.util.Map getAttributes()

additional attributes

Specified by:

getAttributes in class AbstractPgGraphConfig

Returns:

the map of options

getDataSourceId

public java.lang.String getDataSourceId()

the data source id to use to connect to database

Returns:

the data source ID

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 AbstractPgGraphConfig

Returns:

the date format used for loading the graph

getDbEngine

public DbEngine getDbEngine()

underlying database engine

Specified by:

getDbEngine in class AbstractPgGraphConfig

Returns:

the database engine

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

getEdgesViewName

public java.lang.String getEdgesViewName()

the name of view for edges

Returns:

the name of view for edges

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

getJdbcUrl

public java.lang.String getJdbcUrl()

jdbc URL pointing to database

Returns:

the JDBC url

getLabel

public java.lang.String getLabel()

the label to use when reading the graph

Returns:

the label

getLoading

public GraphLoadingConfig getLoading()

loading-specific configuration

Specified by:

getLoading in class GraphConfig

Returns:

the loading configuration

getMaxNumConnections

public java.lang.Integer getMaxNumConnections()

maximum number of database connections to use when reading the graph

Specified by:

getMaxNumConnections in class AbstractPgGraphConfig

Returns:

the maximum number of connections

getName

public java.lang.String getName()

prefix of the table name (for edge and vertex tables)

Specified by:

getName in class GraphConfig

Returns:

the graph name

getOptions

public java.lang.String getOptions()

a parameter that is used by the data access layer (and the underlying database) to change default behaviors of graph instance creation or initialization. Please refer to the data access layer documentation for possible configuration options

getOwner

public java.lang.String getOwner()

owner (username) of graph in case it differs from given username

Returns:

the owner

getPassword

public java.lang.String getPassword()

password to use when connecting to database

Returns:

the password

getRowLabel

public java.lang.String getRowLabel()

the row label to use when reading the graph

Returns:

the row label

getSecurityPolicy

public java.lang.String getSecurityPolicy()

the policy for the given label or row label

Returns:

the policy

getUsername

public java.lang.String getUsername()

username to use when connecting to database

Returns:

the username

getValues

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

Gets the parsed values.

Returns:

the parsed values

getValuesWithoutDefaults

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

Gets the values without defaults.

Returns:

the values without defaults

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

getVerticesViewName

public java.lang.String getVerticesViewName()

the name of view for vertices

Returns:

the name of view for vertices

getViewParallelHintDegree

public java.lang.Integer getViewParallelHintDegree()

if view names are given, the resulting query will be hinted to run in parallel with the given degree. If the value is negative, the parallel hint will be omitted. If the value is zero, a parallel hint without degree is generated.

hasDefaultValue

public boolean hasDefaultValue(PgRdbmsGraphConfig.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.

parse

public static PgRdbmsGraphConfig 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 PgRdbmsGraphConfig 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 PgRdbmsGraphConfig 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

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractPgGraphConfig

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPgGraphConfig