oracle.pgx.config

Class FileGraphConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.GraphConfig

oracle.pgx.config.AbstractFileGraphConfig

oracle.pgx.config.FileGraphConfig

All Implemented Interfaces:

CommonLoadableConfig<Format>, oracle.pgx.config.internal.ConvertibleToGraphConfigBuilder

@Generated(value="config_generator.py")
public class FileGraphConfig
extends AbstractFileGraphConfig

PGX Engine File Graph Config

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileGraphConfig.Field Fields of PGX Engine File Graph Config

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Double	getArrayCompactionThreshold() [only relevant if the graph is optimized for updates] threshold used to determined when to compact the delta-logs into a new array.
java.util.Map	getAttributes() additional attributes needed to read/write the graph data
static FileGraphConfig.Field[]	getConfigFields()
java.lang.Object	getEdgeDestinationColumn() name or index (starting from 1) of column corresponding to edge destination (for CSV format only)
java.lang.Object	getEdgeIdColumn() name or index (starting from 1) of column corresponding to edge id (for CSV format only)
IdStrategy	getEdgeIdStrategy() Indicates what ID strategy should be used for the edges of this graph.
IdType	getEdgeIdType() type of the edge ID.
java.lang.Object	getEdgeLabelColumn() name or index (starting from 1) of column corresponding to edge label (for CSV format only)
java.util.List<GraphPropertyConfig>	getEdgeProps() specification of edge properties associated with graph
java.lang.Object	getEdgeSourceColumn() name or index (starting from 1) of column corresponding to edge source (for CSV format only)
java.util.List<java.lang.String>	getEdgeUris() list of unified resource identifiers
GraphErrorHandlingConfig	getErrorHandling() error handling configuration
java.util.List<ExternalStoreConfig>	getExternalStores() Specification of the external stores where external string properties reside.
Format	getFormat() graph format
java.lang.String	getKeystoreAlias() alias to the keystore to use when connecting to database
GraphLoadingConfig	getLoading() loading-specific configuration
java.util.List<java.lang.String>	getLocalDateFormat() array of local_date formats to use when loading and storing local_date properties.
GraphOptimizedFor	getOptimizedFor() Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates
PartitionWhileLoading	getPartitionWhileLoading() Indicates if the graph should be partitioned while loading
java.lang.String	getPoint2d() longitude and latitude as floating point values separated by a space
java.lang.String	getSeparator() a series of single-character separators for tokenizing.
FileGraphStoringConfig	getStoring() storing-specific configuration
java.util.List<java.lang.String>	getTimeFormat() the time format to use when loading and storing time properties.
java.util.List<java.lang.String>	getTimestampFormat() the timestamp format to use when loading and storing timestamp properties.
java.util.List<java.lang.String>	getTimestampWithTimezoneFormat() the timestamp with timezone format to use when loading and storing timestamp with timezone properties.
java.util.List<java.lang.String>	getTimeWithTimezoneFormat() the time with timezone format to use when loading and storing time with timezone properties.
java.util.Map<FileGraphConfig.Field,java.lang.Object>	getValues() Gets the parsed values.
java.util.Map<FileGraphConfig.Field,java.lang.Object>	getValuesWithoutDefaults() Gets the values without defaults.
java.lang.Character	getVectorComponentDelimiter() delimiter for the different components of vector properties
java.lang.Object	getVertexIdColumn() name or index (starting from 1) of column corresponding to vertex id (for CSV format only)
IdStrategy	getVertexIdStrategy() Indicates what ID strategy should be used for the vertices of this graph.
IdType	getVertexIdType() type of the vertex ID.
java.lang.Object	getVertexLabelsColumn() name or index (starting from 1) of column corresponding to vertex labels (for CSV format only)
java.util.List<GraphPropertyConfig>	getVertexProps() specification of vertex properties associated with graph
java.util.List<java.lang.String>	getVertexUris() list of unified resource identifiers
boolean	hasDefaultValue(FileGraphConfig.Field field) Checks for default value.
java.lang.Boolean	isDetectGzip() enable/disable automatic gzip compression detection when loading graphs
boolean	isEmpty() Checks if it's empty.
java.lang.Boolean	isHeader() first line of file is meant for headers, e.g.
static FileGraphConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) Parses an input stream.
static FileGraphConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath) Parses a raw key/value mapping.
static FileGraphConfig	parse(java.util.Properties props, boolean strict) Parses a properties file.
java.lang.String	toString()
java.lang.String	toString(boolean hideSensitiveData)

