Package oracle.pgx.config

Class AnalysisTaskConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.AnalysisTaskConfig

@Generated("config_generator.py")
public class AnalysisTaskConfig
extends AbstractConfig

analysis task config

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnalysisTaskConfig.Field	Fields of analysis task config

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static AnalysisTaskConfig.Field[]	getConfigFields()
java.util.Map<java.lang.String,java.lang.Object>	getLeftoverValues()	Gets the values that do not belong to any field.
java.lang.Integer	getMaxThreads()	a hard limit on the number of threads to use for a task.
TaskPriority	getPriority()	the priority of the task.
java.util.Map<AnalysisTaskConfig.Field,java.lang.Object>	getValues()	Gets the parsed values.
java.util.Map<AnalysisTaskConfig.Field,java.lang.Object>	getValuesWithoutDefaults()	Gets the values without defaults.
java.lang.Integer	getWeight()	the weight of the task.
boolean	hasDefaultValue(AnalysisTaskConfig.Field field)	Checks for default value.
boolean	isEmpty()	Checks if it's empty.
static AnalysisTaskConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)	Parses an input stream.
static AnalysisTaskConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)	Parses a raw key/value mapping.
static AnalysisTaskConfig	parse(java.util.Properties props, boolean strict)	Parses a properties file.
java.lang.String	toString()
java.lang.String	toString(boolean hideSensitiveData)

Methods inherited from class oracle.pgx.config.AbstractConfig

getDefault, getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

parse

public static AnalysisTaskConfig 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 AnalysisTaskConfig 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 AnalysisTaskConfig 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

getConfigFields

public static AnalysisTaskConfig.Field[] getConfigFields()

getValues

public java.util.Map<AnalysisTaskConfig.Field,java.lang.Object> getValues()

Gets the parsed values.

Specified by:

getValues in class AbstractConfig

Returns:

the parsed values

isEmpty

public boolean isEmpty()

Checks if it's empty.

Returns:

true, if the Map 'values' is empty.

hasDefaultValue

public boolean hasDefaultValue(AnalysisTaskConfig.Field field)

Checks for default value.

Parameters:

field - the field

Returns:

true, if value for given field is the default value

getValuesWithoutDefaults

public java.util.Map<AnalysisTaskConfig.Field,java.lang.Object> getValuesWithoutDefaults()

Gets the values without defaults.

Returns:

the values without defaults

getLeftoverValues

public java.util.Map<java.lang.String,java.lang.Object> getLeftoverValues()

Gets the values that do not belong to any field.

Returns:

the values that do not belong to any field

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(boolean hideSensitiveData)

getWeight

public java.lang.Integer getWeight()

the weight of the task. Threads are given to tasks proportionally to their weight. Tasks with higher weight will get more threads than tasks with lower weight. Tasks with the same weight will get the same amount of threads.

getPriority

public TaskPriority getPriority()

the priority of the task. Threads are given to the task with the highest priority at the moment of execution. If there are more threads that have the highest priority, threads are given to the tasks according to their weight

getMaxThreads

public java.lang.Integer getMaxThreads()

a hard limit on the number of threads to use for a task.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object