oracle.pgx.config

Class SingleFileGraphConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.GraphConfig

oracle.pgx.config.AbstractFileGraphConfig

oracle.pgx.config.AbstractSingleFileGraphConfig

oracle.pgx.config.SingleFileGraphConfig

@Generated(value="config_generator.py")
public class SingleFileGraphConfig
extends AbstractSingleFileGraphConfig

PGX Engine Single File Graph Config

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SingleFileGraphConfig.Field Fields of PGX Engine Single File Graph Config

Method Summary

Modifier and Type	Method and Description
java.util.Map	getAttributes() file-system specific additional attributes needed to read/write the graph data
java.lang.String	getDateFormat() the date format to use when loading and storing date properties.
java.util.List<GraphPropertyConfig>	getEdgeProps() specification of edge properties associated with graph
GraphErrorHandlingConfig	getErrorHandling() error handling configuration
Format	getFormat() graph format (Note: bin is deprecated, use pgb instead)
GraphLoadingConfig	getLoading() loading-specific configuration
java.lang.String	getSeparator() [file formats only] separator string for text files
java.lang.String	getUri() unified resource identifier, either pointing to a a local file (relative to the location of this config or absolute), a web resource (prefix http://' or https://), a HDFS path (prefix hdfs:) or a classpath (prefix classpath:/ or jar:)
java.util.Map<SingleFileGraphConfig.Field,java.lang.Object>	getValues() Gets the parsed values.
java.util.Map<SingleFileGraphConfig.Field,java.lang.Object>	getValuesWithoutDefaults() Gets the values without defaults.
IdType	getVertexIdType() type of the vertex ID
java.util.List<GraphPropertyConfig>	getVertexProps() specification of vertex properties associated with graph
boolean	hasDefaultValue(SingleFileGraphConfig.Field field) Checks for default value.
java.lang.Boolean	isEdgeLabel() whether the graph has the edge label or not
boolean	isEmpty() Checks if it's empty.
java.lang.Boolean	isHeader() first line of file is meant for headers, e.g.
java.lang.Boolean	isVertexLabels() whether the graph has the vertex label or not
static SingleFileGraphConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) Parses an input stream.
static SingleFileGraphConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath) Parses a raw key/value mapping.
static SingleFileGraphConfig	parse(java.util.Properties props, boolean strict) Parses a properties file.
java.lang.String	toString()

Methods inherited from class oracle.pgx.config.AbstractSingleFileGraphConfig

equals, getName, hashCode

Methods inherited from class oracle.pgx.config.GraphConfig

getEdgePropertyDefault, getEdgePropertyDimension, getEdgePropertyName, getEdgePropertyType, getNodeKeyType, getNodePropertyDefault, getNodePropertyDimension, getNodePropertyName, getNodePropertyType, isFileFormat, isFileFormat, isLoadEdgeKeys, isLoadVertexKeys, isMultipleFileFormat, isMultipleFileFormat, isSingleFileFormat, isSingleFileFormat, numEdgeProperties, numNodeProperties

Methods inherited from class oracle.pgx.config.AbstractConfig

setSerializable

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getAttributes

public java.util.Map getAttributes()

file-system specific additional attributes needed to read/write the graph data

Specified by:

getAttributes in class AbstractFileGraphConfig

Returns:

the map of attributes

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

Specified by:

getDateFormat in class GraphConfig

Returns:

the date format

getEdgeProps

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

specification of edge properties associated with graph

Specified by:

getEdgeProps in class GraphConfig

Returns:

the list of vertex properties

getErrorHandling

public GraphErrorHandlingConfig getErrorHandling()

error handling configuration

Specified by:

getErrorHandling in class GraphConfig

Returns:

the error handling configuration

getFormat

public Format getFormat()

graph format (Note: bin is deprecated, use pgb instead)

Specified by:

getFormat in class GraphConfig

Returns:

the format

getLoading

public GraphLoadingConfig getLoading()

loading-specific configuration

Specified by:

getLoading in class GraphConfig

Returns:

the loading configuration

getSeparator

public java.lang.String getSeparator()

[file formats only] separator string for text files

Specified by:

getSeparator in class AbstractFileGraphConfig

Returns:

the format

getUri

public java.lang.String getUri()

unified resource identifier, either pointing to a a local file (relative to the location of this config or absolute), a web resource (prefix http://' or https://), a HDFS path (prefix hdfs:) or a classpath (prefix classpath:/ or jar:)

getValues

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

Gets the parsed values.

Returns:

the parsed values

getValuesWithoutDefaults

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

Gets the values without defaults.

Returns:

the values without defaults

getVertexIdType

public IdType getVertexIdType()

type of the vertex ID

Specified by:

getVertexIdType in class GraphConfig

Returns:

the vertex ID type

getVertexProps

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

specification of vertex properties associated with graph

Specified by:

getVertexProps in class GraphConfig

Returns:

the list of vertex properties

hasDefaultValue

public boolean hasDefaultValue(SingleFileGraphConfig.Field field)

Checks for default value.

Parameters:

field - the field

Returns:

true, if value for given field is the default value

isEdgeLabel

public java.lang.Boolean isEdgeLabel()

whether the graph has the edge label or not

Specified by:

isEdgeLabel in class GraphConfig

Returns:

true if this graph configuration has the edge label.

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 AbstractFileGraphConfig

Returns:

Whether the file has a header or not

isVertexLabels

public java.lang.Boolean isVertexLabels()

whether the graph has the vertex label or not

Specified by:

isVertexLabels in class GraphConfig

Returns:

true if this graph configuration has the vertex label.

parse

public static SingleFileGraphConfig 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 SingleFileGraphConfig 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 SingleFileGraphConfig 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