Package oracle.pgx.config

Enum ProviderLoadingConfig.Field

java.lang.Object

java.lang.Enum<ProviderLoadingConfig.Field>

oracle.pgx.config.ProviderLoadingConfig.Field

All Implemented Interfaces:

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

Enclosing class:

ProviderLoadingConfig

public static enum ProviderLoadingConfig.Field
extends java.lang.Enum<ProviderLoadingConfig.Field>
implements ConfigField

Fields of PGX Engine Entity Provider Loading Config

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREATE_KEY_MAPPING	if true, a mapping between entity keys and internal IDs is prepared during loading.
FILTER	[currently unsupported] the filter expression
GROUPING_BY	[currently unsupported] array of edge properties used for aggregator.
LOAD_LABELS	whether or not to load the entity label if it is available
STRICT_MODE	if true, exceptions are thrown and logged with ERROR level whenever loader encounters problems with input file, such as invalid format, repeated keys, missing fields, mismatches and other potential errors.

Method Summary

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 ProviderLoadingConfig.Field	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ProviderLoadingConfig.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

CREATE_KEY_MAPPING

public static final ProviderLoadingConfig.Field CREATE_KEY_MAPPING

if true, a mapping between entity keys and internal IDs is prepared during loading.

STRICT_MODE

public static final ProviderLoadingConfig.Field STRICT_MODE

if true, exceptions are thrown and logged with ERROR level whenever loader encounters problems with input file, such as invalid format, repeated keys, missing fields, mismatches and other potential errors. If false, loader may use less memory during loading phase, but behave unexpectedly with erratic input files

LOAD_LABELS

public static final ProviderLoadingConfig.Field LOAD_LABELS

whether or not to load the entity label if it is available

FILTER

public static final ProviderLoadingConfig.Field FILTER

[currently unsupported] the filter expression

GROUPING_BY

public static final ProviderLoadingConfig.Field GROUPING_BY

[currently unsupported] array of edge properties used for aggregator. For Vertices, only the ID can be used (default)

Method Detail

values

public static ProviderLoadingConfig.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 (ProviderLoadingConfig.Field c : ProviderLoadingConfig.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 ProviderLoadingConfig.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<ProviderLoadingConfig.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