Enum Format

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Format>

    public enum Format
    extends java.lang.Enum<Format>
    Graph Data Format.
    See Also:
    "the documentation for detailed specifications of each format."
    • Enum Constant Detail

      • PGB

        public static final Format PGB
        PGX Binary File Format (formerly EBIN)
      • PG

        public static final Format PG
        Property Graph (PG) Database Format
      • CSV

        public static final Format CSV
        Comma-Separated Values (CSV) Format
    • Method Detail

      • values

        public static Format[] 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 (Format c : Format.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Format 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:
        the format
      • isTextFormat

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

        public boolean hasVerticesAndEdgesSeparatedFileFormat()
        Check if this format has vertices and edges separated in different files
        Returns:
        whether the given format has vertices and edges separated in different files
      • hasVerticesAndEdgesSeparatedFormat

        public boolean hasVerticesAndEdgesSeparatedFormat()
        Check if this format has vertices and edges separated
        Returns:
        whether the given format has vertices and edges separated
      • supportsLoadingVertexLabelFromProperty

        public boolean supportsLoadingVertexLabelFromProperty()
      • supportsSkippingEdges

        public boolean supportsSkippingEdges()
      • supportsSkippingVertices

        public boolean supportsSkippingVertices()
      • supportsPropertyConversion

        public boolean supportsPropertyConversion()
      • supportsVertexLabels

        public boolean supportsVertexLabels()
      • supportsEdgeLabel

        public boolean supportsEdgeLabel()
      • supportsPartitioningWhileLoading

        public boolean supportsPartitioningWhileLoading()
      • supportsVectorProperties

        public boolean supportsVectorProperties()
      • supportsPropertyColumn

        public boolean supportsPropertyColumn()
      • 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<Format>
      • parseFormat

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