Enum Class RdfGraphConfig.Field
- All Implemented Interfaces:
Serializable, Comparable<RdfGraphConfig.Field>, Constable, ConfigField
- Enclosing class:
RdfGraphConfig
Fields of PGX Engine RDF Graph Config
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionpredicates of triples that are transformed to edges[only relevant if the graph is optimized for updates] threshold used to determined when to compact the delta-logs into a new array.additional attributes needed to read/write the graph datadata source id to use to connect to an RDBMS instanceIndicates what ID strategy should be used for the edges of this graph.type of the edge ID.specification of edge properties associated with grapherror handling configurationgraph formatpredicates of triples that are ignoredjdbc URL pointing to an RDBMS instancealias to the keystore to use when connecting to databaseloading-specific configurationarray of local_date formats to use when loading and storing local_date properties.maximum number of rows prefetched during each round trip resultset-databaseRDF model name in databaseRDF network nameRDF network ownerIndicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updatesparallel hint degree to use for internal queries.Indicates if the graph should be partitioned while loadingpassword to use when connecting to databaselongitude and latitude as floating point values separated by a spaceIRI prefixesthe time format to use when loading and storing time properties.the time with timezone format to use when loading and storing time with timezone properties.the timestamp format to use when loading and storing timestamp properties.the timestamp with timezone format to use when loading and storing timestamp with timezone properties.indicates if prefixes should be used instead of uriusername to use when connecting to an RDBMS instancedelimiter for the different components of vector propertiesIndicates what ID strategy should be used for the vertices of this graph.type of the vertex ID.predicates of triples that are transformed to vertex labelsspecification of vertex properties associated with graph -
Method Summary
Modifier and TypeMethodDescriptionGets the default value of this field.Gets the key aliases of this field which are also recognized during parsing.Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.Class<?> getType()Gets the type of this field.booleanisArray()Checks if this field is an array.booleanisHidden()Checks if this field should be hidden.booleanisPath()Checks if this field is a path.booleanChecks if this field is required.booleanChecks if this field holds a sensitive data.toKey()Get the key of this field, which is how this field is represented in serialized form.toString()static RdfGraphConfig.FieldReturns the enum constant of this class with the specified name.static RdfGraphConfig.Field[]values()Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOfMethods inherited from interface ConfigField
isEnum, isPrimitive
-
Enum Constant Details
-
NAME
RDF model name in database -
NETWORK_OWNER
RDF network owner -
NETWORK_NAME
RDF network name -
USE_PREFIX
indicates if prefixes should be used instead of uri -
PREFIXES
IRI prefixes -
VERTEX_PROPS
specification of vertex properties associated with graph -
VERTEX_LABEL_PREDICATES
predicates of triples that are transformed to vertex labels -
IGNORED_PREDICATES
predicates of triples that are ignored -
ACCEPTED_PREDICATES
predicates of triples that are transformed to edges -
PARALLEL_HINT_DEGREE
parallel hint degree to use for internal queries. If the value is negative, the parallel hint will be omitted. If the value is zero, a parallel hint without degree is generated. -
JDBC_URL
jdbc URL pointing to an RDBMS instance -
USERNAME
username to use when connecting to an RDBMS instance -
DATA_SOURCE_ID
data source id to use to connect to an RDBMS instance -
MAX_PREFETCHED_ROWS
maximum number of rows prefetched during each round trip resultset-database -
OPTIMIZED_FOR
Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates -
PARTITION_WHILE_LOADING
Indicates if the graph should be partitioned while loading -
VERTEX_ID_STRATEGY
Indicates what ID strategy should be used for the vertices of this graph. If not specified (or set to null), the strategy will be automatically detected -
EDGE_ID_STRATEGY
Indicates what ID strategy should be used for the edges of this graph. If not specified (or set to null), the strategy will be determined during loading or using a default value -
VERTEX_ID_TYPE
type of the vertex ID. If not specified (or set to null), it will default to some type (depending on the origin of the data). -
EDGE_ID_TYPE
type of the edge ID. If not specified (or set to null), it will default to long. -
FORMAT
graph format -
ARRAY_COMPACTION_THRESHOLD
[only relevant if the graph is optimized for updates] threshold used to determined when to compact the delta-logs into a new array. If lower than the engine min_array_compaction_threshold value, min_array_compaction_threshold will be used instead -
EDGE_PROPS
specification of edge properties associated with graph -
LOADING_OPTIONS
loading-specific configuration -
ERROR_HANDLING
error handling configuration -
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
the time format to use when loading and storing time properties. Please see DateTimeFormatter for a documentation of the format string -
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
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
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
delimiter for the different components of vector properties -
POINT2D
longitude and latitude as floating point values separated by a space -
ATTRIBUTES
additional attributes needed to read/write the graph data -
PASSWORD
password to use when connecting to database -
KEYSTORE_ALIAS
alias to the keystore to use when connecting to database
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
getKeyAliases
Description copied from interface:ConfigFieldGets the key aliases of this field which are also recognized during parsing.- Specified by:
getKeyAliasesin interfaceConfigField- Returns:
- the key aliases
-
getSingletonListKeyAliases
Description copied from interface:ConfigFieldGets the key aliases of this field which contain single values for lists and are also recognized during parsing.- Specified by:
getSingletonListKeyAliasesin interfaceConfigField- Returns:
- the singleton list key aliases
-
getType
Description copied from interface:ConfigFieldGets the type of this field.- Specified by:
getTypein interfaceConfigField- Returns:
- the type
-
isRequired
public boolean isRequired()Description copied from interface:ConfigFieldChecks if this field is required.- Specified by:
isRequiredin interfaceConfigField- Returns:
- true, if required
-
isArray
public boolean isArray()Description copied from interface:ConfigFieldChecks if this field is an array.- Specified by:
isArrayin interfaceConfigField- Returns:
- true, if array
-
isPath
public boolean isPath()Description copied from interface:ConfigFieldChecks if this field is a path.- Specified by:
isPathin interfaceConfigField- Returns:
- true, if path
-
getDefaultVal
Description copied from interface:ConfigFieldGets the default value of this field.- Specified by:
getDefaultValin interfaceConfigField- Returns:
- the default value
-
toKey
Description copied from interface:ConfigFieldGet the key of this field, which is how this field is represented in serialized form.- Specified by:
toKeyin interfaceConfigField- Returns:
- the key.
-
toString
- Overrides:
toStringin classEnum<RdfGraphConfig.Field>
-
isSensitive
public boolean isSensitive()Description copied from interface:ConfigFieldChecks if this field holds a sensitive data.- Specified by:
isSensitivein interfaceConfigField- Returns:
- true, if use for sensitive data
-
isHidden
public boolean isHidden()Description copied from interface:ConfigFieldChecks 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:
isHiddenin interfaceConfigField- Returns:
- true if field should be hidden, false otherwise
-