oracle.pgx.config

Class FileTableConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.GraphTableConfig

oracle.pgx.config.AbstractFileTableConfig

oracle.pgx.config.FileTableConfig

All Implemented Interfaces:

oracle.pgx.config.internal.ConvertibleToTableConfigBuilder

@Generated(value="config_generator.py")
public class FileTableConfig
extends AbstractFileTableConfig

PGX Engine File Table Config

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileTableConfig.Field Fields of PGX Engine File Table Config

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method and Description
default java.text.DateFormat	createDateFormat()
default java.util.List<java.time.format.DateTimeFormatter>	createLocalDateFormat()
default java.util.List<java.time.format.DateTimeFormatter>	createTimeFormat()
default java.util.List<java.time.format.DateTimeFormatter>	createTimestampFormat()
default java.util.List<java.time.format.DateTimeFormatter>	createTimestampWithTimezoneFormat()
default java.util.List<java.time.format.DateTimeFormatter>	createTimeWithTimezoneFormat()
java.util.Map	getAttributes() additional attributes needed to read/write the graph data
static FileTableConfig.Field[]	getConfigFields()
java.lang.String	getDateFormat() the date format to use when loading and storing date properties.
java.lang.String	getDestinationVertexTable() name of the destination vertex table to be used for this edge table
GraphErrorHandlingConfig	getErrorHandling() error handling configuration
Format	getFormat() graph format
IdType	getIdType() type of the ID
TableLoadingConfig	getLoading() loading-specific configuration
java.util.List<java.lang.String>	getLocalDateFormat() array of local_date formats to use when loading and storing local_date properties.
java.lang.String	getName() table name
java.lang.String	getPoint2d() longitude and latitude as floating point values separated by a space
java.util.List<GraphPropertyConfig>	getProps() specification of the properties associated with this table
java.lang.String	getSeparator() separator string for text files.
java.lang.String	getSourceVertexTable() name of the source vertex table to be used for this edge table
FileGraphStoringConfig	getStoring() storing-specific configuration
java.lang.String	getTableLabel() label to associate to all the entities of the table
java.util.List<java.lang.String>	getTimeFormat() the time format to use when loading and storing time properties.
java.util.List<java.lang.String>	getTimestampFormat() the timestamp format to use when loading and storing timestamp properties.
java.util.List<java.lang.String>	getTimestampWithTimezoneFormat() the timestamp with timezone format to use when loading and storing timestamp with timezone properties.
java.util.List<java.lang.String>	getTimeWithTimezoneFormat() the time with timezone format to use when loading and storing time with timezone properties.
java.util.List<java.lang.String>	getUris() list of unified resource identifiers
java.util.Map<FileTableConfig.Field,java.lang.Object>	getValues() Gets the parsed values.
java.util.Map<FileTableConfig.Field,java.lang.Object>	getValuesWithoutDefaults() Gets the values without defaults.
boolean	hasDefaultValue(FileTableConfig.Field field) Checks for default value.
java.lang.Boolean	isDetectGzip() enable/disable automatic gzip compression detection when loading graphs
boolean	isEmpty() Checks if it's empty.
java.lang.Boolean	isHeader() first line of file is meant for headers, e.g.
static FileTableConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) Parses an input stream.
static FileTableConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath) Parses a raw key/value mapping.
static FileTableConfig	parse(java.util.Properties props, boolean strict) Parses a properties file.
java.lang.String	toString()
java.lang.String	toString(boolean hideSensitiveData)

Methods inherited from class oracle.pgx.config.AbstractFileTableConfig

equals, hashCode, toTableConfigBuilder

Methods inherited from class oracle.pgx.config.GraphTableConfig

getDestinationVertexIdType, getPropertyDefault, getPropertyDimension, getPropertyName, getPropertyType, getSourceVertexIdType, isKeyMappingEnabled, isLabelLoadingEnabled, numProperties

Methods inherited from class oracle.pgx.config.AbstractConfig

getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getAttributes

public java.util.Map getAttributes()

additional attributes needed to read/write the graph data

Specified by:

getAttributes in class AbstractFileTableConfig

Returns:

the map of attributes

getConfigFields

public static FileTableConfig.Field[] getConfigFields()

getDateFormat

public java.lang.String getDateFormat()

the date format to use when loading and storing date properties. Please see SimpleDateFormat for a documentation of the format string

getDestinationVertexTable

public java.lang.String getDestinationVertexTable()

name of the destination vertex table to be used for this edge table

Specified by:

getDestinationVertexTable in class GraphTableConfig

Returns:

the name of the destination vertex table

getErrorHandling

public GraphErrorHandlingConfig getErrorHandling()

error handling configuration

getFormat

public Format getFormat()

graph format

getIdType

public IdType getIdType()

type of the ID

Specified by:

getIdType in class GraphTableConfig

Returns:

