GraphPropertyConfigBuilder (Oracle Graph Java API Reference Release 20.3 (F15858-03))

java.lang.Object
- oracle.pgx.config.GraphPropertyConfigBuilder

@Generated(value={"common/config/src/templates/ConfigBuilder.stg","common/config/config.gradle"})
public final class GraphPropertyConfigBuilder
extends java.lang.Object

Builder for GraphPropertyConfig.

Constructor Summary

Constructors
Constructor and Description
`GraphPropertyConfigBuilder()` Constructs an empty GraphPropertyConfigBuilder
`GraphPropertyConfigBuilder(GraphPropertyConfig config)` Constructs a GraphPropertyConfigBuilder initialized with the values from the given config
`GraphPropertyConfigBuilder(GraphPropertyConfigBuilder builder)` Constructs a GraphPropertyConfigBuilder initialized with the values from the given builder
`GraphPropertyConfigBuilder(java.util.Map<GraphPropertyConfig.Field,java.lang.Object> values)` Constructs a GraphPropertyConfigBuilder initialized with the values from the given map

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GraphPropertyConfig`	`build()` Builds the GraphPropertyConfig with a `parentPath` of `null`.
`GraphPropertyConfig`	`build(java.lang.String parentPath)` Builds the GraphPropertyConfig.
`static GraphPropertyConfig`	`buildGraphPropertyConfig(java.util.function.Consumer<GraphPropertyConfigBuilder> builderSetup)` Builds a `GraphPropertyConfig` in-place
`GraphPropertyConfigBuilder`	`clear()` Clears all values from the builder
`java.util.Map<GraphPropertyConfig.Field,java.lang.Object>`	`getValues()`
`GraphPropertyConfigBuilder`	`putAll(GraphPropertyConfig config)` Puts all values from the given config into this builder
`GraphPropertyConfigBuilder`	`putAll(java.util.Map<GraphPropertyConfig.Field,java.lang.Object> values)` Puts all values from the given map into this builder.
`GraphPropertyConfigBuilder`	`setColumn(java.lang.Object column)` name or index (starting from 0) of the column holding the property data.
`GraphPropertyConfigBuilder`	`setDefault(java.lang.Object defaultVal)` default value to be assigned to this property if datasource does not provide it.
`GraphPropertyConfigBuilder`	`setDimension(int dimension)` dimension of property
`GraphPropertyConfigBuilder`	`setFormat(java.lang.String... format)` array of formats of property
`GraphPropertyConfigBuilder`	`setMaxDistinctStringsPerPool(int maxDistinctStringsPerPool)` [only relevant if `string_pooling_strategy` is `indexed`] amount of distinct strings per property after which to stop pooling.
`GraphPropertyConfigBuilder`	`setName(java.lang.String name)` name of property
`GraphPropertyConfigBuilder`	`setStores(java.lang.Object... stores)` A list of storage identifiers that indicate where this property resides.
`GraphPropertyConfigBuilder`	`setStringPoolingStrategy(StringPoolingStrategy stringPoolingStrategy)` [only relevant if `use_string_pool` is enabled] which string pooling strategy to use.
`GraphPropertyConfigBuilder`	`setType(PropertyType type)` type of property (Note: `date` is deprecated, use one of `local_date` / `time` / `timestamp` / `time_with_timezone` / `timestamp_with_timezone` instead).
`GraphPropertyConfigBuilder`	`setUseStringPool(boolean useStringPool)` If `true`, PGX will store string properties in a pool in order to consume less memory on string properties
`java.io.InputStream`	`toInputStream()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GraphPropertyConfigBuilder
```
public GraphPropertyConfigBuilder()
```
    Constructs an empty GraphPropertyConfigBuilder
  - GraphPropertyConfigBuilder
```
public GraphPropertyConfigBuilder(GraphPropertyConfig config)
```
    Constructs a GraphPropertyConfigBuilder initialized with the values from the given config
    
    Parameters:
    
    config - the configuration to take the values from
  - GraphPropertyConfigBuilder
```
public GraphPropertyConfigBuilder(GraphPropertyConfigBuilder builder)
```
    Constructs a GraphPropertyConfigBuilder initialized with the values from the given builder
    
    Parameters:
    
    builder - the builder to take the values from
  - GraphPropertyConfigBuilder
