oracle.pgx.config

Class AbstractGraphConfigBuilder<T extends AbstractGraphConfigBuilder<T,GC>,GC extends GraphConfig>

java.lang.Object

oracle.pgx.config.AbstractGraphConfigBuilder<T,GC>

Type Parameters:

T - which graph configuration object this builder will produce

Direct Known Subclasses:

AbstractFileGraphConfigBuilder, AbstractPgGraphConfigBuilder, RdfGraphConfigBuilder, TwoTablesRdbmsGraphConfigBuilder, TwoTablesSparkGraphConfigBuilder

public abstract class AbstractGraphConfigBuilder<T extends AbstractGraphConfigBuilder<T,GC>,GC extends GraphConfig>
extends java.lang.Object

base class for graph configuration builder classes

Constructor Summary

Constructors

Constructor and Description
AbstractGraphConfigBuilder() default constructor

Method Summary

Modifier and Type	Method and Description
T	addAttribute(java.lang.String key, java.lang.String value) Adds a specific additional attribute to this config
T	addEdgeProperty(java.lang.String name, PropertyType type) Convenience method for addEdgeProperty(String, PropertyType, Object).
T	addEdgeProperty(java.lang.String name, PropertyType type, java.lang.Object defaultVal) Adds an edge property to this builder
T	addNodeProperty(java.lang.String name, PropertyType type) Alias for addVertexProperty(String, PropertyType).
T	addNodeProperty(java.lang.String name, PropertyType type, java.lang.Object defaultVal) Alias for addVertexProperty(String, PropertyType, Object).
T	addVertexProperty(java.lang.String name, PropertyType type) Convenience method for addVertexProperty(String, PropertyType, Object).
T	addVertexProperty(java.lang.String name, PropertyType type, java.lang.Object defaultVal) Add a vertex property to this builder
GC	build() Build the graph configuration object
T	clearEdgeProperties() Removes all edge properties from this builder
T	clearVertexProperties() Removes all vertex properties from this builder
T	copyBaseFrom(GraphConfig graphConfig) Sets this builder with the values of the given graph config, this only includes base settings (format, temporal formats, vertex properties, edge properties, loading configuration and error handling configuration).
T	copyFrom(GC graphConfig) Sets this builder with all the values of the given graph config.
T	removeEdgeProperty(java.lang.String name) Removes an edge property from this builder
T	removeVertexProperty(java.lang.String name) Removes a vertex property from this builder
T	setAutoRefresh(boolean autoRefresh)
T	setCreateEdgeIdIndex(boolean create) Sets the create edge id index flag.
T	setCreateEdgeIdMapping(boolean create) Sets the create edge id mapping.
T	setCreateVertexIdIndex(boolean create) Sets the create vertex ID index flag.
T	setCreateVertexIdMapping(boolean create) Sets the create vertex id mapping flag.
T	setDateFormat(java.lang.String dateFormat) Sets the date format used for loading and storing the graph.
T	setErrorHandlingOnMissedPropKey(OnMismatch action) Sets the error handling on missed prop key.
T	setErrorHandlingOnMissingVertex(OnMissingVertex action) Sets the error handling on a missing vertex.
T	setErrorHandlingOnPropConversion(OnMismatch action) Sets the error handling on prop conversion.
T	setErrorHandlingOnTypeMismatch(OnMismatch action) Sets the error handling on type mismatch.
T	setFetchIntervalSec(int seconds) Sets the refresh interval in seconds.
T	setFilter(GraphFilter filter)
T	setFilterStrategy(FilterStrategy filterStrategy)
T	setLabelValueDelimiter(java.lang.String delimiter) if null read the whole String value as label.
T	setLoadEdgeLabel(boolean flag) Sets the edge label loading.
T	setLoadVertexLabels(boolean flag) Sets the vertex label loading.
T	setLocalDateFormat(java.util.List<java.lang.String> localDateFormatList) Sets the list of local_date formats used for loading and storing the graph.
T	setPropertyValueDelimiter(java.lang.String delimiter) (only relevant for use_vertex_property_value_as_label) if null read the whole property value as label.
T	setSkipEdgeLoading(boolean flag) Sets the skip edges flag.
T	setSkipVertexLoading(boolean flag) Sets the skip vertices flag.
T	setStrictMode(boolean strictMode) Sets the strict mode.
T	setTimeFormat(java.util.List<java.lang.String> timeFormatList) Sets the list of time formats used for loading and storing the graph.
T	setTimestampFormat(java.util.List<java.lang.String> timestampFormatList) Sets the list timestamp formats used for loading and storing the graph.
T	setTimestampWithTimezoneFormat(java.util.List<java.lang.String> timestampWithTimezoneFormatList) Sets the list of timestamp with timezone formats used for loading and storing the graph.
T	setTimeWithTimezoneFormat(java.util.List<java.lang.String> timeWithTimezoneFormatList) Sets the list of time with timezone formats used for loading and storing the graph.
T	setUpdateIntervalSec(int seconds)
T	setUpdateThreshold(int threshold)
T	setUseVertexPropertyValueAsLabel(java.lang.String labelPropertyName) Load the given property as vertex label.
T	setVertexIdType(IdType vertexIdType) Sets the type of vertex IDs

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractGraphConfigBuilder

public AbstractGraphConfigBuilder()

default constructor

Method Detail

addAttribute

public T addAttribute(java.lang.String key,
                      java.lang.String value)

Adds a specific additional attribute to this config

Parameters:

key - the attribute's key

value - the attribute's value

Returns:

this builder

addEdgeProperty

public T addEdgeProperty(java.lang.String name,
                         PropertyType type)

Convenience method for addEdgeProperty(String, PropertyType, Object).

Parameters:

name - the name of the edge property

type - the type of the edge property

Returns:

this builder

addEdgeProperty

public T addEdgeProperty(java.lang.String name,
                         PropertyType type,
                         java.lang.Object defaultVal)

Adds an edge property to this builder

Parameters:

name - the name of the edge property

type - the type of the edge property

defaultVal - the default value of the edge property (can be null)

Returns:

this builder

addNodeProperty

public T addNodeProperty(java.lang.String name,
                         PropertyType type)

Alias for addVertexProperty(String, PropertyType).

Parameters:

name -

type -

Returns:

this builder

addNodeProperty

public T addNodeProperty(java.lang.String name,
                         PropertyType type,
                         java.lang.Object defaultVal)

Alias for addVertexProperty(String, PropertyType, Object).

Parameters:

name -

type -

defaultVal -

Returns:

this builder

addVertexProperty

public T addVertexProperty(java.lang.String name,
                           PropertyType type)

Convenience method for addVertexProperty(String, PropertyType, Object).

Parameters:

name - the name of the vertex property

type - the type of the vertex property

Returns:

this builder

addVertexProperty

public T addVertexProperty(java.lang.String name,
                           PropertyType type,
                           java.lang.Object defaultVal)

Add a vertex property to this builder

Parameters:

name - the name of the vertex property

type - the type of the vertex property

defaultVal - the default value of the vertex property (can be null)

Returns:

this builder

build

public GC build()

Build the graph configuration object

Returns:

the graph configuration object

clearEdgeProperties

public T clearEdgeProperties()

Removes all edge properties from this builder

Returns:

this builder

clearVertexProperties

public T clearVertexProperties()

Removes all vertex properties from this builder

Returns:

this builder

copyBaseFrom

public final T copyBaseFrom(GraphConfig graphConfig)

Sets this builder with the values of the given graph config, this only includes base settings (format, temporal formats, vertex properties, edge properties, loading configuration and error handling configuration). If a format was already specified it will remain unchanged, however any other values copied from the given graph config will overwrite the corresponding values of this builder.

Parameters:

graphConfig - the graph configuration from which to copy the values

Returns:

this builder

copyFrom

public T copyFrom(GC graphConfig)

Sets this builder with all the values of the given graph config. If a format was already specified it will remain unchanged, however any other values copied from the given graph config will overwrite the corresponding values of this builder.

Parameters:

graphConfig - the graph configuration from which to copy the values

Returns:

this builder

removeEdgeProperty

public T removeEdgeProperty(java.lang.String name)

Removes an edge property from this builder

Parameters:

name - the name of the edge property

Returns:

this builder

removeVertexProperty

public T removeVertexProperty(java.lang.String name)

Removes a vertex property from this builder

Parameters:

name - the name of the vertex property

Returns:

this builder

setAutoRefresh

public T setAutoRefresh(boolean autoRefresh)

setCreateEdgeIdIndex

public T setCreateEdgeIdIndex(boolean create)

Sets the create edge id index flag. See the graph configuration documentation for details about the effects and default of this flag

Parameters:

create - if true, a edge ID index is created

Returns:

this builder

setCreateEdgeIdMapping

public T setCreateEdgeIdMapping(boolean create)

Sets the create edge id mapping. See the graph configuration documentation for details about the effects and default of this flag

Parameters:

create - if true, a edge ID mapping is created

Returns:

this builder

setCreateVertexIdIndex

public T setCreateVertexIdIndex(boolean create)

Sets the create vertex ID index flag. See the graph configuration documentation for details about the effects and default of this flag

Parameters:

create - if true, a vertex ID index is created

Returns:

this builder

setCreateVertexIdMapping

public T setCreateVertexIdMapping(boolean create)

Sets the create vertex id mapping flag. See the graph configuration documentation for details about the effects and default of this flag

Parameters:

create - if true, a vertex ID mapping is created

Returns:

this builder

setDateFormat

public T setDateFormat(java.lang.String dateFormat)

Sets the date format used for loading and storing the graph. See the graph configuration documentation for details about the effects and default of this flag

Parameters:

dateFormat - the date format

Returns:

this builder

setErrorHandlingOnMissedPropKey

public T setErrorHandlingOnMissedPropKey(OnMismatch action)

Sets the error handling on missed prop key. See the graph configuration documentation for details about the effects and default of this flag

Parameters:

action - the action

Returns:

