FileGraphConfig.Field (Oracle Big Data Spatial and Graph In-memory Analyst Java API Reference v2.4.0 (E62127-06))

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 and Description
`ATTRIBUTES` additional attributes needed to read/write the graph data
`DATE_FORMAT` the date format to use when loading and storing date properties.
`DETECT_GZIP` enable/disable automatic gzip compression detection when loading graphs
`EDGE_PROPS` specification of edge properties associated with graph
`EDGE_URIS` list of unified resource identifiers
`ERROR_HANDLING` error handling configuration
`FORMAT` graph format (Note: `bin` is deprecated, use `pgb` instead)
`HEADER` first line of file is meant for headers, e.g.
`LOADING` loading-specific configuration
`LOCAL_DATE_FORMAT` array of local_date formats to use when loading and storing local_date properties.
`POINT2D` longitude and latitude as floating point values separated by a space
`SEPARATOR` separator string for text files.
`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.
`VERTEX_ID_TYPE` type of the vertex ID
`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 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`	`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
  - ATTRIBUTES
```
public static final FileGraphConfig.Field ATTRIBUTES
```
    additional attributes needed to read/write the graph data
  - DATE_FORMAT
```
public static final FileGraphConfig.Field DATE_FORMAT
```
    the date format to use when loading and storing date properties. Please see SimpleDateFormat for a documentation of the format string
  - DETECT_GZIP
```
public static final FileGraphConfig.Field DETECT_GZIP
```
    enable/disable automatic gzip compression detection when loading graphs
  - EDGE_PROPS
```
public static final FileGraphConfig.Field EDGE_PROPS
```
    specification of edge properties associated with graph
  - EDGE_URIS
```
public static final FileGraphConfig.Field EDGE_URIS
```
    list of unified resource identifiers
  - ERROR_HANDLING
```
public static final FileGraphConfig.Field ERROR_HANDLING
```
    error handling configuration
  - FORMAT
```
public static final FileGraphConfig.Field FORMAT
```
    graph format (Note: bin is deprecated, use pgb instead)
  - HEADER
```
public static final FileGraphConfig.Field HEADER
```
    first line of file is meant for headers, e.g. 'EdgeId, SourceId, DestId, EdgeProp1, EdgeProp2'
  - LOADING
```
public static final FileGraphConfig.Field LOADING
```
    loading-specific 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
  - POINT2D
```
public static final FileGraphConfig.Field POINT2D
```
    longitude and latitude as floating point values separated by a space
  - SEPARATOR
```
public static final FileGraphConfig.Field SEPARATOR
```
    separator string for text files. First character will be used as separator when storing. The characters ", {, } and \n cannot be used as separators
  - 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
  - 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_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
  - 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
  - VERTEX_ID_TYPE
```
public static final FileGraphConfig.Field VERTEX_ID_TYPE
```
    type of the vertex ID
  - VERTEX_PROPS
```
public static final FileGraphConfig.Field VERTEX_PROPS
```
    specification of vertex properties associated with graph
  - VERTEX_URIS
```
public static final FileGraphConfig.Field VERTEX_URIS
```
    list of unified resource identifiers
- 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
  - 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<FileGraphConfig.Field>
  - 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
  - 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

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

ATTRIBUTES

DATE_FORMAT

DETECT_GZIP

EDGE_PROPS

EDGE_URIS

ERROR_HANDLING

FORMAT

HEADER

LOADING

LOCAL_DATE_FORMAT

POINT2D

SEPARATOR

TIME_FORMAT

TIME_WITH_TIMEZONE_FORMAT

TIMESTAMP_FORMAT

TIMESTAMP_WITH_TIMEZONE_FORMAT

VERTEX_ID_TYPE

VERTEX_PROPS

VERTEX_URIS

Method Detail

getDefaultVal

getKeyAliases

getSingletonListKeyAliases

getType

isArray

isPath

isRequired

isSensitive

toKey

toString

valueOf

values