oracle.pgx.config

Class FileEntityProviderConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.EntityProviderConfig

oracle.pgx.config.AbstractFileEntityProviderConfig

oracle.pgx.config.FileEntityProviderConfig

All Implemented Interfaces:

CommonLoadableConfig<ProviderFormat>, oracle.pgx.config.internal.ConvertibleToEntityProviderConfigBuilder

@Generated(value="config_generator.py")
public class FileEntityProviderConfig
extends AbstractFileEntityProviderConfig

PGX Engine File Entity Provider Config

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileEntityProviderConfig.Field Fields of PGX Engine File Entity Provider 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)
java.util.Map	getAttributes() additional attributes needed to read/write the graph data
static FileEntityProviderConfig.Field[]	getConfigFields()
java.lang.Object	getDestinationColumn() name or index (starting from 1) of column corresponding to edge destination (for CSV format only)
java.lang.String	getDestinationVertexProvider() name of the destination vertex provider to be used for this edge provider
GraphErrorHandlingConfig	getErrorHandling() error handling configuration
ProviderFormat	getFormat() provider format
java.lang.Object	getKeyColumn() name or index (starting from 1) of column corresponding to keys (for CSV format only)
java.lang.String	getKeystoreAlias() alias to the keystore to use when connecting to database
IdType	getKeyType() type of the keys
java.lang.String	getLabel() label for the entities loaded from this provider
ProviderLoadingConfig	getLoading() loading-specific configuration
java.util.List<java.lang.String>	getLocalDateFormat() array of local_date formats to use when loading and storing local_date properties.
java.lang.String	getName() entity provider name
java.lang.String	getPoint2d() longitude and latitude as floating point values separated by a space
java.util.List<GraphPropertyConfig>	getProps() specification of the properties associated with this entity provider
java.lang.String	getSeparator() a series of single-character separators for tokenizing.
java.lang.Object	getSourceColumn() name or index (starting from 1) of column corresponding to edge source (for CSV format only)
java.lang.String	getSourceVertexProvider() name of the source vertex provider to be used for this edge provider
FileGraphStoringConfig	getStoring() storing-specific configuration
java.util.List<java.lang.String>	getTimeFormat() the time format to use when loading and storing time properties.
java.util.List<java.lang.String>	getTimestampFormat() the timestamp format to use when loading and storing timestamp properties.
java.util.List<java.lang.String>	getTimestampWithTimezoneFormat() the timestamp with timezone format to use when loading and storing timestamp with timezone properties.
java.util.List<java.lang.String>	getTimeWithTimezoneFormat() the time with timezone format to use when loading and storing time with timezone properties.
java.util.List<java.lang.String>	getUris() list of unified resource identifiers
java.util.Map<FileEntityProviderConfig.Field,java.lang.Object>	getValues() Gets the parsed values.
java.util.Map<FileEntityProviderConfig.Field,java.lang.Object>	getValuesWithoutDefaults() Gets the values without defaults.
java.lang.Character	getVectorComponentDelimiter() delimiter for the different components of vector properties
boolean	hasDefaultValue(FileEntityProviderConfig.Field field) Checks for default value.
java.lang.Boolean	hasKeys() indicates if the provided entities data have keys
java.lang.Boolean	isDetectGzip() enable/disable automatic gzip compression detection when loading graphs
boolean	isEmpty() Checks if it's empty.
java.lang.Boolean	isHeader() first line of file is meant for headers, e.g.
static FileEntityProviderConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) Parses an input stream.
static FileEntityProviderConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath) Parses a raw key/value mapping.
static FileEntityProviderConfig	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.AbstractFileEntityProviderConfig

getStoringOptions, hashCode, toEntityProviderConfigBuilder

Methods inherited from class oracle.pgx.config.EntityProviderConfig

getDestinationVertexKeyType, getPropertyDefault, getPropertyDimension, getPropertyName, getPropertyType, getSourceVertexKeyType, isKeyMappingEnabled, isLabelLoadingEnabled, numProperties, supportsPropertyColumn, supportsPropertyColumn, supportsVectorProperties, supportsVectorProperties

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

Methods inherited from interface oracle.pgx.config.CommonLoadableConfig

createLocalDateFormat, createTimeFormat, createTimestampFormat, createTimestampWithTimezoneFormat, createTimeWithTimezoneFormat

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class EntityProviderConfig

getAttributes

public java.util.Map getAttributes()

additional attributes needed to read/write the graph data

Specified by:

getAttributes in interface CommonLoadableConfig<ProviderFormat>

Specified by:

getAttributes in class AbstractFileEntityProviderConfig

Returns:

the map of attributes

getConfigFields

public static FileEntityProviderConfig.Field[] getConfigFields()

getDestinationColumn

public java.lang.Object getDestinationColumn()

name or index (starting from 1) of column corresponding to edge destination (for CSV format only)

Specified by:

getDestinationColumn in class AbstractFileEntityProviderConfig

