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

  • Constructor Details

    • AbstractFileEntityProviderConfig

      public AbstractFileEntityProviderConfig()

  • Method Details

    • getUris

      public abstract List<String> getUris()
      Get the unified resource identifiers for the files with the table data
      Returns:
      the list of URIs

    • getStoringOptions

      public abstract FileGraphStoringConfig getStoringOptions()
      Get the storing configuration
      Returns:
      the storing configuration

    • getAttributes

      public abstract Map getAttributes()
      Get the file-system specific additional attributes needed to read/write the table data
      Returns:
      the map of attributes

    • getSeparator

      public abstract String getSeparator()
      Get the separator of this table configuration
      Returns:
      the separator

    • isDetectGzip

      public abstract 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 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 Object getKeyColumn()
      name or index (starting from 1) of column corresponding to keys (for CSV format only)
      See Also:

    • getSourceColumn

      public abstract Object getSourceColumn()
      name or index (starting from 1) of column corresponding to edge source (for CSV format only)
      See Also:

    • getSourceKeyColumns

      @BetaApi public abstract List<? extends ForeignKeyColumnDescriptor> getSourceKeyColumns()
      Get the source key declaration associated with this entity provider config. A source key is composed of one or more source key columns, each referring to one key column of the source vertex provider. Use getValidatedSourceKeyColumns() ()} instead of this function, as that function will also consider legacy configs.
      Returns:
      Source key columns declared in the config.
      Since:
      25.2.0

    • getValidatedSourceKeyColumns

      @BetaApi public List<? extends ForeignKeyColumnDescriptor> getValidatedSourceKeyColumns()
      Validate and get the source key declaration associated with this provider configuration. This function will use the source key returned by either getSourceKeyColumns() or legacy function.
      Returns:
      A list of validated foreign key column descriptors.
      Since:
      25.2.0

    • getDestinationColumn

      public abstract Object getDestinationColumn()
      name or index (starting from 1) of column corresponding to edge destination (for CSV format only)
      See Also:

    • getDestinationKeyColumns

      @BetaApi public abstract List<? extends ForeignKeyColumnDescriptor> getDestinationKeyColumns()
      Get the destination key declaration associated with this entity provider config. A destination key is composed of one or more destination key columns, each referring to one key column of the destination vertex provider. Use getValidatedDestinationKeyColumns() instead of this function, as that function will also consider legacy configs.
      Returns:
      Destination key columns declared in the config.
      Since:
      25.2.0

    • getValidatedDestinationKeyColumns

      @BetaApi public List<? extends ForeignKeyColumnDescriptor> getValidatedDestinationKeyColumns()
      Validate and get the source key declaration associated with this provider configuration. This function will use the source key returned by either getDestinationKeyColumns() or legacy function.
      Returns:
      A list of validated foreign key column descriptors.
      Since:
      25.2.0

    • toEntityProviderConfigBuilder

      public FileEntityProviderConfigBuilder toEntityProviderConfigBuilder()

    • getName

      public 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(Object o)
      Overrides:
      equals in class EntityProviderConfig

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class EntityProviderConfig