Package oracle.pgx.config

Class EntityProviderConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.EntityProviderConfig

All Implemented Interfaces:

CommonLoadableConfig<ProviderFormat>, oracle.pgx.config.internal.ConvertibleToEntityProviderConfigBuilder

Direct Known Subclasses:

AbstractEsEntityProviderConfig, AbstractFileEntityProviderConfig, AbstractRdbmsEntityProviderConfig

public abstract class EntityProviderConfig
extends AbstractConfig
implements CommonLoadableConfig<ProviderFormat>, oracle.pgx.config.internal.ConvertibleToEntityProviderConfigBuilder

abstract super-class for all entity provider configs

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor	Description
EntityProviderConfig()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
IdType	getDestinationVertexKeyType()	Get the key type corresponding to the destination vertex provider of this edge provider configuration
abstract java.lang.String	getDestinationVertexProvider()	Get the name of the destination vertex provider
abstract IdType	getKeyType()	Get the key type of this provider configuration
abstract java.lang.String	getLabel()	Get the custom label configured for the entities from this provider.
abstract ProviderLoadingConfig	getLoading()	Get the loading configuration of this provider configuration
abstract java.lang.String	getName()	Get the name of this provider configuration
java.lang.Object	getPropertyDefault(int i)	Get the default value of a property by index
int	getPropertyDimension(int i)	Get the dimension of a property by index
java.lang.String	getPropertyName(int i)	Get the name of a property by index
PropertyType	getPropertyType(int i)	Get the type of a property by index
abstract java.util.List<GraphPropertyConfig>	getProps()	Get the properties of this provider configuration
IdType	getSourceVertexKeyType()	Get the key type corresponding to the source vertex provider of this edge provider configuration
abstract java.lang.String	getSourceVertexProvider()	Get the name of the source vertex provider
java.lang.String	getValidatedLabel()	Get the label configured for the entities from this provider.
int	hashCode()
abstract java.lang.Boolean	hasKeys()	indicates if the provider data has keys
boolean	isKeyMappingEnabled()	Check if key mapping is enabled
boolean	isLabelLoadingEnabled()	Checks if label loading is enabled
int	numProperties()	Get the number of properties in this provider configuration
boolean	supportsPropertyColumn()	Check if this provider configuration's format supports having a column indication for properties
static boolean	supportsPropertyColumn(ProviderFormat format)	Check if a format support having a column indication for properties
boolean	supportsVectorProperties()	Check if this graph configuration's format supports having vector properties or not
static boolean	supportsVectorProperties(ProviderFormat format)	Check if a format support having vector properties or not

Methods inherited from class oracle.pgx.config.AbstractConfig

getDefault, getValueFromEnvironment, getValueFromEnvironment, getValues, parseString, setSerializable

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.pgx.config.CommonLoadableConfig

createLocalDateFormat, createTimeFormat, createTimestampFormat, createTimestampWithTimezoneFormat, createTimeWithTimezoneFormat, getAttributes, getErrorHandling, getFormat, getKeystoreAlias, getLocalDateFormat, getTimeFormat, getTimestampFormat, getTimestampWithTimezoneFormat, getTimeWithTimezoneFormat, getVectorComponentDelimiter

Methods inherited from interface oracle.pgx.config.internal.ConvertibleToEntityProviderConfigBuilder

toEntityProviderConfigBuilder

Constructor Detail

EntityProviderConfig

public EntityProviderConfig()

Method Detail

supportsVectorProperties

public static boolean supportsVectorProperties(ProviderFormat format)

Check if a format support having vector properties or not

Parameters:

format - the format to check

Returns:

true if given format supports vector properties, false otherwise

supportsPropertyColumn

public static boolean supportsPropertyColumn(ProviderFormat format)

Check if a format support having a column indication for properties

Parameters:

format - the format to check

Returns:

true if given format supports property columns, false otherwise

getLabel

public abstract java.lang.String getLabel()

Get the custom label configured for the entities from this provider. If no custom label is specified, the label for the entities from this provider defaults to the provider name.

Returns:

the custom label

getValidatedLabel

public java.lang.String getValidatedLabel()

Get the label configured for the entities from this provider. If no custom label is specified, the label for the entities from this provider defaults to the provider name.

Returns:

the label

getProps

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

Get the properties of this provider configuration

Returns:

the list of vertex properties

getName

public abstract java.lang.String getName()

Get the name of this provider configuration

Specified by:

getName in interface CommonLoadableConfig<ProviderFormat>

Returns:

the name of the provider

getKeyType

public abstract IdType getKeyType()

Get the key type of this provider configuration

Returns:

the key type

hasKeys

public abstract java.lang.Boolean hasKeys()

indicates if the provider data has keys

getLoading

public abstract ProviderLoadingConfig getLoading()

Get the loading configuration of this provider configuration

Returns:

the loading configuration

getSourceVertexKeyType

public IdType getSourceVertexKeyType()

Get the key type corresponding to the source vertex provider of this edge provider configuration

Returns:

the key type

getDestinationVertexKeyType

public IdType getDestinationVertexKeyType()

Get the key type corresponding to the destination vertex provider of this edge provider configuration

Returns:

the key type

getSourceVertexProvider

public abstract java.lang.String getSourceVertexProvider()

Get the name of the source vertex provider

Returns:

the name of the source vertex provider

getDestinationVertexProvider

public abstract java.lang.String getDestinationVertexProvider()

Get the name of the destination vertex provider

Returns:

the name of the destination vertex provider

numProperties

public int numProperties()

Get the number of properties in this provider configuration

Returns:

the number of properties

getPropertyName

public java.lang.String getPropertyName(int i)

Get the name of a property by index

Parameters:

i - the 0-based index of the property

Returns:

the name of the property

getPropertyType

public PropertyType getPropertyType(int i)

Get the type of a property by index

Parameters:

i - the 0-based index of the property

Returns:

the type of the property

getPropertyDimension

public int getPropertyDimension(int i)

Get the dimension of a property by index

Parameters:

i - the 0-based index of the property

Returns:

the dimension of the property

getPropertyDefault

public java.lang.Object getPropertyDefault(int i)

Get the default value of a property by index

Parameters:

i - the 0-based index of the property

Returns:

the default value of the property

isKeyMappingEnabled

public boolean isKeyMappingEnabled()

Check if key mapping is enabled

Returns:

whether the key mapping is enabled or not

isLabelLoadingEnabled

public boolean isLabelLoadingEnabled()

Checks if label loading is enabled

Returns:

whether loading labels is enabled or not

supportsVectorProperties

public boolean supportsVectorProperties()

Check if this graph configuration's format supports having vector properties or not

Returns:

true if this graph configuration's format supports vector proeprties, false otherwise

supportsPropertyColumn

public boolean supportsPropertyColumn()

Check if this provider configuration's format supports having a column indication for properties

Returns:

true if this provider configuration's format supports property columns, false otherwise

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object