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

All Implemented Interfaces:

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

Enclosing class:

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

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ATTRIBUTES`	additional attributes needed to read/write the graph data
`DESTINATION_COLUMN`	name or index (starting from 1) of column corresponding to edge destination (for CSV format only)
`DESTINATION_VERTEX_PROVIDER`	name of the destination vertex provider to be used for this edge provider
`DETECT_GZIP`	enable/disable automatic gzip compression detection when loading graphs
`ERROR_HANDLING`	error handling configuration
`FORMAT`	provider format
`HAS_KEYS`	indicates if the provided entities data have keys
`HEADER`	first line of file is meant for headers, e.g.
`KEY_COLUMN`	name or index (starting from 1) of column corresponding to keys (for CSV format only)
`KEY_TYPE`	type of the keys
`KEYSTORE_ALIAS`	alias to the keystore to use when connecting to database
`LABEL`	label for the entities loaded from this provider
`LOADING`	loading-specific configuration
`LOCAL_DATE_FORMAT`	array of local_date formats to use when loading and storing local_date properties.
`NAME`	entity provider name
`PASSWORD`	password to use when connecting to database
`POINT2D`	longitude and latitude as floating point values separated by a space
`PROPS`	specification of the properties associated with this entity provider
`SEPARATOR`	a series of single-character separators for tokenizing.
`SOURCE_COLUMN`	name or index (starting from 1) of column corresponding to edge source (for CSV format only)
`SOURCE_VERTEX_PROVIDER`	name of the source vertex provider to be used for this edge provider
`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.
`URIS`	list of unified resource identifiers
`VECTOR_COMPONENT_DELIMITER`	delimiter for the different components of vector properties

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 FileEntityProviderConfig.Field`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static FileEntityProviderConfig.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
  - URIS
```
public static final FileEntityProviderConfig.Field URIS
```
    list of unified resource identifiers
  - KEY_COLUMN
```
public static final FileEntityProviderConfig.Field KEY_COLUMN
```
    name or index (starting from 1) of column corresponding to keys (for CSV format only)
  - SOURCE_COLUMN
```
public static final FileEntityProviderConfig.Field SOURCE_COLUMN
```
    name or index (starting from 1) of column corresponding to edge source (for CSV format only)
  - DESTINATION_COLUMN
```
public static final FileEntityProviderConfig.Field DESTINATION_COLUMN
```
    name or index (starting from 1) of column corresponding to edge destination (for CSV format only)
  - SEPARATOR
```
public static final FileEntityProviderConfig.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 FileEntityProviderConfig.Field HEADER
```
    first line of file is meant for headers, e.g. 'EdgeId, SourceId, DestId, EdgeProp1, EdgeProp2'
  - DETECT_GZIP
```
public static final FileEntityProviderConfig.Field DETECT_GZIP
```
    enable/disable automatic gzip compression detection when loading graphs
  - STORING
```
public static final FileEntityProviderConfig.Field STORING
```
    storing-specific configuration
  - NAME
```
public static final FileEntityProviderConfig.Field NAME
```
    entity provider name
  - LABEL
```
public static final FileEntityProviderConfig.Field LABEL
```
    label for the entities loaded from this provider
  - FORMAT
```
public static final FileEntityProviderConfig.Field FORMAT
```
    provider format
  - PROPS
```
public static final FileEntityProviderConfig.Field PROPS
```
    specification of the properties associated with this entity provider
  - KEY_TYPE
```
public static final FileEntityProviderConfig.Field KEY_TYPE
```
    type of the keys
  - SOURCE_VERTEX_PROVIDER
```
public static final FileEntityProviderConfig.Field SOURCE_VERTEX_PROVIDER
```
    name of the source vertex provider to be used for this edge provider
  - DESTINATION_VERTEX_PROVIDER
```
public static final FileEntityProviderConfig.Field DESTINATION_VERTEX_PROVIDER
```
    name of the destination vertex provider to be used for this edge provider
  - LOADING
```
public static final FileEntityProviderConfig.Field LOADING
```
    loading-specific configuration
  - HAS_KEYS
```
public static final FileEntityProviderConfig.Field HAS_KEYS
```
    indicates if the provided entities data have keys
  - ERROR_HANDLING
```
public static final FileEntityProviderConfig.Field ERROR_HANDLING
```
    error handling configuration
  - LOCAL_DATE_FORMAT
```
public static final FileEntityProviderConfig.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 FileEntityProviderConfig.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 FileEntityProviderConfig.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 FileEntityProviderConfig.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 FileEntityProviderConfig.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 FileEntityProviderConfig.Field VECTOR_COMPONENT_DELIMITER
```
    delimiter for the different components of vector properties
  - POINT2D
```
public static final FileEntityProviderConfig.Field POINT2D
```
    longitude and latitude as floating point values separated by a space
  - ATTRIBUTES
```
public static final FileEntityProviderConfig.Field ATTRIBUTES
```
    additional attributes needed to read/write the graph data
  - PASSWORD
```
public static final FileEntityProviderConfig.Field PASSWORD
```
    password to use when connecting to database
  - KEYSTORE_ALIAS
```
public static final FileEntityProviderConfig.Field KEYSTORE_ALIAS
```
    alias to the keystore to use when connecting to database
- Method Detail
  - values
```
public static FileEntityProviderConfig.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 (FileEntityProviderConfig.Field c : FileEntityProviderConfig.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 FileEntityProviderConfig.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<FileEntityProviderConfig.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 FileEntityProviderConfig.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

URIS

KEY_COLUMN

SOURCE_COLUMN

DESTINATION_COLUMN

SEPARATOR

HEADER

DETECT_GZIP

STORING

NAME

LABEL

FORMAT

PROPS

KEY_TYPE

SOURCE_VERTEX_PROVIDER

DESTINATION_VERTEX_PROVIDER

LOADING

HAS_KEYS

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