RuntimeConfig (Oracle Big Data Spatial and Graph In-memory Analyst Java API Reference v2.2.0 (E62127

java.lang.Object
- oracle.pgx.config.AbstractConfig
- - oracle.pgx.config.AbstractRuntimeConfig
  - - oracle.pgx.config.RuntimeConfig

@Generated(value="config_generator.py")
public class RuntimeConfig
extends AbstractRuntimeConfig

PGX Runtime Config

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RuntimeConfig.Field
Fields of PGX Runtime Config

Nested Classes
Modifier and Type	Class and Description
`static class`	`RuntimeConfig.Field` Fields of PGX Runtime Config

Field Summary
- Fields inherited from class oracle.pgx.config.AbstractConfig
  ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Integer`	`getBfsIterateQueTaskSize()` task size for BFS iterate QUE phase
`java.lang.Integer`	`getBfsThresholdReadBased()` threshold of BFS traversal level items to switch to read-based visiting strategy
`java.lang.Integer`	`getBfsThresholdSingleThreaded()` until what number of BFS traversal level items vertices are visited single-threaded
`java.lang.String`	`getCharacterSet()` standard charset to use throughout PGX, UTF-8 will be used as default.
`java.lang.Integer`	`getCniDiffFactorDefault()` default diff factor value used in the common neighbor iterator implementations.
`java.lang.Integer`	`getCniSmallDefault()` default value used in the common neighbor iterator implementations, to indicate below which threshold a subarray is considered small.
`java.lang.Integer`	`getCniStopRecursionDefault()` default value used in the common neighbor iterator implementations, to indicate the minimum size where the binary search approach is applied.
`java.lang.Integer`	`getDfsThresholdLarge()` value that determines at which number of visited vertices the DFS implementation will switch to data-structures that are more optimized for larger numbers of vertices.
`EnterpriseSchedulerFlagsConfig`	`getEnterpriseSchedulerFlags()` [relevant for `enterprise_scheduler`] enterprise scheduler specific settings.
`java.lang.Integer`	`getLargeArrayThreshold()` threshold when the size of an array is too big to use a normal Java array.
`java.lang.Integer`	`getMaxOffHeapSize()` maximum amount of off-heap memory PGX is allowed to allocate in megabytes, before an OutOfMemoryError will be thrown.
`MemoryAllocationStrategy`	`getMemoryAllocator()` which memory allocator to use
`FrontierTypeStrategy`	`getMsBfsFrontierTypeStrategy()` the type strategy to use for MS-BFS frontiers
`java.lang.Integer`	`getNumSpinLocks()` how many spin locks each generated app will create at instantiation.
`java.lang.Integer`	`getParallelism()` number of worker threads to be used in thread pool.
`oracle.pgx.config.ParallelizationStrategy`	`getParallelizationStrategy()` Deprecated.
`java.lang.Integer`	`getPatternMatchingSupernodeCacheThreshold()` minimum number of a node's neighbor to be a supernode.
`RandomGeneratorStrategy`	`getRandomGeneratorStrategy()` method of generating random numbers in pgx
`java.lang.Long`	`getRandomSeed()` [relevant for `deterministic` random number generator only] seed for the deterministic random number generator used in pgx.
`java.lang.Integer`	`getRevisitThreshold()` maximum number of matched results from a node to be cached
`SchedulerStrategy`	`getScheduler()` which scheduler to use.
`java.lang.Integer`	`getSmallTaskLength()` task length if total amount of work is small than default task length (only relevant for task-stealing strategies)
`java.lang.Integer`	`getTaskLength()` default task length (only relevant for task-stealing strategies).
`java.util.Map<RuntimeConfig.Field,java.lang.Object>`	`getValues()` Gets the parsed values.
`java.util.Map<RuntimeConfig.Field,java.lang.Object>`	`getValuesWithoutDefaults()` Gets the values without defaults.
`boolean`	`hasDefaultValue(RuntimeConfig.Field field)` Checks for default value.
`boolean`	`isEmpty()` Checks if it's empty.
`java.lang.Boolean`	`isEnableSolarisStudioLabeling()` [relevant when profiling with `solaris studio`] when enabled, label experiments using the 'er_label' command
`java.lang.Boolean`	`isExplicitSpinLocks()` `true` means spin explicitly in a loop until lock becomes available.
`static RuntimeConfig`	`parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)` Parses an input stream.
`static RuntimeConfig`	`parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)` Parses a raw key/value mapping.
`static RuntimeConfig`	`parse(java.util.Properties props, boolean strict)` Parses a properties file.
`java.lang.String`	`toString()`
`java.lang.Boolean`	`useStringPool()` If `true`, PGX will store string properties in a pool in order to consume less memory on string properties

Methods inherited from class oracle.pgx.config.AbstractRuntimeConfig
areWeEnterprise, getInstance, getInstance, getInstance, reset

Methods inherited from class oracle.pgx.config.AbstractConfig
getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

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

- Method Detail
  - getBfsIterateQueTaskSize
```
public java.lang.Integer getBfsIterateQueTaskSize()
```
    task size for BFS iterate QUE phase
  - getBfsThresholdReadBased
```
public java.lang.Integer getBfsThresholdReadBased()
```
    threshold of BFS traversal level items to switch to read-based visiting strategy
  - getBfsThresholdSingleThreaded
```
public java.lang.Integer getBfsThresholdSingleThreaded()
```
    until what number of BFS traversal level items vertices are visited single-threaded
  - getCharacterSet
```
public java.lang.String getCharacterSet()
```
    standard charset to use throughout PGX, UTF-8 will be used as default. Note: Some formats may not be compatible.
  - getCniDiffFactorDefault
```
public java.lang.Integer getCniDiffFactorDefault()
```
    default diff factor value used in the common neighbor iterator implementations.
  - getCniSmallDefault
```
public java.lang.Integer getCniSmallDefault()
```
    default value used in the common neighbor iterator implementations, to indicate below which threshold a subarray is considered small.
  - getCniStopRecursionDefault
```
public java.lang.Integer getCniStopRecursionDefault()
```
    default value used in the common neighbor iterator implementations, to indicate the minimum size where the binary search approach is applied.
  - getDfsThresholdLarge
```
public java.lang.Integer getDfsThresholdLarge()
```
    value that determines at which number of visited vertices the DFS implementation will switch to data-structures that are more optimized for larger numbers of vertices.
  - getEnterpriseSchedulerFlags
```
public EnterpriseSchedulerFlagsConfig getEnterpriseSchedulerFlags()
```
    [relevant for enterprise_scheduler] enterprise scheduler specific settings.
  - getLargeArrayThreshold
```
public java.lang.Integer getLargeArrayThreshold()
```
    threshold when the size of an array is too big to use a normal Java array. This depends on the used JVM. (defaults to Integer.MAX_VALUE - 3)
  - getMaxOffHeapSize
```
public java.lang.Integer getMaxOffHeapSize()
```
    maximum amount of off-heap memory PGX is allowed to allocate in megabytes, before an OutOfMemoryError will be thrown. Note: this limit is not guaranteed to never be exceeded because of rounding and synchronization trade-offs. It only serves as threshold when PGX starts to reject new memory allocation requests.
  - getMemoryAllocator
```
public MemoryAllocationStrategy getMemoryAllocator()
```
    which memory allocator to use
    
    Specified by:
    
    getMemoryAllocator in class AbstractRuntimeConfig
  - getMsBfsFrontierTypeStrategy
```
public FrontierTypeStrategy getMsBfsFrontierTypeStrategy()
```
    the type strategy to use for MS-BFS frontiers
  - getNumSpinLocks
```
public java.lang.Integer getNumSpinLocks()
```
    how many spin locks each generated app will create at instantiation. Trade-off: small number implies less memory consumption. Big number implies faster execution (if algorithm uses spin locks)
  - getParallelism
```
public java.lang.Integer getParallelism()
```
    number of worker threads to be used in thread pool. Note: if caller thread is part of another thread-pool, this value is ignored and parallelism of parent pool is used.
  - getParallelizationStrategy
```
@Deprecated
public oracle.pgx.config.ParallelizationStrategy getParallelizationStrategy()
```
    Deprecated.
    
    which parallelization strategy to use. This field is deprecated and you should rather use the scheduler parameter.
    segmented, task_stealing, task_stealing_counted = F/J pool using counted completers to reduce joins. See basic_scheduler
    rts = more advanced scheduler. See enterprise_scheduler
  - getPatternMatchingSupernodeCacheThreshold
```
public java.lang.Integer getPatternMatchingSupernodeCacheThreshold()
```
    minimum number of a node's neighbor to be a supernode. This is for pattern matching engine.
  - getRandomGeneratorStrategy
```
public RandomGeneratorStrategy getRandomGeneratorStrategy()
```
    method of generating random numbers in pgx
  - getRandomSeed
```
public java.lang.Long getRandomSeed()
```
    [relevant for deterministic random number generator only] seed for the deterministic random number generator used in pgx. The default is -24466691093057031
  - getRevisitThreshold
```
public java.lang.Integer getRevisitThreshold()
```
    maximum number of matched results from a node to be cached
  - getScheduler
```
public SchedulerStrategy getScheduler()
```
    which scheduler to use.
    basic_scheduler = use scheduler with basic features.
    enterprise_scheduler = use scheduler with advanced, enterprise features for running multiple tasks concurrently and increased performance.
    
    Specified by:
    
    getScheduler in class AbstractRuntimeConfig
  - getSmallTaskLength
```
public java.lang.Integer getSmallTaskLength()
```
    task length if total amount of work is small than default task length (only relevant for task-stealing strategies)
  - getTaskLength
```
public java.lang.Integer getTaskLength()
```
    default task length (only relevant for task-stealing strategies). F/J pool documentation says this value should be between 100 and 10000. Trade-off: small number implies more fine-grained tasks are generated, higher stealing throughput. High number implies less memory consumption and GC activity
  - getValues
```
public java.util.Map<RuntimeConfig.Field,java.lang.Object> getValues()
```
    Gets the parsed values.
    
    Specified by:
    
    getValues in class AbstractRuntimeConfig
    
    Returns:
    
    the parsed values
  - getValuesWithoutDefaults
```
public java.util.Map<RuntimeConfig.Field,java.lang.Object> getValuesWithoutDefaults()
```
    Gets the values without defaults.
    
    Specified by:
    
    getValuesWithoutDefaults in class AbstractRuntimeConfig
    
    Returns:
    
    the values without defaults
  - hasDefaultValue
```
public boolean hasDefaultValue(RuntimeConfig.Field field)
```
    Checks for default value.
    
    Parameters:
    
    field - the field
    
    Returns:
    
    true, if value for given field is the default value
  - isEmpty
```
public boolean isEmpty()
```
    Checks if it's empty.
    
    Returns:
    
    true, if the Map 'values' is empty.
  - isEnableSolarisStudioLabeling
```
public java.lang.Boolean isEnableSolarisStudioLabeling()
```
    [relevant when profiling with solaris studio] when enabled, label experiments using the 'er_label' command
  - isExplicitSpinLocks
```
public java.lang.Boolean isExplicitSpinLocks()
```
    true means spin explicitly in a loop until lock becomes available. false means using JDK locks which rely on the JVM to decide whether to context switch or spin. Our experiments showed that setting this value to true results in better performance.
  - parse
```
public static RuntimeConfig parse(java.io.InputStream is,
                                  boolean strict,
                                  java.lang.String parentPath)
                           throws java.io.IOException
