Package oracle.pgx.config

Class AbstractFileEntityProviderConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.EntityProviderConfig

oracle.pgx.config.AbstractFileEntityProviderConfig

All Implemented Interfaces:

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

Direct Known Subclasses:

FileEntityProviderConfig

public abstract class AbstractFileEntityProviderConfig
extends EntityProviderConfig

Abstract super-class for all file-based provider configs

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor	Description
AbstractFileEntityProviderConfig()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
abstract java.util.Map	getAttributes()	Get the file-system specific additional attributes needed to read/write the table data
abstract java.lang.Object	getDestinationColumn()	name or index (starting from 1) of column corresponding to edge destination (for CSV format only)
abstract java.lang.Object	getKeyColumn()	name or index (starting from 1) of column corresponding to keys (for CSV format only)
java.lang.String	getName()	Get the name of this provider configuration
abstract java.lang.String	getSeparator()	Get the separator of this table configuration
abstract java.lang.Object	getSourceColumn()	name or index (starting from 1) of column corresponding to edge source (for CSV format only)
FileGraphStoringConfig	getStoringOptions()	Get the storing configuration
abstract java.util.List<java.lang.String>	getUris()	Get the unified resource identifiers for the files with the table data
int	hashCode()
abstract java.lang.Boolean	isDetectGzip()	Whether GZip file automatic detection is enabled or not.
abstract java.lang.Boolean	isHeader()	Whether the file has a header.
FileEntityProviderConfigBuilder	toEntityProviderConfigBuilder()

Methods inherited from class oracle.pgx.config.EntityProviderConfig

getDestinationVertexKeyType, getDestinationVertexProvider, getKeyType, getLabel, getLoading, getPropertyDefault, getPropertyDimension, getPropertyName, getPropertyType, getProps, getSourceVertexKeyType, getSourceVertexProvider, getValidatedLabel, hasKeys, isKeyMappingEnabled, isLabelLoadingEnabled, numProperties, supportsPropertyColumn, supportsPropertyColumn, supportsVectorProperties, supportsVectorProperties

Methods inherited from class oracle.pgx.config.AbstractConfig

getDefault, getValueFromEnvironment, getValueFromEnvironment, getValues, parseString, setSerializable

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.pgx.config.CommonLoadableConfig

createLocalDateFormat, createTimeFormat, createTimestampFormat, createTimestampWithTimezoneFormat, createTimeWithTimezoneFormat, getErrorHandling, getFormat, getKeystoreAlias, getLocalDateFormat, getTimeFormat, getTimestampFormat, getTimestampWithTimezoneFormat, getTimeWithTimezoneFormat, getVectorComponentDelimiter

Constructor Detail

AbstractFileEntityProviderConfig

public AbstractFileEntityProviderConfig()

Method Detail

getUris

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

Get the unified resource identifiers for the files with the table data

Returns:

the list of URIs

getStoringOptions

public FileGraphStoringConfig getStoringOptions()

Get the storing configuration

Returns:

the storing configuration

getAttributes

public abstract java.util.Map getAttributes()

Get the file-system specific additional attributes needed to read/write the table data

Returns:

the map of attributes

getSeparator

public abstract java.lang.String getSeparator()

Get the separator of this table configuration

Returns:

the separator

isDetectGzip

public abstract java.lang.Boolean isDetectGzip()

Whether GZip file automatic detection is enabled or not.

Returns:

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

isHeader

public abstract java.lang.Boolean isHeader()

Whether the file has a header. i.e. first line of file is meant for headers, e.g. 'EdgeId, SourceId, DestId, EdgeProp1, EdgeProp2'

Returns:

Whether the file has a header or not

getKeyColumn

public abstract java.lang.Object getKeyColumn()

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

getSourceColumn

public abstract java.lang.Object getSourceColumn()

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

getDestinationColumn

public abstract java.lang.Object getDestinationColumn()

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

toEntityProviderConfigBuilder

public FileEntityProviderConfigBuilder toEntityProviderConfigBuilder()

getName

public java.lang.String getName()

Description copied from class: EntityProviderConfig

Get the name of this provider configuration

Specified by:

getName in interface CommonLoadableConfig<ProviderFormat>

Specified by:

getName in class EntityProviderConfig

Returns:

the name of the provider

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class EntityProviderConfig

hashCode

public int hashCode()

Overrides:

hashCode in class EntityProviderConfig