this builder

setErrorHandlingOnMissingVertex

public T setErrorHandlingOnMissingVertex(OnMissingVertex action)

Sets the error handling on a missing vertex. See the graph configuration documentation for details about the effects and default of this flag

Parameters:

action - the action

Returns:

this builder

setErrorHandlingOnPropConversion

public T setErrorHandlingOnPropConversion(OnMismatch action)

Sets the error handling on prop conversion. See the graph configuration documentation for details about the effects and default of this flag

Parameters:

action - the action

Returns:

this builder

setErrorHandlingOnTypeMismatch

public T setErrorHandlingOnTypeMismatch(OnMismatch action)

Sets the error handling on type mismatch. See the graph configuration documentation for details about the effects and default of this flag

Parameters:

action - the action

Returns:

this builder

setFetchIntervalSec

public T setFetchIntervalSec(int seconds)

Sets the refresh interval in seconds. See the graph configuration documentation for details about the effects and default of this flag

Parameters:

seconds - the interval in seconds

Returns:

this builder

setFilter

public T setFilter(GraphFilter filter)

setFilterStrategy

public T setFilterStrategy(FilterStrategy filterStrategy)

setLabelValueDelimiter

public T setLabelValueDelimiter(java.lang.String delimiter)

if null read the whole String value as label. Otherwise, split the string using the specified delimiter and use all values as vertex labels

Parameters:

delimiter - the delimiter to use. If null read the whole String value as label

Returns:

this builder

setLoadEdgeLabel

public T setLoadEdgeLabel(boolean flag)

Sets the edge label loading. See the graph configuration documentation for details about the effects and default of this flag.

Parameters:

flag - sets to load the edge label if true

Returns:

this builder

setLoadVertexLabels

public T setLoadVertexLabels(boolean flag)

Sets the vertex label loading. See the graph configuration documentation for details about the effects and default of this flag.

Parameters:

flag - sets to load the vertex label if true

Returns:

this builder

setLocalDateFormat

public T setLocalDateFormat(java.util.List<java.lang.String> localDateFormatList)

Sets the list of local_date formats used for loading and storing the graph.

Parameters:

localDateFormatList - the list of date formats

Returns:

this builder

setPropertyValueDelimiter

public T setPropertyValueDelimiter(java.lang.String delimiter)

(only relevant for use_vertex_property_value_as_label) if null read the whole property value as label. Otherwise, split the string using the specified delimiter and use all values as vertex labels

Parameters:

delimiter - the delimiter to use. If null read the whole property as label

Returns:

this builder

setSkipEdgeLoading

public T setSkipEdgeLoading(boolean flag)

Sets the skip edges flag. See the graph configuration documentation for details about the effects and default of this flag.

Parameters:

flag - sets to skip the edges if true

Returns:

this builder

setSkipVertexLoading

public T setSkipVertexLoading(boolean flag)

Sets the skip vertices flag. See the graph configuration documentation for details about the effects and default of this flag.

Parameters:

flag - sets to skip the vertices if true

Returns:

this builder

setStrictMode

public T setStrictMode(boolean strictMode)

Sets the strict mode. See the graph configuration documentation for details about the effects and default of this flag

Parameters:

strictMode - if true, strict mode is enabled, otherwise strict mode is disabled

Returns:

this builder

setTimeFormat

public T setTimeFormat(java.util.List<java.lang.String> timeFormatList)

Sets the list of time formats used for loading and storing the graph.

Parameters:

timeFormatList - the list of date formats

Returns:

this builder

setTimestampFormat

public T setTimestampFormat(java.util.List<java.lang.String> timestampFormatList)

Sets the list timestamp formats used for loading and storing the graph.

Parameters:

timestampFormatList - the list of date formats

Returns:

this builder

setTimestampWithTimezoneFormat

public T setTimestampWithTimezoneFormat(java.util.List<java.lang.String> timestampWithTimezoneFormatList)

Sets the list of timestamp with timezone formats used for loading and storing the graph.

Parameters:

timestampWithTimezoneFormatList - the list of date formats

Returns:

this builder

setTimeWithTimezoneFormat

public T setTimeWithTimezoneFormat(java.util.List<java.lang.String> timeWithTimezoneFormatList)

Sets the list of time with timezone formats used for loading and storing the graph.

Parameters:

timeWithTimezoneFormatList - the list of date formats

Returns:

this builder

setUpdateIntervalSec

public T setUpdateIntervalSec(int seconds)

setUpdateThreshold

public T setUpdateThreshold(int threshold)

setUseVertexPropertyValueAsLabel

public T setUseVertexPropertyValueAsLabel(java.lang.String labelPropertyName)

Load the given property as vertex label. Currently only available for loading from PG

Parameters:

labelPropertyName - the name of the property to load as label

Returns:

this builder

setVertexIdType

public T setVertexIdType(IdType vertexIdType)

Sets the type of vertex IDs

Parameters:

vertexIdType - the type of vertex IDs

Returns:

this builder

See Also:

"the graph configuration documentation for details about the effects and default of this setting"