Package oracle.pgx.config

Interface ReadGraphOption

All Known Implementing Classes:

ReadGraphOption.OnMissingVertexOption, ReadGraphOption.OptimizedForOption, ReadGraphOption.ParallelHintDegreeReadGraphOption, ReadGraphOption.PropertyLoadingOption, ReadGraphOption.SynchronizableOptionReadGraphOption

public interface ReadGraphOption

Interface for specifying options for PgxSession#readGraphByName(String, GraphSource, ReadGraphOption...)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ReadGraphOption.OnMissingVertexOption	Class for encapsulating a OnMissingVertex config option
static class	ReadGraphOption.OptimizedForOption	Class for encapsulating a GraphOptimizedFor config option
static class	ReadGraphOption.ParallelHintDegreeReadGraphOption	Class for encapsulating the ParallelHintDegree config option
static enum	ReadGraphOption.PropertyLoadingMode
static class	ReadGraphOption.PropertyLoadingOption
static class	ReadGraphOption.ReadGraphOptionDataBuilder
static class	ReadGraphOption.SynchronizableOptionReadGraphOption	Class for option, which specifies if graph cannot be synchronized, PGX will throw an Exception

Field Summary

Fields

Modifier and Type	Field	Description
static final ReadGraphOption.OnMissingVertexOption	ON_MISSING_VERTEX_ERROR
static final ReadGraphOption.OnMissingVertexOption	ON_MISSING_VERTEX_IGNORE_EDGE
static final ReadGraphOption.OnMissingVertexOption	ON_MISSING_VERTEX_IGNORE_EDGE_LOG
static final ReadGraphOption.OnMissingVertexOption	ON_MISSING_VERTEX_IGNORE_EDGE_LOG_ONCE
static final ReadGraphOption.OptimizedForOption	OPTIMIZED_FOR_READ
static final ReadGraphOption.OptimizedForOption	OPTIMIZED_FOR_UPDATES
static final ReadGraphOption.SynchronizableOptionReadGraphOption	SYNCHRONIZABLE

Method Summary

Modifier and Type	Method	Description
static ReadGraphOption.PropertyLoadingOption	allProperties()	Creates an option, to load the graph with all properties.
void	apply(ReadGraphOption.ReadGraphOptionDataBuilder holder)
static ReadGraphOption.PropertyLoadingOption	excludeProperties(Map<String,List<String>> propertyFilter)	Creates an option, to load the graph without the excluded properties.
static ReadGraphOption.PropertyLoadingOption	includeProperties(Map<String,List<String>> propertyFilter)	Creates an option, that specifies which properties should be loaded with the graph.
static ReadGraphOption.OnMissingVertexOption	onMissingVertex(OnMissingVertex onMissingVertex)	Creates an option, which specifies the behavior when the source or destination vertex of an edge is missing
static ReadGraphOption.OptimizedForOption	optimizeFor(GraphOptimizedFor optimizedFor)	Creates an option, which specifies whether a graph should be optimized for read or update
static ReadGraphOption.SynchronizableOptionReadGraphOption	synchronizable()	Creates an option, which specifies if a graph cannot be synchronized, PGX will throw an Exception
static ReadGraphOption.PropertyLoadingOption	topologyOnly()	Creates an option, to load the graph without properties.
static <T extends ReadGraphOption> void	validateUnique(Collection<ReadGraphOption> options, Class<T> clazz, String errorMessage)	Validates a given option list to contain only one item of the specified type.
static ReadGraphOption.ParallelHintDegreeReadGraphOption	withParallelHintDegree(int parallelHintDegree)	Creates an option, which specifies the parallel hint degree to use for internal queries

Field Details

OPTIMIZED_FOR_UPDATES

static final ReadGraphOption.OptimizedForOption OPTIMIZED_FOR_UPDATES

OPTIMIZED_FOR_READ

static final ReadGraphOption.OptimizedForOption OPTIMIZED_FOR_READ

SYNCHRONIZABLE

static final ReadGraphOption.SynchronizableOptionReadGraphOption SYNCHRONIZABLE

ON_MISSING_VERTEX_IGNORE_EDGE

static final ReadGraphOption.OnMissingVertexOption ON_MISSING_VERTEX_IGNORE_EDGE

ON_MISSING_VERTEX_IGNORE_EDGE_LOG

static final ReadGraphOption.OnMissingVertexOption ON_MISSING_VERTEX_IGNORE_EDGE_LOG

ON_MISSING_VERTEX_IGNORE_EDGE_LOG_ONCE

static final ReadGraphOption.OnMissingVertexOption ON_MISSING_VERTEX_IGNORE_EDGE_LOG_ONCE

ON_MISSING_VERTEX_ERROR

static final ReadGraphOption.OnMissingVertexOption ON_MISSING_VERTEX_ERROR

Method Details

validateUnique

static <T extends ReadGraphOption> void validateUnique(Collection<ReadGraphOption> options,
 Class<T> clazz,
 String errorMessage)

Validates a given option list to contain only one item of the specified type.

Parameters:

options - the list of options to validate

clazz - the type of option to look for

errorMessage - the error message to be thrown when validation fails

optimizeFor

static ReadGraphOption.OptimizedForOption optimizeFor(GraphOptimizedFor optimizedFor)

Creates an option, which specifies whether a graph should be optimized for read or update

Parameters:

optimizedFor - specifies what the graph should be optimized for (read or update)

Returns:

the option, which encapsulates the optimizedFor parameter

onMissingVertex

static ReadGraphOption.OnMissingVertexOption onMissingVertex(OnMissingVertex onMissingVertex)

Creates an option, which specifies the behavior when the source or destination vertex of an edge is missing

Parameters:

onMissingVertex - specifies the behavior when the source or destination vertex of an edge is missing

Returns:

the option, which encapsulates the onMissingVertex option

withParallelHintDegree

static ReadGraphOption.ParallelHintDegreeReadGraphOption withParallelHintDegree(int parallelHintDegree)

Creates an option, which specifies the parallel hint degree to use for internal queries

Parameters:

parallelHintDegree - specifies the parallel hint degree to use for internal queries

Returns:

the option, which encapsulates the parallelHintDegree option

synchronizable

static ReadGraphOption.SynchronizableOptionReadGraphOption synchronizable()

Creates an option, which specifies if a graph cannot be synchronized, PGX will throw an Exception

includeProperties

static ReadGraphOption.PropertyLoadingOption includeProperties(Map<String,List<String>> propertyFilter)

Creates an option, that specifies which properties should be loaded with the graph.

excludeProperties

static ReadGraphOption.PropertyLoadingOption excludeProperties(Map<String,List<String>> propertyFilter)

Creates an option, to load the graph without the excluded properties.

topologyOnly

static ReadGraphOption.PropertyLoadingOption topologyOnly()

Creates an option, to load the graph without properties.

allProperties

static ReadGraphOption.PropertyLoadingOption allProperties()

Creates an option, to load the graph with all properties.

apply

void apply(ReadGraphOption.ReadGraphOptionDataBuilder holder)