Package oracle.pgx.config

Class FileGraphStoringConfig

java.lang.Object
oracle.pgx.config.AbstractConfig
oracle.pgx.config.AbstractFileGraphStoringConfig
oracle.pgx.config.FileGraphStoringConfig
@Generated("config_generator.py") public class FileGraphStoringConfig extends AbstractFileGraphStoringConfig
PGX Engine File Graph Storing Config

  • Method Details

    • parse

      public static FileGraphStoringConfig parse(InputStream is, boolean strict, String parentPath) throws IOException
      Parses an input stream.
      Parameters:
      is - the input stream
      strict - if true, parses in strict mode
      parentPath - if not null, resolves relative paths against this parentPath
      Returns:
      the parsed graph config
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • parse

      public static FileGraphStoringConfig parse(Map<String,Object> raw, boolean strict, String parentPath)
      Parses a raw key/value mapping.
      Parameters:
      raw - the raw key/value mapping to parse
      strict - if true, parses in strict mode
      parentPath - if not null, resolves relative paths against this parentPath
      Returns:
      the parsed graph config

    • parse

      public static FileGraphStoringConfig parse(Properties props, boolean strict)
      Parses a properties file.
      Parameters:
      props - the properties to parse
      strict - if true, parses in strict mode
      Returns:
      the parsed graph config

    • getConfigFields

      public static FileGraphStoringConfig.Field[] getConfigFields()

    • getValues

      public Map<FileGraphStoringConfig.Field,Object> getValues()
      Gets the parsed values.
      Specified by:
      getValues in class AbstractConfig
      Returns:
      the parsed values

    • isEmpty

      public boolean isEmpty()
      Checks if it's empty.
      Returns:
      true, if the Map 'values' is empty.

    • hasDefaultValue

      public boolean hasDefaultValue(FileGraphStoringConfig.Field field)
      Checks for default value.
      Parameters:
      field - the field
      Returns:
      true, if value for given field is the default value

    • getValuesWithoutDefaults

      public Map<FileGraphStoringConfig.Field,Object> getValuesWithoutDefaults()
      Gets the values without defaults.
      Returns:
      the values without defaults

    • getLeftoverValues

      public Map<String,Object> getLeftoverValues()
      Gets the values that do not belong to any field.
      Returns:
      the values that do not belong to any field

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toString

      public String toString(boolean hideSensitiveData)

    • getBasePath

      public String getBasePath()
      base path to use for storing a graph; file paths will be constructed using the following format _._, i.e. parent_path/my_graph_1.edges
      Specified by:
      getBasePath in class AbstractFileGraphStoringConfig
      Returns:
      the base path

    • getNumPartitions

      public Integer getNumPartitions()
      the number of partitions that should be created, when exporting to multiple files
      Specified by:
      getNumPartitions in class AbstractFileGraphStoringConfig
      Returns:
      the number of partitions

    • getDelimiter

      public Character getDelimiter()
      delimiter character used as separator when storing. The characters ", {, } and \n cannot be used as delimiters
      Specified by:
      getDelimiter in class AbstractFileGraphStoringConfig
      Returns:
      the delimiter

    • getInitialPartitionIndex

      public Integer getInitialPartitionIndex()
      the value used as initial partition index, i.e. initial_partition_index=1024 -> my_graph_1024.edges, my_graph_1025.edges
      Specified by:
      getInitialPartitionIndex in class AbstractFileGraphStoringConfig
      Returns:
      the inital partition index

    • getVertexExtension

      public String getVertexExtension()
      the extension to use when creating vertex file partitions
      Specified by:
      getVertexExtension in class AbstractFileGraphStoringConfig
      Returns:
      the extension

    • getEdgeExtension

      public String getEdgeExtension()
      the extension to use when creating edge file partitions
      Specified by:
      getEdgeExtension in class AbstractFileGraphStoringConfig
      Returns:
      the extension

    • getRowExtension

      public String getRowExtension()
      the extension to use when creating row file partitions
      Specified by:
      getRowExtension in class AbstractFileGraphStoringConfig
      Returns:
      the extension

    • getCompressionScheme

      public oracle.pgx.vfs.CompressionScheme getCompressionScheme()
      the scheme to use for compression, or none to disable compression
      Specified by:
      getCompressionScheme in class AbstractFileGraphStoringConfig
      Returns:
      the compression scheme

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class AbstractFileGraphStoringConfig