GraphConfig (Oracle Spatial and Graph In-memory Analyst Java API 18c, E87806-01)

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

Direct Known Subclasses:

AbstractFileGraphConfig, AbstractMultipleTablesConfig, AbstractPgGraphConfig, AbstractRdfGraphConfig, AbstractSparkGraphConfig, AbstractTwoTablesRdbmsGraphConfig
```
public abstract class GraphConfig
extends AbstractConfig
```
abstract super-class for all graph configs

Author:

ksc

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
`java.text.DateFormat`	`createDateFormat()`
`java.util.List<java.time.format.DateTimeFormatter>`	`createLocalDateFormat()`
`java.util.List<java.time.format.DateTimeFormatter>`	`createTimeFormat()`
`java.util.List<java.time.format.DateTimeFormatter>`	`createTimestampFormat()`
`java.util.List<java.time.format.DateTimeFormatter>`	`createTimestampWithTimezoneFormat()`
`java.util.List<java.time.format.DateTimeFormatter>`	`createTimeWithTimezoneFormat()`
`boolean`	`equals(java.lang.Object obj)`
`abstract java.util.Map`	`getAttributes()` Get the specific additional attributes needed to read/write the graph data
`abstract java.lang.String`	`getDateFormat()` The date format to use when loading and storing date properties.
`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 GraphErrorHandlingConfig`	`getErrorHandling()` Get the error handling configuration of this graph configuration
`abstract Format`	`getFormat()` Get the format of this graph configuration
`abstract GraphLoadingConfig`	`getLoading()` Get the loading configuration of this graph configuration
`java.util.Optional<GraphFilter>`	`getLoadingFilter()`
`abstract java.util.List<java.lang.String>`	`getLocalDateFormat()` The list of date formats to use when loading and storing local_date properties.
`abstract java.lang.String`	`getName()` Get the graph name 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 java.util.List<java.lang.String>`	`getTimeFormat()` The list of time formats to use when loading and storing time properties.
`abstract java.util.List<java.lang.String>`	`getTimestampFormat()` The list of timestamp formats to use when loading and storing timestamp properties.
`abstract java.util.List<java.lang.String>`	`getTimestampWithTimezoneFormat()` The list of timestamp with timezone formats to use when loading and storing timestamp with timezone properties.
`abstract java.util.List<java.lang.String>`	`getTimeWithTimezoneFormat()` The list of time with timezone formats to use when loading and storing time with timezone properties.
`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`	`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
getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

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

- Constructor Detail
  - GraphConfig
```
public GraphConfig()
```
- Method Detail
  - createDateFormat
```
public java.text.DateFormat createDateFormat()
```
  - createLocalDateFormat
```
public java.util.List<java.time.format.DateTimeFormatter> createLocalDateFormat()
```
  - createTimeFormat
```
public java.util.List<java.time.format.DateTimeFormatter> createTimeFormat()
```
  - createTimestampFormat
```
public java.util.List<java.time.format.DateTimeFormatter> createTimestampFormat()
```
  - createTimestampWithTimezoneFormat
```
public java.util.List<java.time.format.DateTimeFormatter> createTimestampWithTimezoneFormat()
```
  - createTimeWithTimezoneFormat
```
public java.util.List<java.time.format.DateTimeFormatter> createTimeWithTimezoneFormat()
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - getAttributes
```
public abstract java.util.Map getAttributes()
```
    Get the specific additional attributes needed to read/write the graph data
    
    Returns:
    
    the map of attributes
  - getDateFormat
```
public abstract java.lang.String getDateFormat()
```
    The date format to use when loading and storing date properties. Please see SimpleDateFormat for a documentation of the format string.
    
    Returns:
    
    the date format
  - 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
  - getErrorHandling
```
public abstract GraphErrorHandlingConfig getErrorHandling()
```
    Get the error handling configuration of this graph configuration
    
    Returns:
    
    the error handling configuration
  - getFormat
```
public abstract Format getFormat()
```
    Get the format of this graph configuration
    
    Returns:
    
    the format
  - getLoading
```
public abstract GraphLoadingConfig getLoading()
```
    Get the loading configuration of this graph configuration
    
    Returns:
    
    the loading configuration
  - getLoadingFilter
```
public java.util.Optional<GraphFilter> getLoadingFilter()
```
    Returns:
    
    the loading graph filter if one is present. Optional.empty() otherwise
  - getLocalDateFormat
```
public abstract java.util.List<java.lang.String> getLocalDateFormat()
```
    The list of 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
  - getName
```
public abstract java.lang.String getName()
```
    Get the graph name of this graph configuration. Note: for file-based graph configurations, this is the file name of the URI this configuration points to.
    
    Returns:
    
    the graph name
  - 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
  - getTimeFormat
```
public abstract java.util.List<java.lang.String> getTimeFormat()
```
    The list of time formats to use when loading and storing time properties. Please see DateTimeFormatter for a documentation of the format string.
    
    Returns:
    
    the time format
  - getTimestampFormat
```
public abstract java.util.List<java.lang.String> getTimestampFormat()
```
    The list of timestamp formats to use when loading and storing timestamp properties. Please see DateTimeFormatter for a documentation of the format string.
    
    Returns:
    
    the timestamp format
  - getTimestampWithTimezoneFormat
```
public abstract java.util.List<java.lang.String> getTimestampWithTimezoneFormat()
```
    The list of timestamp with timezone formats 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 abstract java.util.List<java.lang.String> getTimeWithTimezoneFormat()
```
    The list of time with timezone formats 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
  - 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
    
    Parameters:
    
    format - the format to check
    
    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
    
    Parameters:
    
    format - the format to check
    
    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
    
    Parameters:
    
    format - the format to check
    
    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
  - supportsVertexLabels
```
public boolean supportsVertexLabels()
```
    Check if this graph configuration's format supports having an vertex labels or not
    
    Parameters:
    
    format - the format to check
    
    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

Constructor Detail

GraphConfig

Method Detail

createDateFormat

createLocalDateFormat

createTimeFormat

createTimestampFormat

createTimestampWithTimezoneFormat

createTimeWithTimezoneFormat

equals

getAttributes

getDateFormat

getEdgeIdType

getEdgePropertyDefault

getEdgePropertyDimension

getEdgePropertyName

getEdgePropertyType

getEdgePropertyTypes

getEdgeProps

getErrorHandling

getFormat

getLoading

getLoadingFilter

getLocalDateFormat

getName

getNodeKeyType

getNodePropertyDefault

getNodePropertyDimension

getNodePropertyName

getNodePropertyType

getTimeFormat

getTimestampFormat

getTimestampWithTimezoneFormat

getTimeWithTimezoneFormat

getVertexIdType

getVertexPropertyTypes

getVertexProps

hashCode

hasVerticesAndEdgesSeparatedFileFormat

hasVerticesAndEdgesSeparatedFileFormat

isEdgeLabelLoadingEnabled

isFileFormat

isFileFormat

isLoadEdgeKeys

isLoadVertexKeys

isMultipleFileFormat

isMultipleFileFormat

isSingleFileFormat

isSingleFileFormat

isVertexLabelsLoadingEnabled

numEdgeProperties

numNodeProperties

skipEdgeLoading

skipVertexLoading

supportsEdgeLabel

supportsEdgeLabel

supportsVertexLabels

supportsVertexLabels