Package oracle.pgx.config
Enum GraphBuilderConfig.Field
- java.lang.Object
-
- java.lang.Enum<GraphBuilderConfig.Field>
-
- oracle.pgx.config.GraphBuilderConfig.Field
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<GraphBuilderConfig.Field>
,ConfigField
- Enclosing class:
- GraphBuilderConfig
public static enum GraphBuilderConfig.Field extends java.lang.Enum<GraphBuilderConfig.Field> implements ConfigField
Fields of Graph Builder Parameters
-
-
Enum Constant Summary
Enum Constants Enum Constant Description EDGE_ID_GENERATION_STRATEGY
ifAUTO_GENERATED
edges IDs are auto generated.RETAIN_EDGE_ID
iftrue
keep the edge id after graph construction.RETAIN_VERTEX_ID
iftrue
keep the vertex id after graph construction.VERTEX_ID_GENERATION_STRATEGY
ifAUTO_GENERATED
vertices IDs are auto generated.
-
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 GraphBuilderConfig.Field
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static GraphBuilderConfig.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 interface oracle.pgx.config.ConfigField
isEnum, isPrimitive
-
-
-
-
Enum Constant Detail
-
RETAIN_EDGE_ID
public static final GraphBuilderConfig.Field RETAIN_EDGE_ID
iftrue
keep the edge id after graph construction. Iffalse
drop the edge id.
-
RETAIN_VERTEX_ID
public static final GraphBuilderConfig.Field RETAIN_VERTEX_ID
iftrue
keep the vertex id after graph construction. Iffalse
drop the vertex id.
-
VERTEX_ID_GENERATION_STRATEGY
public static final GraphBuilderConfig.Field VERTEX_ID_GENERATION_STRATEGY
ifAUTO_GENERATED
vertices IDs are auto generated. IfUSER_IDS
vertex IDs must be explicitly defined by the user
-
EDGE_ID_GENERATION_STRATEGY
public static final GraphBuilderConfig.Field EDGE_ID_GENERATION_STRATEGY
ifAUTO_GENERATED
edges IDs are auto generated. IfUSER_IDS
edge IDs must be explicitly defined by the user
-
-
Method Detail
-
values
public static GraphBuilderConfig.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 (GraphBuilderConfig.Field c : GraphBuilderConfig.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 GraphBuilderConfig.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 namejava.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 interfaceConfigField
- 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 interfaceConfigField
- 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 interfaceConfigField
- Returns:
- the type
-
isRequired
public boolean isRequired()
Description copied from interface:ConfigField
Checks if this field is required.- Specified by:
isRequired
in interfaceConfigField
- Returns:
- true, if required
-
isArray
public boolean isArray()
Description copied from interface:ConfigField
Checks if this field is an array.- Specified by:
isArray
in interfaceConfigField
- Returns:
- true, if array
-
isPath
public boolean isPath()
Description copied from interface:ConfigField
Checks if this field is a path.- Specified by:
isPath
in interfaceConfigField
- 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 interfaceConfigField
- 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 interfaceConfigField
- Returns:
- the key.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Enum<GraphBuilderConfig.Field>
-
isSensitive
public boolean isSensitive()
Description copied from interface:ConfigField
Checks if this field holds a sensitive data.- Specified by:
isSensitive
in interfaceConfigField
- 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 interfaceConfigField
- Returns:
- true if field should be hidden, false otherwise
-
-