GraphConfig (Oracle Graph Java API Reference Release 20.3 (F15858-03))

java.lang.Object
- oracle.pgx.config.AbstractConfig
- - oracle.pgx.config.GraphConfig

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractFileGraphConfig, AbstractMultipleTablesConfig, AbstractPartitionedGraphConfig, AbstractPgGraphConfig, AbstractRdfGraphConfig, AbstractTwoTablesRdbmsGraphConfig
```
public abstract class GraphConfig
extends AbstractConfig
implements CommonLoadableConfig<Format>, oracle.pgx.config.internal.ConvertibleToGraphConfigBuilder
```
abstract super-class for all graph configs

Field Summary
- Fields inherited from class oracle.pgx.config.AbstractConfig
  ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Constructor Summary

Constructors
Constructor and Description

GraphConfig()

Constructors
Constructor and Description
`GraphConfig()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract java.lang.Double`	`getArrayCompactionThreshold()` For graphs optimized for updates, the value corresponds to the ratio at which the delta-logs are compacted into new arrays.
`IdType`	`getEdgeIdType()` Get the edge ID type of this graph configuration
`java.lang.Object`	`getEdgePropertyDefault(int i)` Get the default value of a edge property by index
`int`	`getEdgePropertyDimension(int i)` Get the dimension of a edge property by index
`java.lang.String`	`getEdgePropertyName(int i)` Get the name of a edge property by index
`PropertyType`	`getEdgePropertyType(int i)` Get the name of a edge property by index
`java.util.Map<java.lang.String,PropertyType>`	`getEdgePropertyTypes()`
`abstract java.util.List<GraphPropertyConfig>`	`getEdgeProps()` Get the vertex properties of this graph configuration
`abstract java.util.List<ExternalStoreConfig>`	`getExternalStores()`
`java.util.Optional<GraphFilter>`	`getLoadingFilter()`
`GraphLoadingConfig`	`getLoadingOptions()` Get the loading configuration of this graph configuration
`IdType`	`getNodeKeyType()` alias for `getVertexIdType()`
`java.lang.Object`	`getNodePropertyDefault(int i)` Get the default value of a vertex property by index
`int`	`getNodePropertyDimension(int i)` Get the dimension of a node property by index
`java.lang.String`	`getNodePropertyName(int i)` Get the name of a vertex property by index
`PropertyType`	`getNodePropertyType(int i)` Get the type of a vertex property by index
`abstract GraphOptimizedFor`	`getOptimizedFor()` Indicates if the graph should be partitioned during loading
`abstract PartitionWhileLoading`	`getPartitionWhileLoading()` Indicates if the graph should be heterogenized during loading
`IdStrategy`	`getValidatedEdgeIdStrategy()` Validates and return the ID strategy used for edges (checking if the strategy is compatible with the rest of the graph configuration)
`IdType`	`getValidatedEdgeIdType()` Validates and return the ID type used for edges (checking if the type is compatible with the rest of the configuration)
`IdStrategy`	`getValidatedVertexIdStrategy()` Validates and return the ID strategy used for vertices (checking if the strategy is compatible with the rest of the graph configuration)
`IdType`	`getValidatedVertexIdType()` Validates and return the ID type used for vertices (checking if the type is compatible with the rest of the configuration)
`abstract IdType`	`getVertexIdType()` Get the vertex ID type of this graph configuration
`java.util.Map<java.lang.String,PropertyType>`	`getVertexPropertyTypes()`
`abstract java.util.List<GraphPropertyConfig>`	`getVertexProps()` Get the vertex properties of this graph configuration
`int`	`hashCode()`
`boolean`	`hasVerticesAndEdgesSeparatedFileFormat()` Check if this graph configuration has vertices and edges separated in different files
`static boolean`	`hasVerticesAndEdgesSeparatedFileFormat(Format format)` Check if a format has vertices and edges separated in different files
`boolean`	`isEdgeLabelLoadingEnabled()`
`boolean`	`isFileFormat()` Check if this graph configuration is a file-based configuration.
`static boolean`	`isFileFormat(Format format)` Check if a format is a file-based format
`boolean`	`isLoadEdgeKeys()`
`boolean`	`isLoadVertexKeys()`
`boolean`	`isMultipleFileFormat()` Check if this graph configuration has vertices and edges separated in different files
`static boolean`	`isMultipleFileFormat(Format format)` Check if a format has vertices and edges separated in different files
`boolean`	`isSingleFileFormat()` Check if this graph configuration has vertices and edges combined in same file
`static boolean`	`isSingleFileFormat(Format format)` Check if a format has vertices and edges combined in same file
`boolean`	`isVertexLabelsLoadingEnabled()`
`int`	`numEdgeProperties()` Get the number of edge properties in this graph configuration
`int`	`numNodeProperties()` Get the number of vertex properties in this graph configuration
`boolean`	`skipEdgeLoading()`
`boolean`	`skipVertexLoading()`
`boolean`	`supportsEdgeLabel()` Check if this graph configuration's format supports having an edge label or not
`static boolean`	`supportsEdgeLabel(Format format)` Check if a format supports having an edge label or not
`boolean`	`supportsPropertyColumn()` Check if this graph configuration's format supports having a column indication for properties
`static boolean`	`supportsPropertyColumn(Format format)` Check if a format support having a column indication for properties
`boolean`	`supportsVectorProperties()` Check if this graph configuration's format supports having vector properties or not
`static boolean`	`supportsVectorProperties(Format format)` Check if a format support having vector properties or not
`boolean`	`supportsVertexLabels()` Check if this graph configuration's format supports having an vertex labels or not
`static boolean`	`supportsVertexLabels(Format format)` Check if a format support having an vertex labels or not

Methods inherited from class oracle.pgx.config.AbstractConfig
getDefault, getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object
equals, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.pgx.config.CommonLoadableConfig
createLocalDateFormat, createTimeFormat, createTimestampFormat, createTimestampWithTimezoneFormat, createTimeWithTimezoneFormat, getAttributes, getErrorHandling, getFormat, getKeystoreAlias, getLocalDateFormat, getName, getTimeFormat, getTimestampFormat, getTimestampWithTimezoneFormat, getTimeWithTimezoneFormat, getVectorComponentDelimiter

Methods inherited from interface oracle.pgx.config.internal.ConvertibleToGraphConfigBuilder
toGraphConfigBuilder

- Constructor Detail
  - GraphConfig
```
public GraphConfig()
```
- Method Detail
  - getArrayCompactionThreshold
```
public abstract java.lang.Double getArrayCompactionThreshold()
```
    For graphs optimized for updates, the value corresponds to the ratio at which the delta-logs are compacted into new arrays.
    
    Returns:
    
    the compaction threshold
  - getEdgeIdType
```
public IdType getEdgeIdType()
```
    Get the edge ID type of this graph configuration
    
    Returns:
    
    the edge ID type
  - getEdgePropertyDefault
```
public java.lang.Object getEdgePropertyDefault(int i)
```
    Get the default value of a edge property by index
    
    Parameters:
    
    i - the 0-based index of the edge property
    
    Returns:
    
    the default value of the edge property
  - getEdgePropertyDimension
```
public int getEdgePropertyDimension(int i)
```
    Get the dimension of a edge property by index
    
    Parameters:
    
    i - the 0-based index of the edge property
    
    Returns:
    
    the dimension of the edge property
  - getEdgePropertyName
```
public java.lang.String getEdgePropertyName(int i)
```
    Get the name of a edge property by index
    
    Parameters:
    
    i - the 0-based index of the edge property
    
    Returns:
    
    the name of the edge property
  - getEdgePropertyType
```
public PropertyType getEdgePropertyType(int i)
```
    Get the name of a edge property by index
    
    Parameters:
    
    i - the 0-based index of the edge property
    
    Returns:
    
    the name of the edge property
  - getEdgePropertyTypes
```
public java.util.Map<java.lang.String,PropertyType> getEdgePropertyTypes()
```
    Returns:
    
    a mapping from edge property name to property type
  - getEdgeProps
```
public abstract java.util.List<GraphPropertyConfig> getEdgeProps()
```
    Get the vertex properties of this graph configuration
    
    Returns:
    
    the list of vertex properties
  - getExternalStores
```
public abstract java.util.List<ExternalStoreConfig> getExternalStores()
```
  - getLoadingFilter
```
public java.util.Optional<GraphFilter> getLoadingFilter()
```
    Returns:
    
    the loading graph filter if one is present. Optional.empty() otherwise
  - getLoadingOptions
```
public GraphLoadingConfig getLoadingOptions()
```
    Get the loading configuration of this graph configuration
    
    Returns:
    
    the loading configuration
  - getNodeKeyType
```
public IdType getNodeKeyType()
```
    alias for getVertexIdType()
    
    Returns:
    
    the vertex ID type of this graph configuration
  - getNodePropertyDefault
```
public java.lang.Object getNodePropertyDefault(int i)
```
    Get the default value of a vertex property by index
    
    Parameters:
    
    i - the 0-based index of the vertex property
    
    Returns:
    
    the default value of the vertex property
  - getNodePropertyDimension
```
public int getNodePropertyDimension(int i)
```
    Get the dimension of a node property by index
    
    Parameters:
    
    i - the 0-based index of the node property
    
    Returns:
    
    the dimension of the node property
  - getNodePropertyName
```
public java.lang.String getNodePropertyName(int i)
```
    Get the name of a vertex property by index
    
    Parameters:
    
    i - the 0-based index of the vertex property
    
    Returns:
    
    the name of the vertex property
  - getNodePropertyType
```
public PropertyType getNodePropertyType(int i)
```
    Get the type of a vertex property by index
    
    Parameters:
    
    i - the 0-based index of the vertex property
    
    Returns:
    
    the type of the vertex property
  - getOptimizedFor
```
public abstract GraphOptimizedFor getOptimizedFor()
```
    Indicates if the graph should be partitioned during loading
    
    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 abstract PartitionWhileLoading getPartitionWhileLoading()
```
    Indicates if the graph should be heterogenized during loading
    
    Returns:
    
    true if the graph should be heterogenized during loading, false or null otherwise
  - getValidatedEdgeIdStrategy
```
public IdStrategy getValidatedEdgeIdStrategy()
```
    Validates and return the ID strategy used for edges (checking if the strategy is compatible with the rest of the graph configuration)
    
    Returns:
    
    the ID strategy that can be used for the edges of the graph
  - getValidatedEdgeIdType
```
public IdType getValidatedEdgeIdType()
```
    Validates and return the ID type used for edges (checking if the type is compatible with the rest of the configuration)
    
    Returns:
    
    the ID type that can be used for the edges of the graph
  - getValidatedVertexIdStrategy
```
public IdStrategy getValidatedVertexIdStrategy()
```
    Validates and return the ID strategy used for vertices (checking if the strategy is compatible with the rest of the graph configuration)
    
    Returns:
    
    the ID strategy that can be used for the vertices of the graph
  - getValidatedVertexIdType
```
public IdType getValidatedVertexIdType()
```
    Validates and return the ID type used for vertices (checking if the type is compatible with the rest of the configuration)
    
    Returns:
    
    the ID type that can be used for the vertices of the graph
  - getVertexIdType
```
public abstract IdType getVertexIdType()
```
    Get the vertex ID type of this graph configuration
    
    Returns:
    
    the vertex ID type
  - getVertexPropertyTypes
```
public java.util.Map<java.lang.String,PropertyType> getVertexPropertyTypes()
```
    Returns:
    
    a mapping from vertex property name to property type
  - getVertexProps
```
public abstract java.util.List<GraphPropertyConfig> getVertexProps()
```
    Get the vertex properties of this graph configuration
    
    Returns:
    
    the list of vertex properties
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - hasVerticesAndEdgesSeparatedFileFormat
```
public boolean hasVerticesAndEdgesSeparatedFileFormat()
```
    Check if this graph configuration has vertices and edges separated in different files
    
    Returns:
    
    true if this graph configuration's format has vertices and edges separated in different files, false otherwise
  - hasVerticesAndEdgesSeparatedFileFormat
```
public static boolean hasVerticesAndEdgesSeparatedFileFormat(Format format)
```
    Check if a format has vertices and edges separated in different files
    
    Parameters:
    
    format - the format to check
    
    Returns:
    
    true if given format has vertices and edges separated in different files, false otherwise
  - isEdgeLabelLoadingEnabled
```
public boolean isEdgeLabelLoadingEnabled()
```
  - isFileFormat
```
public boolean isFileFormat()
```
    Check if this graph configuration is a file-based configuration.
    
    Returns:
    
    true if this graph configuration has a file-based format, false otherwise
  - isFileFormat
```
public static boolean isFileFormat(Format format)
```
    Check if a format is a file-based format
    
    Parameters:
    
    format - the format to check
    
    Returns:
    
    true if given format is a file-based format, false otherwise
  - isLoadEdgeKeys
```
public boolean isLoadEdgeKeys()
```
  - isLoadVertexKeys
```
public boolean isLoadVertexKeys()
```
  - isMultipleFileFormat
```
public boolean isMultipleFileFormat()
```
    Check if this graph configuration has vertices and edges separated in different files
    
    Returns:
    
    true if this graph configuration's format has vertices and edges separated in different files, false otherwise
  - isMultipleFileFormat
```
public static boolean isMultipleFileFormat(Format format)
```
    Check if a format has vertices and edges separated in different files
    
    Parameters:
    
    format - the format to check
    
    Returns:
    
    true if given format has vertices and edges separated in different files, false otherwise
  - isSingleFileFormat
```
public boolean isSingleFileFormat()
```
    Check if this graph configuration has vertices and edges combined in same file
    
    Returns:
    
    true if this graph configuration's format has vertices and edges combined in same file, false otherwise
  - isSingleFileFormat
```
public static boolean isSingleFileFormat(Format format)
```
    Check if a format has vertices and edges combined in same file
    
    Parameters:
    
    format - the format to check
    
    Returns:
    
    true if given format has vertices and edges combined in same file, false otherwise
  - isVertexLabelsLoadingEnabled
```
public boolean isVertexLabelsLoadingEnabled()
```
  - numEdgeProperties
```
public int numEdgeProperties()
```
    Get the number of edge properties in this graph configuration
    
    Returns:
    
    the number of edge properties
  - numNodeProperties
```
public int numNodeProperties()
```
    Get the number of vertex properties in this graph configuration
    
    Returns:
    
    the number of vertex properties
  - skipEdgeLoading
```
public boolean skipEdgeLoading()
```
  - skipVertexLoading
```
public boolean skipVertexLoading()
```
  - supportsEdgeLabel
```
public boolean supportsEdgeLabel()
```
    Check if this graph configuration's format supports having an edge label or not
    
    Returns:
    
    true if this graph configuration's format supports edge label, false otherwise
  - supportsEdgeLabel
```
public static boolean supportsEdgeLabel(Format format)
```
    Check if a format supports having an edge label or not
    
    Parameters:
    
    format - the format to check
    
    Returns:
    
    true if given format supports edge label, false otherwise
  - supportsPropertyColumn
```
public boolean supportsPropertyColumn()
```
    Check if this graph configuration's format supports having a column indication for properties
    
    Returns:
    
    true if this graph configuration's format supports property columns, false otherwise
  - supportsPropertyColumn
```
public static boolean supportsPropertyColumn(Format format)
```
    Check if a format support having a column indication for properties
    
    Parameters:
    
    format - the format to check
    
    Returns:
    
    true if given format supports property columns, false otherwise
  - supportsVectorProperties
```
public boolean supportsVectorProperties()
```
    Check if this graph configuration's format supports having vector properties or not
    
    Returns:
    
    true if this graph configuration's format supports vector proeprties, false otherwise
  - supportsVectorProperties
```
public static boolean supportsVectorProperties(Format format)
```
    Check if a format support having vector properties or not
    
    Parameters:
    
    format - the format to check
    
    Returns:
    
    true if given format supports vector properties, false otherwise
  - supportsVertexLabels
```
public boolean supportsVertexLabels()
```
    Check if this graph configuration's format supports having an vertex labels or not
    
    Returns:
    
    true if this graph configuration's format supports vertex labels, false otherwise
  - supportsVertexLabels
```
public static boolean supportsVertexLabels(Format format)
```
    Check if a format support having an vertex labels or not
    
    Parameters:
    
    format - the format to check
    
    Returns:
    
    true if given format supports vertex labels, false otherwise

Class GraphConfig

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

Constructor Summary

Method Summary

Methods inherited from class oracle.pgx.config.AbstractConfig

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.pgx.config.CommonLoadableConfig

Methods inherited from interface oracle.pgx.config.internal.ConvertibleToGraphConfigBuilder

Constructor Detail

GraphConfig

Method Detail

getArrayCompactionThreshold

getEdgeIdType

getEdgePropertyDefault

getEdgePropertyDimension

getEdgePropertyName

getEdgePropertyType

getEdgePropertyTypes

getEdgeProps

getExternalStores

getLoadingFilter

getLoadingOptions

getNodeKeyType

getNodePropertyDefault

getNodePropertyDimension

getNodePropertyName

getNodePropertyType

getOptimizedFor

getPartitionWhileLoading

getValidatedEdgeIdStrategy

getValidatedEdgeIdType

getValidatedVertexIdStrategy

getValidatedVertexIdType

getVertexIdType

getVertexPropertyTypes

getVertexProps

hashCode

hasVerticesAndEdgesSeparatedFileFormat

hasVerticesAndEdgesSeparatedFileFormat

isEdgeLabelLoadingEnabled

isFileFormat

isFileFormat

isLoadEdgeKeys

isLoadVertexKeys

isMultipleFileFormat

isMultipleFileFormat

isSingleFileFormat

isSingleFileFormat

isVertexLabelsLoadingEnabled

numEdgeProperties

numNodeProperties

skipEdgeLoading

skipVertexLoading

supportsEdgeLabel

supportsEdgeLabel

supportsPropertyColumn

supportsPropertyColumn

supportsVectorProperties

supportsVectorProperties

supportsVertexLabels

supportsVertexLabels