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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Charset	getCharset() Gets the charset.
String	getDateFormat() the date format to use when loading and storing date properties.
DbEngine	getDbEngine() underlying database engine
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)
List<String>	getHosts() list of NoSQL hosts
GraphLoadingConfig	getLoading() loading-specific configuration
Integer	getMaxNumConnections() maximum number of database connections to use when reading the graph
String	getName() prefix of the table name (for edge and vertex tables)
String	getPassword() password of a NoSQL user
Integer	getRequestTimeoutMs() NoSQL request timeout in milliseconds
String	getStoreName() NoSQL store name
String	getTrustStoreFile() the name and path to a Java truststore file
String	getUsername() name of a NoSQL user
Map<PgNosqlGraphConfig.Field,Object>	getValues() Gets the parsed values.
Map<PgNosqlGraphConfig.Field,Object>	getValuesWithoutDefaults() Gets the values without defaults.
List<GraphPropertyConfig>	getVertexProps() specification of vertex properties associated with graph
boolean	hasDefaultValue(PgNosqlGraphConfig.Field field) Checks for default value.
int	hashCode()
Boolean	isLoadEdgeLabel() whether or not to load the edge label (string) into memory as well.
static PgNosqlGraphConfig	parse(InputStream is, boolean strict, File parent) Parses an input stream.
static PgNosqlGraphConfig	parse(Map<String,Object> raw, boolean strict, File parent) Parses a raw key/value mapping.
static PgNosqlGraphConfig	parse(Properties props, boolean strict) Parses a properties file.
String	toString()

Methods inherited from class oracle.pgx.config.AbstractPgGraphConfig

getConnection, getOraclePropertyGraph, getVertexIdType, setConnection, setOraclePropertyGraph

Methods inherited from class oracle.pgx.config.GraphConfig

getEdgePropertyDefault, getEdgePropertyName, getEdgePropertyType, getNodeKeyType, getNodePropertyDefault, getNodePropertyName, getNodePropertyType, isFileFormat, isFileFormat, numEdgeProperties, numNodeProperties

Methods inherited from class oracle.pgx.config.AbstractConfig

setSerializable

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getCharset

public Charset getCharset()

Gets the charset.

Returns:

the charset

getDateFormat

public 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 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 List<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 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 String getName()

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

Specified by:

getName in class GraphConfig

Returns:

the graph name

getPassword

public String getPassword()

password of a NoSQL user

getRequestTimeoutMs

public Integer getRequestTimeoutMs()

NoSQL request timeout in milliseconds

getStoreName

public String getStoreName()

NoSQL store name

Returns:

the store name

getTrustStoreFile

public String getTrustStoreFile()

the name and path to a Java truststore file

getUsername

public String getUsername()

name of a NoSQL user

getValues

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

Gets the parsed values.

Returns:

the parsed values

getValuesWithoutDefaults

public Map<PgNosqlGraphConfig.Field,Object> getValuesWithoutDefaults()

Gets the values without defaults.

Returns:

the values without defaults

getVertexProps

public 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

isLoadEdgeLabel

public Boolean isLoadEdgeLabel()

whether or not to load the edge label (string) into memory as well. If true, the first edge property of this config must be of type string. After loading is done, that property will hold the label strings.

Specified by:

isLoadEdgeLabel in class AbstractPgGraphConfig

Returns:

true, if edge label should be loaded

parse

public static PgNosqlGraphConfig parse(InputStream is,
                       boolean strict,
                       File parent)
                                throws IOException

Parses an input stream.

Parameters:

is - the input stream

strict - if true, parses in strict mode

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

Returns:

the parsed graph config

Throws:

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

parse

public static PgNosqlGraphConfig parse(Map<String,Object> raw,
                       boolean strict,
                       File parent)

Parses a raw key/value mapping.

Parameters:

raw - the raw key/value mapping to parse

strict - if true, parses in strict mode

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

Returns:

the parsed graph config

parse

public static PgNosqlGraphConfig parse(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 String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractPgGraphConfig

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPgGraphConfig