Package com.exasol.adapter.document.edml

Class EdmlDefinition

java.lang.Object

com.exasol.adapter.document.edml.EdmlDefinition

public class EdmlDefinition
extends Object

Java representation of an EDML definition file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EdmlDefinition.EdmlDefinitionBuilder	A builder for EdmlDefinition.

Method Summary

Modifier and Type	Method	Description
static EdmlDefinition.EdmlDefinitionBuilder	builder()	Create a new builder for EdmlDefinition.
boolean	equals(Object obj)
String	getAdditionalConfiguration()	Get the optional additional configuration options.
String	getDescription()	Get the description.
String	getDestinationTable()	Get the name of the destination table in Exasol Virtual Schema.
MappingDefinition	getMapping()	Get the mapping for the document's properties.
String	getSource()	Get the source reference, i.e.
int	hashCode()
boolean	isAddSourceReferenceColumn()	Check if a source reference column should be added.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static EdmlDefinition.EdmlDefinitionBuilder builder()

Create a new builder for EdmlDefinition.

Returns:

a new builder for EdmlDefinition

getSource

public String getSource()

Get the source reference, i.e. the table name or resource identifier.

Returns:

the source reference

getDestinationTable

public String getDestinationTable()

Get the name of the destination table in Exasol Virtual Schema.

Returns:

destination table

getDescription

public String getDescription()

Get the description.

Returns:

description

isAddSourceReferenceColumn

public boolean isAddSourceReferenceColumn()

Check if a source reference column should be added. If set to true, this adapter adds the source reference as a column named SOURCE_REFERENCE to the Exasol table.

This feature is mainly useful if multiple sources are used (not supported by all dialects). In that case you can filter on the source name.

Returns:

true if a source reference should be added.

getMapping

public MappingDefinition getMapping()

Get the mapping for the document's properties. Typically you want to define fields here to define mappings for this document's properties. But you can also use toJsonMapping mapping here. In that case the whole document is mapped to a JSON string.

You can omit the mapping element to enable auto-inference.

Returns:

the mapping

getAdditionalConfiguration

public String getAdditionalConfiguration()

Get the optional additional configuration options.

Returns:

additional configuration

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object