oracle.pgx.config

Class AbstractTableConfigBuilder<T extends AbstractTableConfigBuilder<T,GTC>,GTC extends GraphTableConfig>

java.lang.Object

oracle.pgx.config.AbstractTableConfigBuilder<T,GTC>

Type Parameters:

T - which table configuration object this builder will produce

All Implemented Interfaces:

oracle.pgx.config.internal.ConvertibleToTableConfigBuilder

Direct Known Subclasses:

FileTableConfigBuilder

public abstract class AbstractTableConfigBuilder<T extends AbstractTableConfigBuilder<T,GTC>,GTC extends GraphTableConfig>
extends java.lang.Object
implements oracle.pgx.config.internal.ConvertibleToTableConfigBuilder

base class for table configuration builder classes

Constructor Summary

Constructors

Constructor and Description
AbstractTableConfigBuilder() default constructor

Method Summary

Modifier and Type	Method and Description
T	addAttribute(java.lang.String key, java.lang.String value) Adds a specific additional attribute to this config
T	addProperty(java.lang.String name, PropertyType type) Convenience method for addProperty(String, PropertyType, Object).
T	addProperty(java.lang.String name, PropertyType type, java.lang.Object defaultVal) Add a property to this builder
GTC	build() Build the table configuration object
T	clearProperties() Removes all properties from this builder
T	copyBaseFrom(GraphTableConfig tableConfig) Sets this builder with the values of the given table config, this only includes base settings (format, temporal formats, vertex properties, edge properties, loading configuration and error handling configuration).
T	copyFrom(GTC tableConfig) Sets this builder with all the values of the given table config.
T	createKeyMapping(boolean flag) Sets the flag to create the entity key mapping.
T	loadLabels(boolean flag) Sets the entity label loading.
T	removeProperty(java.lang.String name) Removes a property from this builder
T	setDateFormat(java.lang.String dateFormat) Sets the date format used for loading and storing the table.
T	setDestinationVertexTable(java.lang.String name) Sets the name of the destination vertex table
T	setErrorHandlingOnMissedPropKey(OnMismatch action) Sets the error handling on missed prop key.
T	setErrorHandlingOnMissingVertex(OnMissingVertex action) Sets the error handling on a missing vertex.
T	setErrorHandlingOnPropConversion(OnMismatch action) Sets the error handling on prop conversion.
T	setErrorHandlingOnTypeMismatch(OnMismatch action) Sets the error handling on type mismatch.
T	setIdType(IdType idType) Sets the type of vertex IDs
T	setLocalDateFormat(java.util.List<java.lang.String> localDateFormatList) Sets the list of local_date formats used for loading and storing the table.
T	setName(java.lang.String name) Sets the name of the table
T	setSourceVertexTable(java.lang.String name) Sets the name of the source vertex table
T	setStrictMode(boolean strictMode) Sets the strict mode.
T	setTableLabel(java.lang.String tableLabel) Sets the date format used for loading and storing the table.
T	setTimeFormat(java.util.List<java.lang.String> timeFormatList) Sets the list of time formats used for loading and storing the table.
T	setTimestampFormat(java.util.List<java.lang.String> timestampFormatList) Sets the list timestamp formats used for loading and storing the table.
T	setTimestampWithTimezoneFormat(java.util.List<java.lang.String> timestampWithTimezoneFormatList) Sets the list of timestamp with timezone formats used for loading and storing the table.
T	setTimeWithTimezoneFormat(java.util.List<java.lang.String> timeWithTimezoneFormatList) Sets the list of time with timezone formats used for loading and storing the table.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

toTableConfigBuilder

Constructor Detail

AbstractTableConfigBuilder

public AbstractTableConfigBuilder()

default constructor

Method Detail

addAttribute

public T addAttribute(java.lang.String key,
                      java.lang.String value)

Adds a specific additional attribute to this config

Parameters:

key - the attribute's key

value - the attribute's value

Returns:

this builder

addProperty

public T addProperty(java.lang.String name,
                     PropertyType type)

Convenience method for addProperty(String, PropertyType, Object).

Parameters:

name - the name of the property

type - the type of the property

Returns:

this builder

addProperty

public T addProperty(java.lang.String name,
                     PropertyType type,
                     java.lang.Object defaultVal)

Add a property to this builder

Parameters:

name - the name of the property

type - the type of the property

defaultVal - the default value of the property (can be null)

Returns:

this builder

build

public GTC build()

Build the table configuration object

Returns:

the table configuration object

clearProperties

public T clearProperties()

Removes all properties from this builder

Returns:

this builder

copyBaseFrom

public final T copyBaseFrom(GraphTableConfig tableConfig)

Sets this builder with the values of the given table config, this only includes base settings (format, temporal formats, vertex properties, edge properties, loading configuration and error handling configuration). If a format was already specified it will remain unchanged, however any other values copied from the given table config will overwrite the corresponding values of this builder.

Parameters:

