oracle.pgx.config

Class GraphPropertyConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.AbstractGraphPropertyConfig

oracle.pgx.config.GraphPropertyConfig

All Implemented Interfaces:

java.io.Serializable

@Generated(value="config_generator.py")
public class GraphPropertyConfig
extends AbstractGraphPropertyConfig

PGX Engine Graph Property Config

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphPropertyConfig.Field Fields of PGX Engine Graph Property 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 and Description
boolean	equals(java.lang.Object obj)
Aggregate	getAggregate() [currently unsupported] which aggregation function to use, aggregation always happens by vertex key
java.lang.Object	getColumn() name or index (starting from 0) of the column holding the property data.
static GraphPropertyConfig.Field[]	getConfigFields()
java.lang.Object	getDefault() default value to be assigned to this property if datasource does not provide it.
java.lang.Integer	getDimension() dimension of property
java.lang.Object	getField() name of the JSON field holding the property data.
java.util.List<java.lang.String>	getFormat() array of formats of property
java.lang.String	getGroupKey() [currently unsupported] can only be used if the property / key is part of the grouping expression
java.util.Map<java.lang.String,java.lang.Object>	getLeftoverValues() Gets the values that do not belong to any field.
java.lang.Integer	getMaxDistinctStringsPerPool() [only relevant if string_pooling_strategy is indexed] amount of distinct strings per property after which to stop pooling.
java.lang.String	getName() name of property
java.util.List<java.util.Map>	getStores() A list of storage identifiers that indicate where this property resides.
StringPoolingStrategy	getStringPoolingStrategy() which string pooling strategy to use.
PropertyType	getType() type of property (Note: date is deprecated, use one of local_date / time / timestamp / time_with_timezone / timestamp_with_timezone instead).
java.util.Map<GraphPropertyConfig.Field,java.lang.Object>	getValues() Gets the parsed values.
java.util.Map<GraphPropertyConfig.Field,java.lang.Object>	getValuesWithoutDefaults() Gets the values without defaults.
boolean	hasDefaultValue(GraphPropertyConfig.Field field) Checks for default value.
java.lang.Boolean	isDropAfterLoading() [currently unsupported] indicating helper properties only used for aggregation, which are dropped after loading
boolean	isEmpty() Checks if it's empty.
static GraphPropertyConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) Parses an input stream.
static GraphPropertyConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath) Parses a raw key/value mapping.
static GraphPropertyConfig	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.AbstractGraphPropertyConfig

getParsedDefaultValue, hashCode, isExternal, isInMemory, isStringPoolEnabled

Methods inherited from class oracle.pgx.config.AbstractConfig

getDefault, getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getAggregate

public Aggregate getAggregate()

[currently unsupported] which aggregation function to use, aggregation always happens by vertex key

getColumn

public java.lang.Object getColumn()

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)

Specified by:

getColumn in class AbstractGraphPropertyConfig

getConfigFields

public static GraphPropertyConfig.Field[] getConfigFields()

getDefault

public java.lang.Object getDefault()

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).

getDimension

public java.lang.Integer getDimension()

dimension of property

getField

public java.lang.Object getField()

name of the JSON field holding the property data. Nesting is denoted by dot - separation. Field names containing dots are possible, in this case the dots need to be escaped using backslashes to resolve ambiguities. Only the exactly specified object are loaded, if they are non existent, the default value is used

getFormat

public java.util.List<java.lang.String> getFormat()

array of formats of property

Specified by:

getFormat in class AbstractGraphPropertyConfig

getGroupKey

public java.lang.String getGroupKey()

[currently unsupported] can only be used if the property / key is part of the grouping expression

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

getMaxDistinctStringsPerPool

public java.lang.Integer getMaxDistinctStringsPerPool()

[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.

getName

public java.lang.String getName()

name of property

Specified by:

getName in class AbstractGraphPropertyConfig

getStores

public java.util.List<java.util.Map> getStores()

A list of storage identifiers that indicate where this property resides.

Specified by:

getStores in class AbstractGraphPropertyConfig

getStringPoolingStrategy

public StringPoolingStrategy getStringPoolingStrategy()

which string pooling strategy to use. If set to null, the default value from the global PGX configuration will be used.

getType

public PropertyType getType()

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.

Specified by:

getType in class AbstractGraphPropertyConfig

getValues

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

Gets the parsed values.

Specified by:

getValues in class AbstractConfig

Returns:

the parsed values

getValuesWithoutDefaults

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

Gets the values without defaults.

Returns:

the values without defaults

hasDefaultValue

public boolean hasDefaultValue(GraphPropertyConfig.Field field)

Checks for default value.

Parameters:

field - the field

Returns:

true, if value for given field is the default value

isDropAfterLoading

public java.lang.Boolean isDropAfterLoading()

[currently unsupported] indicating helper properties only used for aggregation, which are dropped after loading

isEmpty

public boolean isEmpty()

Checks if it's empty.

Returns:

true, if the Map 'values' is empty.

parse

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

toString

public java.lang.String toString(boolean hideSensitiveData)