```
    Parses an input stream.
    
    Parameters:
    
    is - the input stream
    
    strict - if true, parses in strict mode
    
    parentPath - if not null, resolves relative paths against this parentPath
    
    Returns:
    
    the parsed graph config
    
    Throws:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - parse
```
public static RuntimeConfig parse(java.util.Map<java.lang.String,java.lang.Object> raw,
                                  boolean strict,
                                  java.lang.String parentPath)
```
    Parses a raw key/value mapping.
    
    Parameters:
    
    raw - the raw key/value mapping to parse
    
    strict - if true, parses in strict mode
    
    parentPath - if not null, resolves relative paths against this parentPath
    
    Returns:
    
    the parsed graph config
  - parse
```
public static RuntimeConfig parse(java.util.Properties props,
                                  boolean strict)
```
    Parses a properties file.
    
    Parameters:
    
    props - the properties to parse
    
    strict - if true, parses in strict mode
    
    Returns:
    
    the parsed graph config
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - useStringPool
```
public java.lang.Boolean useStringPool()
```
    If true, PGX will store string properties in a pool in order to consume less memory on string properties

Class RuntimeConfig

Nested Class Summary

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

Method Summary

Methods inherited from class oracle.pgx.config.AbstractRuntimeConfig

Methods inherited from class oracle.pgx.config.AbstractConfig

Methods inherited from class java.lang.Object

Method Detail

getBfsIterateQueTaskSize

getBfsThresholdReadBased

getBfsThresholdSingleThreaded

getCharacterSet

getCniDiffFactorDefault

getCniSmallDefault

getCniStopRecursionDefault

getDfsThresholdLarge

getEnterpriseSchedulerFlags

getLargeArrayThreshold

getMaxOffHeapSize

getMemoryAllocator

getMsBfsFrontierTypeStrategy

getNumSpinLocks

getParallelism

getParallelizationStrategy

getPatternMatchingSupernodeCacheThreshold

getRandomGeneratorStrategy

getRandomSeed

getRevisitThreshold

getScheduler

getSmallTaskLength

getTaskLength

getValues

getValuesWithoutDefaults

hasDefaultValue

isEmpty

isEnableSolarisStudioLabeling

isExplicitSpinLocks

parse

parse

parse

toString

useStringPool