oracle.pgx.config

Class PgHbaseGraphConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.GraphConfig

oracle.pgx.config.AbstractPgGraphConfig

oracle.pgx.config.PgHbaseGraphConfig

@Generated(value="config_generator.py")
public class PgHbaseGraphConfig
extends AbstractPgGraphConfig

PGX Engine PG Hbase Graph Config

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PgHbaseGraphConfig.Field Fields of PGX Engine PG Hbase Graph 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
boolean	equals(java.lang.Object obj)
java.util.Map	getAttributes() additional attributes needed to read/write the graph data
java.lang.Integer	getBlockCacheSize() block_cache_size
java.lang.String	getCompression() which HBase compression algorithm to use.
static PgHbaseGraphConfig.Field[]	getConfigFields()
java.lang.String	getDataBlockEncoding() which datablock encoding algorithm to use.
java.lang.String	getDateFormat() the date format to use when loading and storing date properties.
DbEngine	getDbEngine() underlying database engine
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)
java.lang.String	getHadoopSecAuth() Hadoop authentication string
java.lang.String	getHbaseSecAuth() HBase authentication string
java.lang.String	getHmKerberosPrincipal() HM Kerberos principal
java.lang.Integer	getInitialEdgeNumRegions() how many initial edge regions defined for the HBase tables
java.lang.Integer	getInitialVertexNumRegions() how many initial vertex regions defined for the HBase tables
java.lang.String	getKeytab() path to keytab file
GraphLoadingConfig	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.Integer	getMaxNumConnections() maximum number of database connections to use when reading the graph
java.lang.String	getName() prefix of the table name (for edge and vertex tables)
java.lang.String	getPoint2d() longitude and latitude as floating point values separated by a space
java.lang.String	getRsKerberosPrincipal() RS Kerberos principal
java.lang.Integer	getSplitsPerRegion() how many splits per region to use when scanning vertices/edges
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.lang.String	getUserPrincipal() User principal
java.util.Map<PgHbaseGraphConfig.Field,java.lang.Object>	getValues() Gets the parsed values.
java.util.Map<PgHbaseGraphConfig.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
java.lang.Integer	getZkClientPort() ZooKeeper client port
java.lang.String	getZkNodeParent() ZooKeeper node parent
java.lang.String	getZkQuorum() ZooKeeper Quorum value
java.lang.Integer	getZkSessionTimeout() ZooKeeper session timeout (in milliseconds)
boolean	hasDefaultValue(PgHbaseGraphConfig.Field field) Checks for default value.
java.lang.Boolean	hasEdgeLabel() Deprecated.
int	hashCode()
java.lang.Boolean	hasVertexLabels() Deprecated.
boolean	isEmpty() Checks if it's empty.
static PgHbaseGraphConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) Parses an input stream.
static PgHbaseGraphConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath) Parses a raw key/value mapping.
static PgHbaseGraphConfig	parse(java.util.Properties props, boolean strict) Parses a properties file.
java.lang.String	toString()
java.lang.String	toString(boolean hashSensitiveData)

Methods inherited from class oracle.pgx.config.AbstractPgGraphConfig

getOraclePropertyGraph, setOraclePropertyGraph

Methods inherited from class oracle.pgx.config.GraphConfig

createDateFormat, createLocalDateFormat, createTimeFormat, createTimestampFormat, createTimestampWithTimezoneFormat, createTimeWithTimezoneFormat, getEdgeIdType, getEdgePropertyDefault, getEdgePropertyDimension, getEdgePropertyName, getEdgePropertyType, getEdgePropertyTypes, getLoadingFilter, getNodeKeyType, getNodePropertyDefault, getNodePropertyDimension, getNodePropertyName, getNodePropertyType, getVertexPropertyTypes, hasVerticesAndEdgesSeparatedFileFormat, hasVerticesAndEdgesSeparatedFileFormat, isEdgeLabelLoadingEnabled, isFileFormat, isFileFormat, isLoadEdgeKeys, isLoadVertexKeys, isMultipleFileFormat, isMultipleFileFormat, isSingleFileFormat, isSingleFileFormat, isVertexLabelsLoadingEnabled, numEdgeProperties, numNodeProperties, skipEdgeLoading, skipVertexLoading, supportsEdgeLabel, supportsEdgeLabel, supportsVertexLabels, supportsVertexLabels

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 GraphConfig

Returns:

the map of attributes

getBlockCacheSize

public java.lang.Integer getBlockCacheSize()

block_cache_size

getCompression

public java.lang.String getCompression()

which HBase compression algorithm to use. Check HBase documentation for list of supported algorithms