Methods inherited from class oracle.pgx.config.AbstractFileGraphConfig

getName, getStoringOptions, getUri, getUris, hashCode, toGraphConfigBuilder

Methods inherited from class oracle.pgx.config.GraphConfig

getEdgePropertyDefault, getEdgePropertyDimension, getEdgePropertyName, getEdgePropertyType, getEdgePropertyTypes, getLoadingFilter, getLoadingOptions, getNodeKeyType, getNodePropertyDefault, getNodePropertyDimension, getNodePropertyName, getNodePropertyType, getValidatedEdgeIdStrategy, getValidatedEdgeIdType, getValidatedVertexIdStrategy, getValidatedVertexIdType, getVertexPropertyTypes, hasVerticesAndEdgesSeparatedFileFormat, hasVerticesAndEdgesSeparatedFileFormat, isEdgeLabelLoadingEnabled, isFileFormat, isFileFormat, isLoadEdgeKeys, isLoadVertexKeys, isMultipleFileFormat, isMultipleFileFormat, isSingleFileFormat, isSingleFileFormat, isVertexLabelsLoadingEnabled, numEdgeProperties, numNodeProperties, skipEdgeLoading, skipVertexLoading, supportsEdgeLabel, supportsEdgeLabel, supportsPropertyColumn, supportsPropertyColumn, supportsVectorProperties, supportsVectorProperties, supportsVertexLabels, supportsVertexLabels

Methods inherited from class oracle.pgx.config.AbstractConfig

getDefault, getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.pgx.config.CommonLoadableConfig

createLocalDateFormat, createTimeFormat, createTimestampFormat, createTimestampWithTimezoneFormat, createTimeWithTimezoneFormat

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getArrayCompactionThreshold

public java.lang.Double getArrayCompactionThreshold()

[only relevant if the graph is optimized for updates] threshold used to determined when to compact the delta-logs into a new array. If lower than the engine min_array_compaction_threshold value, min_array_compaction_threshold will be used instead

Specified by:

getArrayCompactionThreshold in class GraphConfig

Returns:

the compaction threshold

getAttributes

public java.util.Map getAttributes()

additional attributes needed to read/write the graph data

Returns:

the map of attributes

getConfigFields

public static FileGraphConfig.Field[] getConfigFields()

getEdgeDestinationColumn

public java.lang.Object getEdgeDestinationColumn()

name or index (starting from 1) of column corresponding to edge destination (for CSV format only)

Specified by:

getEdgeDestinationColumn in class AbstractFileGraphConfig

getEdgeIdColumn

public java.lang.Object getEdgeIdColumn()

name or index (starting from 1) of column corresponding to edge id (for CSV format only)

Specified by:

getEdgeIdColumn in class AbstractFileGraphConfig

getEdgeIdStrategy

public IdStrategy getEdgeIdStrategy()

Indicates what ID strategy should be used for the edges of this graph. If not specified (or set to null), the strategy will be determined during loading or using a default value

Returns:

the ID strategy used for the edges of the graph

getEdgeIdType

public IdType getEdgeIdType()

type of the edge ID. For homogeneous graphs, if not specified (or set to null), it will default to long.

Overrides:

getEdgeIdType in class GraphConfig

Returns:

the edge ID type

getEdgeLabelColumn

public java.lang.Object getEdgeLabelColumn()

name or index (starting from 1) of column corresponding to edge label (for CSV format only)

Specified by:

getEdgeLabelColumn in class AbstractFileGraphConfig

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

getEdgeSourceColumn

public java.lang.Object getEdgeSourceColumn()

name or index (starting from 1) of column corresponding to edge source (for CSV format only)

Specified by:

getEdgeSourceColumn in class AbstractFileGraphConfig

getEdgeUris

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

list of unified resource identifiers

Specified by:

getEdgeUris in class AbstractFileGraphConfig

Returns:

the list of URIs

getErrorHandling

public GraphErrorHandlingConfig getErrorHandling()

error handling configuration

Returns:

the error handling configuration

getExternalStores

public java.util.List<ExternalStoreConfig> getExternalStores()

Specification of the external stores where external string properties reside.

Specified by:

getExternalStores in class AbstractFileGraphConfig

getFormat

public Format getFormat()

graph format

Returns:

the format

getKeystoreAlias

public java.lang.String getKeystoreAlias()

