Package oracle.pgx.config

Class FileEntityProviderConfigBuilder

java.lang.Object

oracle.pgx.config.AbstractEntityProviderConfigBuilder<FileEntityProviderConfigBuilder,FileEntityProviderConfig>

oracle.pgx.config.FileEntityProviderConfigBuilder

All Implemented Interfaces:

oracle.pgx.config.internal.ConvertibleToEntityProviderConfigBuilder

public class FileEntityProviderConfigBuilder
extends AbstractEntityProviderConfigBuilder<FileEntityProviderConfigBuilder,FileEntityProviderConfig>

A table configuration builder for file-based table configurations.

Constructor Summary

Constructors

Constructor	Description
FileEntityProviderConfigBuilder()
FileEntityProviderConfigBuilder(ProviderFormat format)

Method Summary

Modifier and Type	Method	Description
FileEntityProviderConfigBuilder	addUri(java.lang.String uri)	Adds a unified resource identifier (URI) pointing to a file with table data.
FileEntityProviderConfigBuilder	copyFrom(FileEntityProviderConfig tableConfig)	Sets this builder with all the values of the given provider config.
FileEntityProviderConfigBuilder	detectGzip(boolean detectGzip)	Defines if gzip detection is enabled or not
FileEntityProviderConfigBuilder	hasHeader(boolean hasHeader)	Defines if file has a header or not
FileEntityProviderConfigBuilder	setDestinationColumn(java.lang.Object column)	Sets the column containing the destination.
FileEntityProviderConfigBuilder	setDestinationKeyColumns(java.util.List<? extends ForeignKeyColumnDescriptor> destinationKeyColumns)	Set destination key columns, i.e., a list of columns with foreign key relations to key columns in the destination vertex provider.
FileEntityProviderConfigBuilder	setFormat(ProviderFormat format)	Sets the file format.
FileEntityProviderConfigBuilder	setKeyColumn(java.lang.Object column)	Sets the column containing the key.
FileEntityProviderConfigBuilder	setSeparator(java.lang.String separator)	Sets the separator.
FileEntityProviderConfigBuilder	setSourceColumn(java.lang.Object column)	Sets the column containing the source.
FileEntityProviderConfigBuilder	setSourceKeyColumns(java.util.List<? extends ForeignKeyColumnDescriptor> sourceKeyColumns)	Set source key columns, i.e., a list of columns with foreign key relations to key columns in the source vertex provider.
FileEntityProviderConfigBuilder	setStoringOptions(FileGraphStoringConfig storing)	Sets the storing configuration.
FileEntityProviderConfigBuilder	setUris(java.lang.Iterable<java.lang.String> uris)	Sets the unified resource identifier (URI) list pointing to multiple files with table data.
FileEntityProviderConfigBuilder	setUris(java.lang.String... uris)	Sets the unified resource identifier (URI) list pointing to multiple files with table data.
FileEntityProviderConfigBuilder	setVectorComponentDelimiter(java.lang.Character delimiter)	Set the delimiter for the components of vector properties
FileEntityProviderConfigBuilder	toEntityProviderConfigBuilder()

Methods inherited from class oracle.pgx.config.AbstractEntityProviderConfigBuilder

addAttribute, addProperty, addProperty, addProperty, addStringProperty, addStringProperty, addVectorProperty, addVectorProperty, addVectorProperty, addVectorProperty, build, clearProperties, copyBaseFrom, createKeyMapping, enableEdgeIdDuplicateCheck, enableVertexIdDuplicateCheck, redactPassword, removeProperty, setDestinationVertexKeyType, setDestinationVertexProvider, setErrorHandlingOnDuplicateEntityId, setErrorHandlingOnMissedPropKey, setErrorHandlingOnMissingVertex, setErrorHandlingOnParsingIssue, setErrorHandlingOnPropConversion, setErrorHandlingOnTypeMismatch, setErrorHandlingOnVectorLengthMismatch, setHasKeys, setKeyColumns, setKeystoreAlias, setKeyType, setLabel, setLocalDateFormat, setName, setPassword, setSourceVertexKeyType, setSourceVertexProvider, setStrictMode, setTimeFormat, setTimestampFormat, setTimestampWithTimezoneFormat, setTimeWithTimezoneFormat

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileEntityProviderConfigBuilder

public FileEntityProviderConfigBuilder()

FileEntityProviderConfigBuilder

