oracle.pgx.config

Class PgNosqlGraphConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.GraphConfig

oracle.pgx.config.AbstractPgGraphConfig

oracle.pgx.config.PgNosqlGraphConfig

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

PGX Engine PG NoSQL Graph Config

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PgNosqlGraphConfig.Field Fields of PGX Engine PG NoSQL 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	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
GraphErrorHandlingConfig	getErrorHandling() error handling configuration
Format	getFormat() graph format (Note: bin is deprecated, use pgb instead)
java.util.List<java.lang.String>	getHosts() list of NoSQL hosts
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	getPassword() password of a NoSQL user
java.lang.Integer	getRequestTimeoutMs() NoSQL request timeout in milliseconds
java.lang.String	getStoreName() NoSQL store name
java.lang.String	getTrustStoreFile() the name and path to a Java truststore file
java.lang.String	getUsername() name of a NoSQL user
java.util.Map<PgNosqlGraphConfig.Field,java.lang.Object>	getValues() Gets the parsed values.
java.util.Map<PgNosqlGraphConfig.Field,java.lang.Object>	getValuesWithoutDefaults() Gets the values without defaults.
java.util.List<GraphPropertyConfig>	getVertexProps() specification of vertex properties associated with graph
boolean	hasDefaultValue(PgNosqlGraphConfig.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 PgNosqlGraphConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) Parses an input stream.
static PgNosqlGraphConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath) Parses a raw key/value mapping.
static PgNosqlGraphConfig	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

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

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

getHosts

public java.util.List<java.lang.String> getHosts()

list of NoSQL hosts

Returns:

the hosts

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

getPassword

public java.lang.String getPassword()

password of a NoSQL user

getRequestTimeoutMs

public java.lang.Integer getRequestTimeoutMs()

NoSQL request timeout in milliseconds

getStoreName

public java.lang.String getStoreName()

NoSQL store name

Returns:

the store name

getTrustStoreFile

public java.lang.String getTrustStoreFile()

the name and path to a Java truststore file

getUsername

public java.lang.String getUsername()

name of a NoSQL user

getValues

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

Gets the parsed values.

Returns:

the parsed values

getValuesWithoutDefaults

public java.util.Map<PgNosqlGraphConfig.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

hasDefaultValue

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