alias to the keystore to use when connecting to database

Returns:

the keystore alias or null if underlying format does not require a keystore

getLoading

public GraphLoadingConfig getLoading()

loading-specific configuration

Specified by:

getLoading in class GraphConfig

Returns:

the loading configuration

getLocalDateFormat

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

array of local_date formats to use when loading and storing local_date properties. Please see DateTimeFormatter for a documentation of the format string

Returns:

the date format

getOptimizedFor

public GraphOptimizedFor getOptimizedFor()

Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates

Specified by:

getOptimizedFor in class GraphConfig

Returns:

by_label if the graph should be partitioned during loading, false Indicates if the graph should use data-structures optimized for fast updates

getPartitionWhileLoading

public PartitionWhileLoading getPartitionWhileLoading()

Indicates if the graph should be partitioned while loading

Specified by:

getPartitionWhileLoading in class GraphConfig

Returns:

true if the graph should be heterogenized during loading, false or null otherwise

getPoint2d

public java.lang.String getPoint2d()

longitude and latitude as floating point values separated by a space

getSeparator

public java.lang.String getSeparator()

a series of single-character separators for tokenizing. The characters ", {, } and \n cannot be used as separators. Default value is "," for CSV files, and "\t " for other formats. The first character will be used as a separator when storing.

Specified by:

getSeparator in class AbstractFileGraphConfig

Returns:

the separator

getStoring

public FileGraphStoringConfig getStoring()

storing-specific configuration

Specified by:

getStoring in class AbstractFileGraphConfig

Returns:

the storing configuration

getTimeFormat

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

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

Returns:

the time format

getTimestampFormat

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

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

Returns:

the timestamp format

getTimestampWithTimezoneFormat

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

the timestamp with timezone format to use when loading and storing timestamp with timezone properties. Please see DateTimeFormatter for a documentation of the format string

Returns:

the timestamp with timezone format

getTimeWithTimezoneFormat

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

the time with timezone format to use when loading and storing time with timezone properties. Please see DateTimeFormatter for a documentation of the format string

Returns:

the time with timezone format

getValues

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

Gets the parsed values.

Returns:

the parsed values

getValuesWithoutDefaults

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

Gets the values without defaults.

Returns:

the values without defaults

getVectorComponentDelimiter

public java.lang.Character getVectorComponentDelimiter()

delimiter for the different components of vector properties

getVertexIdColumn

public java.lang.Object getVertexIdColumn()

name or index (starting from 1) of column corresponding to vertex id (for CSV format only)

Specified by:

getVertexIdColumn in class AbstractFileGraphConfig

getVertexIdStrategy

public IdStrategy getVertexIdStrategy()

Indicates what ID strategy should be used for the vertices of this graph. If not specified (or set to null), the strategy will be automatically detected

Returns:

the ID strategy used for the vertices of the graph

getVertexIdType

public IdType getVertexIdType()

type of the vertex ID. For homogeneous graphs, if not specified (or set to null), it will default to a specific value (depending on the origin of the data).

Specified by:

getVertexIdType in class GraphConfig

Returns:

the vertex ID type

getVertexLabelsColumn

public java.lang.Object getVertexLabelsColumn()

name or index (starting from 1) of column corresponding to vertex labels (for CSV format only)

Specified by:

getVertexLabelsColumn in class AbstractFileGraphConfig

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

getVertexUris

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

list of unified resource identifiers

Specified by:

getVertexUris in class AbstractFileGraphConfig

Returns:

the list of URIs

hasDefaultValue

public boolean hasDefaultValue(FileGraphConfig.Field field)

Checks for default value.

Parameters:

field - the field

Returns:

true, if value for given field is the default value

isDetectGzip

public java.lang.Boolean isDetectGzip()

enable/disable automatic gzip compression detection when loading graphs

Specified by:

isDetectGzip in class AbstractFileGraphConfig

Returns:

true if GZip file automatic detection is enabled, false otherwise.

isEmpty

public boolean isEmpty()

Checks if it's empty.

Returns:

true, if the Map 'values' is empty.

isHeader

public java.lang.Boolean isHeader()

first line of file is meant for headers, e.g. 'EdgeId, SourceId, DestId, EdgeProp1, EdgeProp2'

Specified by:

isHeader in class AbstractFileGraphConfig

Returns:

Whether the file has a header or not

parse

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

toString

public java.lang.String toString(boolean hideSensitiveData)