getConfigFields

public static PgHbaseGraphConfig.Field[] getConfigFields()

getDataBlockEncoding

public java.lang.String getDataBlockEncoding()

which datablock encoding algorithm to use. Supported values are 'none', 'prefix', 'diff', 'fast_diff' and 'prefix_tree'. See the DataBlockEncoding class in the org.apache.hadoop.hbase.io.encoding package for details.

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

getDbEngine

public DbEngine getDbEngine()

underlying database engine

Specified by:

getDbEngine in class AbstractPgGraphConfig

Returns:

the database engine

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

getHadoopSecAuth

public java.lang.String getHadoopSecAuth()

Hadoop authentication string

getHbaseSecAuth

public java.lang.String getHbaseSecAuth()

HBase authentication string

getHmKerberosPrincipal

public java.lang.String getHmKerberosPrincipal()

HM Kerberos principal

getInitialEdgeNumRegions

public java.lang.Integer getInitialEdgeNumRegions()

how many initial edge regions defined for the HBase tables

getInitialVertexNumRegions

public java.lang.Integer getInitialVertexNumRegions()

how many initial vertex regions defined for the HBase tables

getKeytab

public java.lang.String getKeytab()

path to keytab file

getLoading

public GraphLoadingConfig getLoading()

loading-specific configuration

Specified by:

getLoading in class GraphConfig

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

Specified by:

getLocalDateFormat in class GraphConfig

Returns:

the date format

getMaxNumConnections

public java.lang.Integer getMaxNumConnections()

maximum number of database connections to use when reading the graph

Specified by:

getMaxNumConnections in class AbstractPgGraphConfig

Returns:

the maximum number of connections

getName

public java.lang.String getName()

prefix of the table name (for edge and vertex tables)

Specified by:

getName in class GraphConfig

Returns:

the graph name

getPoint2d

public java.lang.String getPoint2d()

longitude and latitude as floating point values separated by a space

getRsKerberosPrincipal

public java.lang.String getRsKerberosPrincipal()

RS Kerberos principal

getSplitsPerRegion

public java.lang.Integer getSplitsPerRegion()

how many splits per region to use when scanning vertices/edges

Returns:

the splits per region

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

Specified by:

getTimeFormat in class GraphConfig

Returns:

the time format

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

Specified by:

getTimestampFormat in class GraphConfig

Returns:

the timestamp format

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

Specified by:

getTimestampWithTimezoneFormat in class GraphConfig

Returns:

the timestamp with timezone format

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

Specified by:

getTimeWithTimezoneFormat in class GraphConfig

Returns:

the time with timezone format

getUserPrincipal

public java.lang.String getUserPrincipal()

User principal

getValues

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

Gets the parsed values.

Returns:

the parsed values

getValuesWithoutDefaults

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

Gets the values without defaults.

Returns:

the values without defaults

getVertexIdType

public IdType getVertexIdType()

type of the vertex ID

Overrides:

getVertexIdType in class AbstractPgGraphConfig

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

getZkClientPort

public java.lang.Integer getZkClientPort()

ZooKeeper client port

Returns:

the ZooKeeper client port

getZkNodeParent

public java.lang.String getZkNodeParent()

ZooKeeper node parent

Returns:

the ZooKeeper parent node

getZkQuorum

public java.lang.String getZkQuorum()

ZooKeeper Quorum value

Returns:

the ZooKeeper Quorum

getZkSessionTimeout

public java.lang.Integer getZkSessionTimeout()

ZooKeeper session timeout (in milliseconds)

Returns:

the ZooKeeper session timeout

hasDefaultValue

public boolean hasDefaultValue(PgHbaseGraphConfig.Field field)

Checks for default value.

Parameters:

field - the field

Returns:

true, if value for given field is the default value

hasEdgeLabel

@Deprecated
public java.lang.Boolean hasEdgeLabel()

Deprecated.

whether the graph has the edge label or not

Specified by:

hasEdgeLabel in class GraphConfig

Returns:

true if this graph configuration has the edge label, false otherwise

hasVertexLabels

@Deprecated
public java.lang.Boolean hasVertexLabels()

Deprecated.

whether the graph has the vertex label or not

Specified by:

hasVertexLabels in class GraphConfig

Returns:

true if this graph configuration has the vertex label, false otherwise

isEmpty

public boolean isEmpty()

Checks if it's empty.

Returns:

true, if the Map 'values' is empty.

parse

public static PgHbaseGraphConfig 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 PgHbaseGraphConfig 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 PgHbaseGraphConfig 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 hashSensitiveData)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractPgGraphConfig

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPgGraphConfig