Enum RdfGraphConfig.Field

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ACCEPTED_PREDICATES
      predicates of triples that are transformed to edges
      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.
      ATTRIBUTES
      additional attributes needed to read/write the graph data
      DATA_SOURCE_ID
      data source id to use to connect to an RDBMS instance
      EDGE_ID_STRATEGY
      Indicates what ID strategy should be used for the edges of this graph.
      EDGE_ID_TYPE
      type of the edge ID.
      EDGE_PROPS
      specification of edge properties associated with graph
      ERROR_HANDLING
      error handling configuration
      EXTERNAL_STORES
      Specification of the external stores where external string properties reside.
      FORMAT
      graph format
      IGNORED_PREDICATES
      predicates of triples that are ignored
      JDBC_URL
      jdbc URL pointing to an RDBMS instance
      KEYSTORE_ALIAS
      alias to the keystore to use when connecting to database
      LOADING
      loading-specific configuration
      LOCAL_DATE_FORMAT
      array of local_date formats to use when loading and storing local_date properties.
      MAX_PREFETCHED_ROWS
      maximum number of rows prefetched during each round trip resultset-database
      NAME
      RDF model name in database
      NETWORK_NAME
      RDF network name
      NETWORK_OWNER
      RDF network owner
      OPTIMIZED_FOR
      Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates
      PARALLEL_HINT_DEGREE
      parallel hint degree to use for internal queries.
      PARTITION_WHILE_LOADING
      Indicates if the graph should be partitioned while loading
      PASSWORD
      password to use when connecting to database
      POINT2D
      longitude and latitude as floating point values separated by a space
      PREFIXES
      IRI prefixes
      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.
      USE_PREFIX
      indicates if prefixes should be used instead of uri
      USERNAME
      username to use when connecting to an RDBMS instance
      VECTOR_COMPONENT_DELIMITER
      delimiter for the different components of vector properties
      VERTEX_ID_STRATEGY
      Indicates what ID strategy should be used for the vertices of this graph.
      VERTEX_ID_TYPE
      type of the vertex ID.
      VERTEX_LABEL_PREDICATES
      predicates of triples that are transformed to vertex labels
      VERTEX_PROPS
      specification of vertex properties associated with graph
    • 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 RdfGraphConfig.Field valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RdfGraphConfig.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
    • Enum Constant Detail

      • USE_PREFIX

        public static final RdfGraphConfig.Field USE_PREFIX
        indicates if prefixes should be used instead of uri
      • VERTEX_PROPS

        public static final RdfGraphConfig.Field VERTEX_PROPS
        specification of vertex properties associated with graph
      • VERTEX_LABEL_PREDICATES

        public static final RdfGraphConfig.Field VERTEX_LABEL_PREDICATES
        predicates of triples that are transformed to vertex labels
      • IGNORED_PREDICATES

        public static final RdfGraphConfig.Field IGNORED_PREDICATES
        predicates of triples that are ignored
      • ACCEPTED_PREDICATES

        public static final RdfGraphConfig.Field ACCEPTED_PREDICATES
        predicates of triples that are transformed to edges
      • PARALLEL_HINT_DEGREE

        public static final RdfGraphConfig.Field 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

        public static final RdfGraphConfig.Field JDBC_URL
        jdbc URL pointing to an RDBMS instance
      • USERNAME

        public static final RdfGraphConfig.Field USERNAME
        username to use when connecting to an RDBMS instance
      • DATA_SOURCE_ID

        public static final RdfGraphConfig.Field DATA_SOURCE_ID
        data source id to use to connect to an RDBMS instance
      • MAX_PREFETCHED_ROWS

        public static final RdfGraphConfig.Field MAX_PREFETCHED_ROWS
        maximum number of rows prefetched during each round trip resultset-database
      • OPTIMIZED_FOR

        public static final RdfGraphConfig.Field OPTIMIZED_FOR
        Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates
      • PARTITION_WHILE_LOADING

        public static final RdfGraphConfig.Field PARTITION_WHILE_LOADING
        Indicates if the graph should be partitioned while loading
      • VERTEX_ID_STRATEGY

        public static final RdfGraphConfig.Field 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

        public static final RdfGraphConfig.Field 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

        public static final RdfGraphConfig.Field 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

        public static final RdfGraphConfig.Field EDGE_ID_TYPE
        type of the edge ID. If not specified (or set to null), it will default to long.
      • ARRAY_COMPACTION_THRESHOLD

        public static final RdfGraphConfig.Field 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

        public static final RdfGraphConfig.Field EDGE_PROPS
        specification of edge properties associated with graph
      • EXTERNAL_STORES

        public static final RdfGraphConfig.Field EXTERNAL_STORES
        Specification of the external stores where external string properties reside.
      • ERROR_HANDLING

        public static final RdfGraphConfig.Field ERROR_HANDLING
        error handling configuration
      • LOCAL_DATE_FORMAT

        public static final RdfGraphConfig.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
      • TIME_FORMAT

        public static final RdfGraphConfig.Field 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

        public static final RdfGraphConfig.Field 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

        public static final RdfGraphConfig.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_WITH_TIMEZONE_FORMAT

        public static final RdfGraphConfig.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
      • VECTOR_COMPONENT_DELIMITER

        public static final RdfGraphConfig.Field VECTOR_COMPONENT_DELIMITER
        delimiter for the different components of vector properties
      • POINT2D

        public static final RdfGraphConfig.Field POINT2D
        longitude and latitude as floating point values separated by a space
      • ATTRIBUTES

        public static final RdfGraphConfig.Field ATTRIBUTES
        additional attributes needed to read/write the graph data
      • PASSWORD

        public static final RdfGraphConfig.Field PASSWORD
        password to use when connecting to database
      • KEYSTORE_ALIAS

        public static final RdfGraphConfig.Field KEYSTORE_ALIAS
        alias to the keystore to use when connecting to database
    • Method Detail

      • values

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