Package oracle.pgx.config

Class GraphPropertyConfig

java.lang.Object
oracle.pgx.config.AbstractConfig
oracle.pgx.config.AbstractGraphPropertyConfig
oracle.pgx.config.GraphPropertyConfig
All Implemented Interfaces:
Serializable
@Generated("config_generator.py") public class GraphPropertyConfig extends AbstractGraphPropertyConfig
PGX Engine Graph Property Config
See Also:

  • Method Details

    • parse

      public static GraphPropertyConfig 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 GraphPropertyConfig 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 GraphPropertyConfig 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 GraphPropertyConfig.Field[] getConfigFields()

    • getValues

      public Map<GraphPropertyConfig.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(GraphPropertyConfig.Field field)
      Checks for default value.
      Parameters:
      field - the field
      Returns:
      true, if value for given field is the default value

    • getValuesWithoutDefaults

      public Map<GraphPropertyConfig.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)

    • getName

      public String getName()
      name of property
      Specified by:
      getName in class AbstractGraphPropertyConfig

    • getDimension

      public Integer getDimension()
      dimension of property

    • getFormat

      public List<String> getFormat()
      array of formats of property
      Specified by:
      getFormat in class AbstractGraphPropertyConfig

    • getType

      public PropertyType getType()
      type of property (Note: date is deprecated, use one of local_date / time / timestamp / time_with_timezone / timestamp_with_timezone instead). vertex/edge are place-holders for the type specified in vertex_id_type/edge_id_type fields.
      Specified by:
      getType in class AbstractGraphPropertyConfig

    • getDefault

      public Object getDefault()
      default value to be assigned to this property if datasource does not provide it. In case of date type: string is expected to be formatted with yyyy-MM-dd HH:mm:ss. If no default is present (null), non-existent properties will contain default Java types (primitives) or empty string (string) or 01.01.1970 00:00 (date).

    • getColumn

      public Object getColumn()
      name or index (starting from 1) of the column holding the property data. If it is not specified, the loader will try to use the property name as column name (for CSV format only)
      Specified by:
      getColumn in class AbstractGraphPropertyConfig

    • getMaxDistinctStringsPerPool

      public Integer getMaxDistinctStringsPerPool()
      [only relevant if string_pooling_strategy is indexed] amount of distinct strings per property after which to stop pooling. If the limit is reached an exception is thrown. If set to null, the default value from the global PGX configuration will be used.

    • getStringPoolingStrategy

      public StringPoolingStrategy getStringPoolingStrategy()
      which string pooling strategy to use. If set to null, the default value from the global PGX configuration will be used.

    • getAggregate

      public Aggregate getAggregate()
      [currently unsupported] which aggregation function to use, aggregation always happens by vertex key

    • getField

      public Object getField()
      name of the JSON field holding the property data. Nesting is denoted by dot - separation. Field names containing dots are possible, in this case the dots need to be escaped using backslashes to resolve ambiguities. Only the exactly specified object are loaded, if they are non existent, the default value is used

    • getGroupKey

      public String getGroupKey()
      [currently unsupported] can only be used if the property / key is part of the grouping expression

    • isDropAfterLoading

      public Boolean isDropAfterLoading()
      [currently unsupported] indicating helper properties only used for aggregation, which are dropped after loading

    • equals

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