FileGraphStoringConfig.Field (Oracle Graph Java API Reference Release 20.4 (F15858-05))

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

All Implemented Interfaces:

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

Enclosing class:

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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BASE_PATH` base path to use for storing a graph; file paths will be constructed using the following format <base_path>_<partition_index>.<extension>_, i.e.
`COMPRESSION_SCHEME` the scheme to use for compression, or none to disable compression
`DELIMITER` delimiter character used as separator when storing.
`EDGE_EXTENSION` the extension to use when creating edge file partitions
`INITIAL_PARTITION_INDEX` the value used as initial partition index, i.e.
`NUM_PARTITIONS` the number of partitions that should be created, when exporting to multiple files
`ROW_EXTENSION` the extension to use when creating row file partitions
`VERTEX_EXTENSION` the extension to use when creating vertex file partitions

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 FileGraphStoringConfig.Field`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static FileGraphStoringConfig.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
  - BASE_PATH
```
public static final FileGraphStoringConfig.Field BASE_PATH
```
    base path to use for storing a graph; file paths will be constructed using the following format <base_path>_<partition_index>.<extension>_, i.e. parent_path/my_graph_1.edges
  - COMPRESSION_SCHEME
```
public static final FileGraphStoringConfig.Field COMPRESSION_SCHEME
```
    the scheme to use for compression, or none to disable compression
  - DELIMITER
```
public static final FileGraphStoringConfig.Field DELIMITER
```
    delimiter character used as separator when storing. The characters ", {, } and \n cannot be used as delimiters
  - EDGE_EXTENSION
```
public static final FileGraphStoringConfig.Field EDGE_EXTENSION
```
    the extension to use when creating edge file partitions
  - INITIAL_PARTITION_INDEX
```
public static final FileGraphStoringConfig.Field INITIAL_PARTITION_INDEX
```
    the value used as initial partition index, i.e. initial_partition_index=1024 -> my_graph_1024.edges, my_graph_1025.edges
  - NUM_PARTITIONS
```
public static final FileGraphStoringConfig.Field NUM_PARTITIONS
```
    the number of partitions that should be created, when exporting to multiple files
  - ROW_EXTENSION
```
public static final FileGraphStoringConfig.Field ROW_EXTENSION
```
    the extension to use when creating row file partitions
  - VERTEX_EXTENSION
```
public static final FileGraphStoringConfig.Field VERTEX_EXTENSION
```
    the extension to use when creating vertex file partitions
- Method Detail
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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<FileGraphStoringConfig.Field>
  - valueOf
```
public static FileGraphStoringConfig.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
  - values
```
public static FileGraphStoringConfig.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 (FileGraphStoringConfig.Field c : FileGraphStoringConfig.Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared

Enum FileGraphStoringConfig.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

BASE_PATH

COMPRESSION_SCHEME

DELIMITER

EDGE_EXTENSION

INITIAL_PARTITION_INDEX

NUM_PARTITIONS

ROW_EXTENSION

VERTEX_EXTENSION

Method Detail

getDefaultVal

getKeyAliases

getSingletonListKeyAliases

getType

isArray

isHidden

isPath

isRequired

isSensitive

toKey

toString

valueOf

values