oracle.pgx.config

Enum Format

java.lang.Object

java.lang.Enum<Format>

oracle.pgx.config.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."

Property Summary

Type	Property and Description
boolean	supportsLoadingVertexLabelFrom

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADJ_LIST Adjacency List File Format
EDGE_LIST Edge List file format
FLAT_FILE Flat File Format
GRAPHML GraphML File Format
MULTI_TABLES_DB Multiple database tables Format
PG Property Graph (PG) Database Format
PGB PGX Binary File Format (formally EBIN)
RDF Resource Description Framework (RDF) Database Format
TWO_TABLES Two-Tables format (vertices, edges)

Method Summary

All MethodsInstance MethodsConcrete Methods

Modifier and Type	Method and Description
boolean	hasVerticesAndEdgesSeparatedFileFormat() Check if this format has vertices and edges separated in different files
boolean	hasVerticesAndEdgesSeparatedFormat() Check if this format has vertices and edges separated
boolean	isFileFormat() Check if format is a file format.
static Format	parseFormat(java.lang.String input) Parses a format given as string
boolean	supportsEdgeLabel()
boolean	supportsLoadingVertexLabelFromProperty()
boolean	supportsPropertyConversion()
boolean	supportsSkippingEdges()
boolean	supportsSkippingVertices()
boolean	supportsVertexLabels()
java.lang.String	toKey()
java.lang.String	toString()
static Format	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Format[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADJ_LIST

public static final Format ADJ_LIST

Adjacency List File Format

EDGE_LIST

public static final Format EDGE_LIST

Edge List file format

FLAT_FILE

public static final Format FLAT_FILE

Flat File Format

GRAPHML

public static final Format GRAPHML

GraphML File Format

MULTI_TABLES_DB

public static final Format MULTI_TABLES_DB

Multiple database tables Format

PG

public static final Format PG

Property Graph (PG) Database Format

PGB

public static final Format PGB

PGX Binary File Format (formally EBIN)

RDF

public static final Format RDF

Resource Description Framework (RDF) Database Format

TWO_TABLES

public static final Format TWO_TABLES

Two-Tables format (vertices, edges)

Property Detail

supportsLoadingVertexLabelFrom

public boolean supportsLoadingVertexLabelFromProperty

Method Detail

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

isFileFormat

public boolean isFileFormat()

Check if format is a file format.

Returns:

the format

parseFormat

public static Format parseFormat(java.lang.String input)

Parses a format given as string

Parameters:

input - the input string

Returns:

the format

supportsEdgeLabel

public boolean supportsEdgeLabel()

supportsLoadingVertexLabelFromProperty

public boolean supportsLoadingVertexLabelFromProperty()

supportsPropertyConversion

public boolean supportsPropertyConversion()

supportsSkippingEdges

public boolean supportsSkippingEdges()

supportsSkippingVertices

public boolean supportsSkippingVertices()

supportsVertexLabels

public boolean supportsVertexLabels()

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>

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

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