Package oracle.pgx.config

Enum ProviderFormat

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ProviderFormat>
    public enum ProviderFormat
extends java.lang.Enum<ProviderFormat>
    Data Format for an entity provider.
    See Also:
    "the documentation for detailed specifications of each format."

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CSV
      Comma-Separated Values (CSV) Format
      ES
      Elasticsearch database Format
      PGB
      PGX Binary File Format
      RDBMS
      Relational database Format

    • Enum Constant Detail

      • RDBMS

        public static final ProviderFormat RDBMS
        Relational database Format

      • CSV

        public static final ProviderFormat CSV
        Comma-Separated Values (CSV) Format

      • ES

        public static final ProviderFormat ES
        Elasticsearch database Format

    • Method Detail

      • values

        public static ProviderFormat[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ProviderFormat c : ProviderFormat.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ProviderFormat valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • isFileFormat

        public boolean isFileFormat()
        Check if format is a file format.
        Returns:
        true if the format is loading the data from files

      • isTextFormat

        public boolean isTextFormat()
        Check if format is a text format.
        Returns:
        whether the format is a text format

      • supportsVectorProperties

        public boolean supportsVectorProperties()
        Check if format support having vector properties or not
        Returns:
        true if the format supports vector properties, false otherwise

      • supportsPropertyColumn

        public boolean supportsPropertyColumn()
        Check if format support having a column indication for properties
        Returns:
        true if the format supports property columns, false otherwise

      • supportsPropertyConversion

        public boolean supportsPropertyConversion()

      • toKey

        public java.lang.String toKey()
        Returns:
        JSON key representation of this format

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<ProviderFormat>

      • parseFormat

        public static ProviderFormat parseFormat​(java.lang.String input)
        Parses a provider format given as string
        Parameters:
        input - the input string
        Returns:
        the format