```
public GraphPropertyConfigBuilder(java.util.Map<GraphPropertyConfig.Field,java.lang.Object> values)
```
    Constructs a GraphPropertyConfigBuilder initialized with the values from the given map
    
    Parameters:
    
    values - a map containing configuration values
- Method Detail
  - build
```
public GraphPropertyConfig build()
```
    Builds the GraphPropertyConfig with a parentPath of null.
    
    Returns:
    
    An instance of GraphPropertyConfig
    
    See Also:
    
    build(String)
  - build
```
public GraphPropertyConfig build(java.lang.String parentPath)
```
    Builds the GraphPropertyConfig.
    
    Parameters:
    
    parentPath - if not null, resolves relative paths against this parentPath
    
    Returns:
    
    an instance of GraphPropertyConfig
  - buildGraphPropertyConfig
```
public static GraphPropertyConfig buildGraphPropertyConfig(java.util.function.Consumer<GraphPropertyConfigBuilder> builderSetup)
```
    Builds a GraphPropertyConfig in-place
    
    Parameters:
    
    builderSetup - a consumer to setup a newly created GraphPropertyConfig
  - clear
```
public GraphPropertyConfigBuilder clear()
```
    Clears all values from the builder
  - getValues
```
public java.util.Map<GraphPropertyConfig.Field,java.lang.Object> getValues()
```
    Returns:
    
    the raw config values
  - putAll
```
public GraphPropertyConfigBuilder putAll(GraphPropertyConfig config)
```
    Puts all values from the given config into this builder
    
    Parameters:
    
    config - the config to take the values from
  - putAll
```
public GraphPropertyConfigBuilder putAll(java.util.Map<GraphPropertyConfig.Field,java.lang.Object> values)
```
    Puts all values from the given map into this builder.
    
    Parameters:
    
    values - the values to put in the builder
  - setColumn
```
public GraphPropertyConfigBuilder setColumn(java.lang.Object column)
```
    name or index (starting from 0) 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)
  - setDefault
```
public GraphPropertyConfigBuilder setDefault(java.lang.Object defaultVal)
```
    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 with yyyy-MM-dd HH:mm:ss. If no default is present (null), non-existent properties will contain default Java types (primitives) or empty string (string) or 01.01.1970 00:00 (date).
  - setDimension
```
public GraphPropertyConfigBuilder setDimension(int dimension)
```
    dimension of property
  - setFormat
```
public GraphPropertyConfigBuilder setFormat(java.lang.String... format)
```
    array of formats of property
    
    Parameters:
    
    format - possible format for property
  - setMaxDistinctStringsPerPool
```
public GraphPropertyConfigBuilder setMaxDistinctStringsPerPool(int maxDistinctStringsPerPool)
```
    [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.
  - setName
```
public GraphPropertyConfigBuilder setName(java.lang.String name)
```
    name of property
  - setStores
```
public GraphPropertyConfigBuilder setStores(java.lang.Object... stores)
```
    A list of storage identifiers that indicate where this property resides.
    
    Parameters:
    
    stores - Describes the name of the external system where this property resides.
  - setStringPoolingStrategy
```
public GraphPropertyConfigBuilder setStringPoolingStrategy(StringPoolingStrategy stringPoolingStrategy)
```
    [only relevant if use_string_pool is enabled] which string pooling strategy to use. If set to null, the default value from the global PGX configuration will be used.
  - setType
```
public GraphPropertyConfigBuilder setType(PropertyType 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.
  - setUseStringPool
```
public GraphPropertyConfigBuilder setUseStringPool(boolean useStringPool)
```
    If true, PGX will store string properties in a pool in order to consume less memory on string properties
  - toInputStream
```
public java.io.InputStream toInputStream()
```
    Returns:
    
    an InputStream representing the config
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class GraphPropertyConfigBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GraphPropertyConfigBuilder

GraphPropertyConfigBuilder

GraphPropertyConfigBuilder

GraphPropertyConfigBuilder

Method Detail

build

build

buildGraphPropertyConfig

clear

getValues

putAll

putAll

setColumn

setDefault

setDimension

setFormat

setMaxDistinctStringsPerPool

setName

setStores

setStringPoolingStrategy

setType

setUseStringPool

toInputStream

toString