tableConfig - the table configuration from which to copy the values

Returns:

this builder

copyFrom

public T copyFrom(GTC tableConfig)

Sets this builder with all the values of the given table config. If a format was already specified it will remain unchanged, however any other values copied from the given table config will overwrite the corresponding values of this builder.

Parameters:

tableConfig - the table configuration from which to copy the values

Returns:

this builder

createKeyMapping

public T createKeyMapping(boolean flag)

Sets the flag to create the entity key mapping. See the table configuration documentation for details about the effects and default of this flag

Parameters:

flag - if true, an entity key mapping is created

Returns:

this builder

loadLabels

public T loadLabels(boolean flag)

Sets the entity label loading. See the table configuration documentation for details about the effects and default of this flag.

Parameters:

flag - sets to load the edge label if true

Returns:

this builder

removeProperty

public T removeProperty(java.lang.String name)

Removes a property from this builder

Parameters:

name - the name of the property

Returns:

this builder

setDateFormat

public T setDateFormat(java.lang.String dateFormat)

Sets the date format used for loading and storing the table. See the table configuration documentation for details about the effects and default of this flag

Parameters:

dateFormat - the date format

Returns:

this builder

setDestinationVertexTable

public T setDestinationVertexTable(java.lang.String name)

Sets the name of the destination vertex table

Parameters:

name - the name of the destination vertex table

Returns:

this builder

See Also:

"the table configuration documentation for details about the effects and default of this setting"

setErrorHandlingOnMissedPropKey

public T setErrorHandlingOnMissedPropKey(OnMismatch action)

Sets the error handling on missed prop key. See the table configuration documentation for details about the effects and default of this flag

Parameters:

action - the action

Returns:

this builder

setErrorHandlingOnMissingVertex

public T setErrorHandlingOnMissingVertex(OnMissingVertex action)

Sets the error handling on a missing vertex. See the table configuration documentation for details about the effects and default of this flag

Parameters:

action - the action

Returns:

this builder

setErrorHandlingOnPropConversion

public T setErrorHandlingOnPropConversion(OnMismatch action)

Sets the error handling on prop conversion. See the table configuration documentation for details about the effects and default of this flag

Parameters:

action - the action

Returns:

this builder

setErrorHandlingOnTypeMismatch

public T setErrorHandlingOnTypeMismatch(OnMismatch action)

Sets the error handling on type mismatch. See the table configuration documentation for details about the effects and default of this flag

Parameters:

action - the action

Returns:

this builder

setIdType

public T setIdType(IdType idType)

Sets the type of vertex IDs

Parameters:

idType - the type of vertex IDs

Returns:

this builder

See Also:

"the table configuration documentation for details about the effects and default of this setting"

setLocalDateFormat

public T setLocalDateFormat(java.util.List<java.lang.String> localDateFormatList)

Sets the list of local_date formats used for loading and storing the table.

Parameters:

localDateFormatList - the list of date formats

Returns:

this builder

setName

public T setName(java.lang.String name)

Sets the name of the table

Parameters:

name - the name of the table

Returns:

this builder

See Also:

"the table configuration documentation for details about the effects and default of this setting"

setSourceVertexTable

public T setSourceVertexTable(java.lang.String name)

Sets the name of the source vertex table

Parameters:

name - the name of the source vertex table

Returns:

this builder

See Also:

"the table configuration documentation for details about the effects and default of this setting"

setStrictMode

public T setStrictMode(boolean strictMode)

Sets the strict mode. See the table configuration documentation for details about the effects and default of this flag

Parameters:

strictMode - if true, strict mode is enabled, otherwise strict mode is disabled

Returns:

this builder

setTableLabel

public T setTableLabel(java.lang.String tableLabel)

Sets the date format used for loading and storing the table. See the table configuration documentation for details about the effects and default of this flag

Parameters:

dateFormat - the date format

Returns:

this builder

setTimeFormat

public T setTimeFormat(java.util.List<java.lang.String> timeFormatList)

Sets the list of time formats used for loading and storing the table.

Parameters:

timeFormatList - the list of date formats

Returns:

this builder

setTimestampFormat

public T setTimestampFormat(java.util.List<java.lang.String> timestampFormatList)

Sets the list timestamp formats used for loading and storing the table.

Parameters:

timestampFormatList - the list of date formats

Returns:

this builder

setTimestampWithTimezoneFormat

public T setTimestampWithTimezoneFormat(java.util.List<java.lang.String> timestampWithTimezoneFormatList)

Sets the list of timestamp with timezone formats used for loading and storing the table.

Parameters:

timestampWithTimezoneFormatList - the list of date formats

Returns:

this builder

setTimeWithTimezoneFormat

public T setTimeWithTimezoneFormat(java.util.List<java.lang.String> timeWithTimezoneFormatList)

Sets the list of time with timezone formats used for loading and storing the table.

Parameters:

timeWithTimezoneFormatList - the list of date formats

Returns:

this builder