the ID type

getLoading

public TableLoadingConfig getLoading()

loading-specific configuration

Specified by:

getLoading in class GraphTableConfig

Returns:

the loading configuration

getLocalDateFormat

public java.util.List<java.lang.String> getLocalDateFormat()

array of local_date formats to use when loading and storing local_date properties. Please see DateTimeFormatter for a documentation of the format string

getName

public java.lang.String getName()

table name

Overrides:

getName in class AbstractFileTableConfig

getPoint2d

public java.lang.String getPoint2d()

longitude and latitude as floating point values separated by a space

getProps

public java.util.List<GraphPropertyConfig> getProps()

specification of the properties associated with this table

Specified by:

getProps in class GraphTableConfig

Returns:

the list of vertex properties

getSeparator

public java.lang.String getSeparator()

separator string for text files. First character will be used as separator when storing. The characters ", {, } and \n cannot be used as separators

Specified by:

getSeparator in class AbstractFileTableConfig

Returns:

the separator

getSourceVertexTable

public java.lang.String getSourceVertexTable()

name of the source vertex table to be used for this edge table

Specified by:

getSourceVertexTable in class GraphTableConfig

Returns:

the name of the source vertex table

getStoring

public FileGraphStoringConfig getStoring()

storing-specific configuration

Specified by:

getStoring in class AbstractFileTableConfig

Returns:

the storing configuration

getTableLabel

public java.lang.String getTableLabel()

label to associate to all the entities of the table

Specified by:

getTableLabel in class GraphTableConfig

Returns:

the label associated to all the entities of the table

getTimeFormat

public java.util.List<java.lang.String> getTimeFormat()

the time format to use when loading and storing time properties. Please see DateTimeFormatter for a documentation of the format string

getTimestampFormat

public java.util.List<java.lang.String> getTimestampFormat()

the timestamp format to use when loading and storing timestamp properties. Please see DateTimeFormatter for a documentation of the format string

getTimestampWithTimezoneFormat

public java.util.List<java.lang.String> getTimestampWithTimezoneFormat()

the timestamp with timezone format to use when loading and storing timestamp with timezone properties. Please see DateTimeFormatter for a documentation of the format string

getTimeWithTimezoneFormat

public java.util.List<java.lang.String> getTimeWithTimezoneFormat()

the time with timezone format to use when loading and storing time with timezone properties. Please see DateTimeFormatter for a documentation of the format string

getUris

public java.util.List<java.lang.String> getUris()

list of unified resource identifiers

Specified by:

getUris in class AbstractFileTableConfig

Returns:

the list of URIs

getValues

public java.util.Map<FileTableConfig.Field,java.lang.Object> getValues()

Gets the parsed values.

Returns:

the parsed values

getValuesWithoutDefaults

public java.util.Map<FileTableConfig.Field,java.lang.Object> getValuesWithoutDefaults()

Gets the values without defaults.

Returns:

the values without defaults

hasDefaultValue

public boolean hasDefaultValue(FileTableConfig.Field field)

Checks for default value.

Parameters:

field - the field

Returns:

true, if value for given field is the default value

isDetectGzip

public java.lang.Boolean isDetectGzip()

enable/disable automatic gzip compression detection when loading graphs

Specified by:

isDetectGzip in class AbstractFileTableConfig

Returns:

true if GZip file automatic detection is enabled, false otherwise.

isEmpty

public boolean isEmpty()

Checks if it's empty.

Returns:

true, if the Map 'values' is empty.

isHeader

public java.lang.Boolean isHeader()

first line of file is meant for headers, e.g. 'EdgeId, SourceId, DestId, EdgeProp1, EdgeProp2'

Specified by:

isHeader in class AbstractFileTableConfig

Returns:

Whether the file has a header or not

parse

public static FileTableConfig parse(java.io.InputStream is,
                                    boolean strict,
                                    java.lang.String parentPath)
                             throws java.io.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:

java.io.IOException - Signals that an I/O exception has occurred.

parse

public static FileTableConfig parse(java.util.Map<java.lang.String,java.lang.Object> raw,
                                    boolean strict,
                                    java.lang.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 FileTableConfig parse(java.util.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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(boolean hideSensitiveData)

createDateFormat

public java.text.DateFormat createDateFormat()

createLocalDateFormat

public java.util.List<java.time.format.DateTimeFormatter> createLocalDateFormat()

createTimeFormat

public java.util.List<java.time.format.DateTimeFormatter> createTimeFormat()

createTimestampFormat

public java.util.List<java.time.format.DateTimeFormatter> createTimestampFormat()

createTimestampWithTimezoneFormat

public java.util.List<java.time.format.DateTimeFormatter> createTimestampWithTimezoneFormat()

createTimeWithTimezoneFormat

public java.util.List<java.time.format.DateTimeFormatter> createTimeWithTimezoneFormat()