java.lang.Object
- java.lang.Enum<FileGraphConfig.Field>
- - oracle.pgx.config.FileGraphConfig.Field

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FileGraphConfig.Field>, ConfigField

Enclosing class:

FileGraphConfig
```
public static enum FileGraphConfig.Field
extends java.lang.Enum<FileGraphConfig.Field>
implements ConfigField
```
Fields of PGX Engine File Graph Config

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ARRAY_COMPACTION_THRESHOLD`	[only relevant if the graph is optimized for updates] threshold used to determined when to compact the delta-logs into a new array.
`ATTRIBUTES`	additional attributes needed to read/write the graph data
`DETECT_GZIP`	enable/disable automatic gzip compression detection when loading graphs
`EDGE_DESTINATION_COLUMN`	name or index (starting from 1) of column corresponding to edge destination (for CSV format only)
`EDGE_ID_COLUMN`	name or index (starting from 1) of column corresponding to edge id (for CSV format only)
`EDGE_ID_STRATEGY`	Indicates what ID strategy should be used for the edges of this graph.
`EDGE_ID_TYPE`	type of the edge ID.
`EDGE_LABEL_COLUMN`	name or index (starting from 1) of column corresponding to edge label (for CSV format only)
`EDGE_PROPS`	specification of edge properties associated with graph
`EDGE_SOURCE_COLUMN`	name or index (starting from 1) of column corresponding to edge source (for CSV format only)
`EDGE_URIS`	list of unified resource identifiers
`ERROR_HANDLING`	error handling configuration
`EXTERNAL_STORES`	Specification of the external stores where external string properties reside.
`FORMAT`	graph format
`HEADER`	first line of file is meant for headers, e.g.
`KEYSTORE_ALIAS`	alias to the keystore to use when connecting to database
`LOADING`	loading-specific configuration
`LOCAL_DATE_FORMAT`	array of local_date formats to use when loading and storing local_date properties.
`OPTIMIZED_FOR`	Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates
`PARTITION_WHILE_LOADING`	Indicates if the graph should be partitioned while loading
`PASSWORD`	password to use when connecting to database
`POINT2D`	longitude and latitude as floating point values separated by a space
`SEPARATOR`	a series of single-character separators for tokenizing.
`STORING`	storing-specific configuration
`TIME_FORMAT`	the time format to use when loading and storing time properties.
`TIME_WITH_TIMEZONE_FORMAT`	the time with timezone format to use when loading and storing time with timezone properties.
`TIMESTAMP_FORMAT`	the timestamp format to use when loading and storing timestamp properties.
`TIMESTAMP_WITH_TIMEZONE_FORMAT`	the timestamp with timezone format to use when loading and storing timestamp with timezone properties.
`VECTOR_COMPONENT_DELIMITER`	delimiter for the different components of vector properties
`VERTEX_ID_COLUMN`	name or index (starting from 1) of column corresponding to vertex id (for CSV format only)
`VERTEX_ID_STRATEGY`	Indicates what ID strategy should be used for the vertices of this graph.
`VERTEX_ID_TYPE`	type of the vertex ID.
`VERTEX_LABELS_COLUMN`	name or index (starting from 1) of column corresponding to vertex labels (for CSV format only)
`VERTEX_PROPS`	specification of vertex properties associated with graph
`VERTEX_URIS`	list of unified resource identifiers

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Object`	`getDefaultVal()`	Gets the default value of this field.
`java.util.List<java.lang.String>`	`getKeyAliases()`	Gets the key aliases of this field which are also recognized during parsing.
`java.util.List<java.lang.String>`	`getSingletonListKeyAliases()`	Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
`java.lang.Class<?>`	`getType()`	Gets the type of this field.
`boolean`	`isArray()`	Checks if this field is an array.
`boolean`	`isHidden()`	Checks if this field should be hidden.
`boolean`	`isPath()`	Checks if this field is a path.
`boolean`	`isRequired()`	Checks if this field is required.
`boolean`	`isSensitive()`	Checks if this field holds a sensitive data.
`java.lang.String`	`toKey()`	Get the key of this field, which is how this field is represented in serialized form.
`java.lang.String`	`toString()`
`static FileGraphConfig.Field`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static FileGraphConfig.Field[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

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

Methods inherited from interface oracle.pgx.config.ConfigField
isEnum, isPrimitive

- Enum Constant Detail
  - VERTEX_URIS
```
public static final FileGraphConfig.Field VERTEX_URIS
```
    list of unified resource identifiers
  - EDGE_URIS
```
public static final FileGraphConfig.Field EDGE_URIS
```
    list of unified resource identifiers
  - VERTEX_ID_COLUMN
```
public static final FileGraphConfig.Field VERTEX_ID_COLUMN
```
    name or index (starting from 1) of column corresponding to vertex id (for CSV format only)
  - EDGE_ID_COLUMN
```
public static final FileGraphConfig.Field EDGE_ID_COLUMN
```
    name or index (starting from 1) of column corresponding to edge id (for CSV format only)
  - EDGE_SOURCE_COLUMN
```
public static final FileGraphConfig.Field EDGE_SOURCE_COLUMN
```
    name or index (starting from 1) of column corresponding to edge source (for CSV format only)
  - EDGE_DESTINATION_COLUMN
```
public static final FileGraphConfig.Field EDGE_DESTINATION_COLUMN
```
    name or index (starting from 1) of column corresponding to edge destination (for CSV format only)
  - VERTEX_LABELS_COLUMN
```
public static final FileGraphConfig.Field VERTEX_LABELS_COLUMN
```
    name or index (starting from 1) of column corresponding to vertex labels (for CSV format only)
  - EDGE_LABEL_COLUMN
```
public static final FileGraphConfig.Field EDGE_LABEL_COLUMN
```
    name or index (starting from 1) of column corresponding to edge label (for CSV format only)
  - SEPARATOR
```
public static final FileGraphConfig.Field SEPARATOR
```
    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.
  - HEADER
```
public static final FileGraphConfig.Field HEADER
```
    first line of file is meant for headers, e.g. 'EdgeId, SourceId, DestId, EdgeProp1, EdgeProp2'
  - DETECT_GZIP
```
public static final FileGraphConfig.Field DETECT_GZIP
```
    enable/disable automatic gzip compression detection when loading graphs
  - STORING
```
public static final FileGraphConfig.Field STORING
```
    storing-specific configuration
  - OPTIMIZED_FOR
```
public static final FileGraphConfig.Field OPTIMIZED_FOR
```
    Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates
  - PARTITION_WHILE_LOADING
```
public static final FileGraphConfig.Field PARTITION_WHILE_LOADING
```
    Indicates if the graph should be partitioned while loading
  - VERTEX_ID_STRATEGY
```
public static final FileGraphConfig.Field VERTEX_ID_STRATEGY
```
    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
  - EDGE_ID_STRATEGY
```
public static final FileGraphConfig.Field EDGE_ID_STRATEGY
```
    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
  - VERTEX_ID_TYPE
```
public static final FileGraphConfig.Field VERTEX_ID_TYPE
```
    type of the vertex ID. If not specified (or set to null), it will default to some type (depending on the origin of the data).
  - EDGE_ID_TYPE
```
public static final FileGraphConfig.Field EDGE_ID_TYPE
```
    type of the edge ID. If not specified (or set to null), it will default to long.
  - FORMAT
```
public static final FileGraphConfig.Field FORMAT
```
    graph format
  - ARRAY_COMPACTION_THRESHOLD
```
public static final FileGraphConfig.Field ARRAY_COMPACTION_THRESHOLD
```
    [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
  - VERTEX_PROPS
```
public static final FileGraphConfig.Field VERTEX_PROPS
```
    specification of vertex properties associated with graph
  - EDGE_PROPS
```
public static final FileGraphConfig.Field EDGE_PROPS
```
    specification of edge properties associated with graph
  - LOADING
```
public static final FileGraphConfig.Field LOADING
```
    loading-specific configuration
  - EXTERNAL_STORES
```
public static final FileGraphConfig.Field EXTERNAL_STORES
```
    Specification of the external stores where external string properties reside.
  - ERROR_HANDLING
```
public static final FileGraphConfig.Field ERROR_HANDLING
```
    error handling configuration
  - LOCAL_DATE_FORMAT
```
public static final FileGraphConfig.Field LOCAL_DATE_FORMAT
```
    array of local_date formats to use when loading and storing local_date properties. Please see DateTimeFormatter for a documentation of the format string
  - TIME_FORMAT
```
public static final FileGraphConfig.Field TIME_FORMAT
```
    the time format to use when loading and storing time properties. Please see DateTimeFormatter for a documentation of the format string
  - TIMESTAMP_FORMAT
```
public static final FileGraphConfig.Field TIMESTAMP_FORMAT
```
    the timestamp format to use when loading and storing timestamp properties. Please see DateTimeFormatter for a documentation of the format string
  - TIME_WITH_TIMEZONE_FORMAT
```
public static final FileGraphConfig.Field TIME_WITH_TIMEZONE_FORMAT
```
    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
  - TIMESTAMP_WITH_TIMEZONE_FORMAT
```
public static final FileGraphConfig.Field TIMESTAMP_WITH_TIMEZONE_FORMAT
```
    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
  - VECTOR_COMPONENT_DELIMITER
```
public static final FileGraphConfig.Field VECTOR_COMPONENT_DELIMITER
```
    delimiter for the different components of vector properties
  - POINT2D
```
public static final FileGraphConfig.Field POINT2D
```
    longitude and latitude as floating point values separated by a space
  - ATTRIBUTES
```
public static final FileGraphConfig.Field ATTRIBUTES
```
    additional attributes needed to read/write the graph data
  - PASSWORD
```
public static final FileGraphConfig.Field PASSWORD
```
    password to use when connecting to database
  - KEYSTORE_ALIAS
```
public static final FileGraphConfig.Field KEYSTORE_ALIAS
```
    alias to the keystore to use when connecting to database
- Method Detail
  - values
```
public static FileGraphConfig.Field[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (FileGraphConfig.Field c : FileGraphConfig.Field.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FileGraphConfig.Field valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getKeyAliases
```
public java.util.List<java.lang.String> getKeyAliases()
```
    Description copied from interface: ConfigField
    
    Gets the key aliases of this field which are also recognized during parsing.
    
    Specified by:
    
    getKeyAliases in interface ConfigField
    
    Returns:
    
    the key aliases
  - getSingletonListKeyAliases
```
public java.util.List<java.lang.String> getSingletonListKeyAliases()
```
    Description copied from interface: ConfigField
    
    Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
    
    Specified by:
    
    getSingletonListKeyAliases in interface ConfigField
    
    Returns:
    
    the singleton list key aliases
  - getType
```
public java.lang.Class<?> getType()
```
    Description copied from interface: ConfigField
    
    Gets the type of this field.
    
    Specified by:
    
    getType in interface ConfigField
    
    Returns:
    
    the type
  - isRequired
```
public boolean isRequired()
```
    Description copied from interface: ConfigField
    
    Checks if this field is required.
    
    Specified by:
    
    isRequired in interface ConfigField
    
    Returns:
    
    true, if required
  - isArray
```
public boolean isArray()
```
    Description copied from interface: ConfigField
    
    Checks if this field is an array.
    
    Specified by:
    
    isArray in interface ConfigField
    
    Returns:
    
    true, if array
  - isPath
```
public boolean isPath()
```
    Description copied from interface: ConfigField
    
    Checks if this field is a path.
    
    Specified by:
    
    isPath in interface ConfigField
    
    Returns:
    
    true, if path
  - getDefaultVal
```
public java.lang.Object getDefaultVal()
```
    Description copied from interface: ConfigField
    
    Gets the default value of this field.
    
    Specified by:
    
    getDefaultVal in interface ConfigField
    
    Returns:
    
    the default value
  - toKey
```
public java.lang.String toKey()
```
    Description copied from interface: ConfigField
    
    Get the key of this field, which is how this field is represented in serialized form.
    
    Specified by:
    
    toKey in interface ConfigField
    
    Returns:
    
    the key.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<FileGraphConfig.Field>
  - isSensitive
```
public boolean isSensitive()
```
    Description copied from interface: ConfigField
    
    Checks if this field holds a sensitive data.
    
    Specified by:
    
    isSensitive in interface ConfigField
    
    Returns:
    
    true, if use for sensitive data
  - isHidden
```
public boolean isHidden()
```
    Description copied from interface: ConfigField
    
    Checks if this field should be hidden. Hidden fields are used to hid desired field from the user and only allow it for internal usage.
    
    Specified by:
    
    isHidden in interface ConfigField
    
    Returns:
    
    true if field should be hidden, false otherwise

Enum FileGraphConfig.Field

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.pgx.config.ConfigField

Enum Constant Detail

VERTEX_URIS

EDGE_URIS

VERTEX_ID_COLUMN

EDGE_ID_COLUMN

EDGE_SOURCE_COLUMN

EDGE_DESTINATION_COLUMN

VERTEX_LABELS_COLUMN

EDGE_LABEL_COLUMN

SEPARATOR

HEADER

DETECT_GZIP

STORING

OPTIMIZED_FOR

PARTITION_WHILE_LOADING

VERTEX_ID_STRATEGY

EDGE_ID_STRATEGY

VERTEX_ID_TYPE

EDGE_ID_TYPE

FORMAT

ARRAY_COMPACTION_THRESHOLD

VERTEX_PROPS

EDGE_PROPS

LOADING

EXTERNAL_STORES

ERROR_HANDLING

LOCAL_DATE_FORMAT

TIME_FORMAT

TIMESTAMP_FORMAT

TIME_WITH_TIMEZONE_FORMAT

TIMESTAMP_WITH_TIMEZONE_FORMAT

VECTOR_COMPONENT_DELIMITER

POINT2D

ATTRIBUTES

PASSWORD

KEYSTORE_ALIAS

Method Detail

values

valueOf

getKeyAliases

getSingletonListKeyAliases

getType

isRequired

isArray

isPath

getDefaultVal

toKey

toString

isSensitive

isHidden