Package oracle.pgx.config
Enum GraphPropertyConfig.Field
- java.lang.Object
-
- java.lang.Enum<GraphPropertyConfig.Field>
-
- oracle.pgx.config.GraphPropertyConfig.Field
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<GraphPropertyConfig.Field>
,ConfigField
- Enclosing class:
- GraphPropertyConfig
public static enum GraphPropertyConfig.Field extends java.lang.Enum<GraphPropertyConfig.Field> implements ConfigField
Fields of PGX Engine Graph Property Config
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AGGREGATE
[currently unsupported] which aggregation function to use, aggregation always happens by vertex keyCOLUMN
name or index (starting from 1) of the column holding the property data.DEFAULT
default value to be assigned to this property if datasource does not provide it.DIMENSION
dimension of propertyDROP_AFTER_LOADING
[currently unsupported] indicating helper properties only used for aggregation, which are dropped after loadingFIELD
name of the JSON field holding the property data.FORMAT
array of formats of propertyGROUP_KEY
[currently unsupported] can only be used if the property / key is part of the grouping expressionMAX_DISTINCT_STRINGS_PER_POOL
[only relevant if string_pooling_strategy is indexed] amount of distinct strings per property after which to stop pooling.NAME
name of propertySTORES
A list of storage identifiers that indicate where this property resides.STRING_POOLING_STRATEGY
which string pooling strategy to use.TYPE
type of property (Note: date is deprecated, use one of local_date / time / timestamp / time_with_timezone / timestamp_with_timezone instead).
-
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 GraphPropertyConfig.Field
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static GraphPropertyConfig.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
-
NAME
public static final GraphPropertyConfig.Field NAME
name of property
-
DIMENSION
public static final GraphPropertyConfig.Field DIMENSION
dimension of property
-
FORMAT
public static final GraphPropertyConfig.Field FORMAT
array of formats of property
-
TYPE
public static final GraphPropertyConfig.Field TYPE
type of property (Note: date is deprecated, use one of local_date / time / timestamp / time_with_timezone / timestamp_with_timezone instead). vertex/edge are place-holders for the type specified in vertex_id_type/edge_id_type fields.
-
DEFAULT
public static final GraphPropertyConfig.Field DEFAULT
default value to be assigned to this property if datasource does not provide it. In case of date type: string is expected to be formatted withyyyy-MM-dd HH:mm:ss
. If no default is present (null
), non-existent properties will contain default Java types (primitives) or empty string (string) or01.01.1970 00:00
(date).
-
COLUMN
public static final GraphPropertyConfig.Field COLUMN
name or index (starting from 1) of the column holding the property data. If it is not specified, the loader will try to use the property name as column name (for CSV format only)
-
STORES
public static final GraphPropertyConfig.Field STORES
A list of storage identifiers that indicate where this property resides.
-
MAX_DISTINCT_STRINGS_PER_POOL
public static final GraphPropertyConfig.Field MAX_DISTINCT_STRINGS_PER_POOL
[only relevant if string_pooling_strategy is indexed] amount of distinct strings per property after which to stop pooling. If the limit is reached an exception is thrown. If set to null, the default value from the global PGX configuration will be used.
-
STRING_POOLING_STRATEGY
public static final GraphPropertyConfig.Field STRING_POOLING_STRATEGY
which string pooling strategy to use. If set to null, the default value from the global PGX configuration will be used.
-
AGGREGATE
public static final GraphPropertyConfig.Field AGGREGATE
[currently unsupported] which aggregation function to use, aggregation always happens by vertex key
-
FIELD
public static final GraphPropertyConfig.Field FIELD
name of the JSON field holding the property data. Nesting is denoted by dot - separation. Field names containing dots are possible, in this case the dots need to be escaped using backslashes to resolve ambiguities. Only the exactly specified object are loaded, if they are non existent, the default value is used
-
GROUP_KEY
public static final GraphPropertyConfig.Field GROUP_KEY
[currently unsupported] can only be used if the property / key is part of the grouping expression
-
DROP_AFTER_LOADING
public static final GraphPropertyConfig.Field DROP_AFTER_LOADING
[currently unsupported] indicating helper properties only used for aggregation, which are dropped after loading
-
-
Method Detail
-
values
public static GraphPropertyConfig.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 (GraphPropertyConfig.Field c : GraphPropertyConfig.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 GraphPropertyConfig.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<GraphPropertyConfig.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
-
-