public FileEntityProviderConfigBuilder(ProviderFormat format)

Method Detail

toEntityProviderConfigBuilder

public FileEntityProviderConfigBuilder toEntityProviderConfigBuilder()

copyFrom

public FileEntityProviderConfigBuilder copyFrom(FileEntityProviderConfig tableConfig)

Description copied from class: AbstractEntityProviderConfigBuilder

Sets this builder with all the values of the given provider config. If a format was already specified it will remain unchanged, however any other values copied from the given provider config will overwrite the corresponding values of this builder.

Overrides:

copyFrom in class AbstractEntityProviderConfigBuilder<FileEntityProviderConfigBuilder,FileEntityProviderConfig>

Parameters:

tableConfig - the provider configuration from which to copy the values

Returns:

this builder

setFormat

public FileEntityProviderConfigBuilder setFormat(ProviderFormat format)

Sets the file format.

Parameters:

format - the format

Returns:

this builder

setSeparator

public FileEntityProviderConfigBuilder setSeparator(java.lang.String separator)

Sets the separator.

Parameters:

separator - the separator

Returns:

this builder

See Also:

"the table configuration documentation for details about the effects and default of this setting"

hasHeader

public FileEntityProviderConfigBuilder hasHeader(boolean hasHeader)

Defines if file has a header or not

Parameters:

hasHeader - the flag to set

Returns:

this builder

See Also:

"the table configuration documentation for details about the effects and default of this setting"

detectGzip

public FileEntityProviderConfigBuilder detectGzip(boolean detectGzip)

Defines if gzip detection is enabled or not

Parameters:

detectGzip - the flag to set

Returns:

this builder

See Also:

"the table configuration documentation for details about the effects and default of this setting"

addUri

public FileEntityProviderConfigBuilder addUri(java.lang.String uri)

Adds a unified resource identifier (URI) pointing to a file with table data.

Parameters:

uri - the uri

Returns:

this builder

setUris

public FileEntityProviderConfigBuilder setUris(java.lang.Iterable<java.lang.String> uris)

Sets the unified resource identifier (URI) list pointing to multiple files with table data.

Parameters:

uris - the list of uris

Returns:

this builder

setUris

public FileEntityProviderConfigBuilder setUris(java.lang.String... uris)

Sets the unified resource identifier (URI) list pointing to multiple files with table data.

Parameters:

uris - the array of uris

Returns:

this builder

setVectorComponentDelimiter

public FileEntityProviderConfigBuilder setVectorComponentDelimiter(java.lang.Character delimiter)

Set the delimiter for the components of vector properties

Parameters:

delimiter - the delimiter for the components of the vector properties

Returns:

this builder

setStoringOptions

public FileEntityProviderConfigBuilder setStoringOptions(FileGraphStoringConfig storing)

Sets the storing configuration.

Parameters:

storing - the storing configuration

Returns:

this builder

setKeyColumn

public FileEntityProviderConfigBuilder setKeyColumn(java.lang.Object column)

Sets the column containing the key. (for CSV format only)

Parameters:

column - the column name or index

Returns:

this builder

See Also:

API with support for multiple key columns

setSourceColumn

public FileEntityProviderConfigBuilder setSourceColumn(java.lang.Object column)

Sets the column containing the source. (for CSV format only)

Parameters:

column - the column name or index

Returns:

this builder

See Also:

API with support for multiple key columns

setSourceKeyColumns

@BetaApi
public FileEntityProviderConfigBuilder setSourceKeyColumns(java.util.List<? extends ForeignKeyColumnDescriptor> sourceKeyColumns)

Set source key columns, i.e., a list of columns with foreign key relations to key columns in the source vertex provider.

Parameters:

sourceKeyColumns - source key columns

Returns:

this builder

Since:

25.2.0

setDestinationColumn

public FileEntityProviderConfigBuilder setDestinationColumn(java.lang.Object column)

Sets the column containing the destination. (for CSV format only)

Parameters:

column - the column name or index

Returns:

this builder

See Also:

API with support for multiple key columns

setDestinationKeyColumns

@BetaApi
public FileEntityProviderConfigBuilder setDestinationKeyColumns(java.util.List<? extends ForeignKeyColumnDescriptor> destinationKeyColumns)

Set destination key columns, i.e., a list of columns with foreign key relations to key columns in the destination vertex provider.

Parameters:

destinationKeyColumns - destination key columns

Returns:

this builder

Since:

25.2.0