getDestinationVertexProvider

public java.lang.String getDestinationVertexProvider()

name of the destination vertex provider to be used for this edge provider

Specified by:

getDestinationVertexProvider in class EntityProviderConfig

Returns:

the name of the destination vertex provider

getErrorHandling

public GraphErrorHandlingConfig getErrorHandling()

error handling configuration

Returns:

the error handling configuration

getFormat

public ProviderFormat getFormat()

provider format

Returns:

the format

getKeyColumn

public java.lang.Object getKeyColumn()

name or index (starting from 1) of column corresponding to keys (for CSV format only)

Specified by:

getKeyColumn in class AbstractFileEntityProviderConfig

getKeystoreAlias

public java.lang.String getKeystoreAlias()

alias to the keystore to use when connecting to database

Returns:

the keystore alias or null if underlying format does not require a keystore

getKeyType

public IdType getKeyType()

type of the keys

Specified by:

getKeyType in class EntityProviderConfig

Returns:

the key type

getLabel

public java.lang.String getLabel()

label for the entities loaded from this provider

Specified by:

getLabel in class EntityProviderConfig

Returns:

the custom label

getLoading

public ProviderLoadingConfig getLoading()

loading-specific configuration

Specified by:

getLoading in class EntityProviderConfig

Returns:

the loading configuration

getLocalDateFormat

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

array of local_date formats to use when loading and storing local_date properties. Please see DateTimeFormatter for a documentation of the format string

Returns:

the date format

getName

public java.lang.String getName()

entity provider name

Specified by:

getName in interface CommonLoadableConfig<ProviderFormat>

Overrides:

getName in class AbstractFileEntityProviderConfig

Returns:

the graph name

getPoint2d

public java.lang.String getPoint2d()

longitude and latitude as floating point values separated by a space

getProps

public java.util.List<GraphPropertyConfig> getProps()

specification of the properties associated with this entity provider

Specified by:

getProps in class EntityProviderConfig

Returns:

the list of vertex properties

getSeparator

public java.lang.String getSeparator()

a series of single-character separators for tokenizing. The characters ", {, } and \n cannot be used as separators. Default value is "," for CSV files, and "\t " for other formats. The first character will be used as a separator when storing.

Specified by:

getSeparator in class AbstractFileEntityProviderConfig

Returns:

the separator

getSourceColumn

public java.lang.Object getSourceColumn()

name or index (starting from 1) of column corresponding to edge source (for CSV format only)

Specified by:

getSourceColumn in class AbstractFileEntityProviderConfig

getSourceVertexProvider

public java.lang.String getSourceVertexProvider()

name of the source vertex provider to be used for this edge provider

Specified by:

getSourceVertexProvider in class EntityProviderConfig

Returns:

the name of the source vertex provider

getStoring

public FileGraphStoringConfig getStoring()

storing-specific configuration

Specified by:

getStoring in class AbstractFileEntityProviderConfig

Returns:

the storing configuration

getTimeFormat

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

the time format to use when loading and storing time properties. Please see DateTimeFormatter for a documentation of the format string

Returns:

the time format

getTimestampFormat

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

the timestamp format to use when loading and storing timestamp properties. Please see DateTimeFormatter for a documentation of the format string

Returns:

the timestamp format

getTimestampWithTimezoneFormat

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

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

Returns:

the timestamp with timezone format

getTimeWithTimezoneFormat

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

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

Returns:

the time with timezone format

getUris

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

list of unified resource identifiers

Specified by:

getUris in class AbstractFileEntityProviderConfig

Returns:

the list of URIs

getValues

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

Gets the parsed values.

Returns:

the parsed values

getValuesWithoutDefaults

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

Gets the values without defaults.

Returns:

the values without defaults

getVectorComponentDelimiter

public java.lang.Character getVectorComponentDelimiter()

delimiter for the different components of vector properties

hasDefaultValue

public boolean hasDefaultValue(FileEntityProviderConfig.Field field)

Checks for default value.

Parameters:

field - the field

Returns:

true, if value for given field is the default value

hasKeys

public java.lang.Boolean hasKeys()

indicates if the provided entities data have keys

Specified by:

hasKeys in class EntityProviderConfig

isDetectGzip

public java.lang.Boolean isDetectGzip()

enable/disable automatic gzip compression detection when loading graphs

Specified by:

isDetectGzip in class AbstractFileEntityProviderConfig

Returns:

true if GZip file automatic detection is enabled, false otherwise.

isEmpty

public boolean isEmpty()

Checks if it's empty.

Returns:

true, if the Map 'values' is empty.

isHeader

public java.lang.Boolean isHeader()

first line of file is meant for headers, e.g. 'EdgeId, SourceId, DestId, EdgeProp1, EdgeProp2'

Specified by:

isHeader in class AbstractFileEntityProviderConfig

Returns:

Whether the file has a header or not

parse

public static FileEntityProviderConfig 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 FileEntityProviderConfig 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 FileEntityProviderConfig 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)