com.exasol.adapter.document.mapping.SourceReferenceColumnMapping Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of virtual-schema-common-document Show documentation
Common module of Exasol Virtual Schema Adapters for Document Data Sources.
The newest version!
package com.exasol.adapter.document.mapping;

import com.exasol.adapter.metadata.DataType;

/**
 * This class describes a column that maps the source reference. For example in the files-virtual-schemas the name of
 * the file that contained the document.
 * 
 * The name of this column is always {@code SOURCE_REFERENCE}, except from if it is used as foreign key (not yet
 * possible).
 * 
 */
public final class SourceReferenceColumnMapping extends AbstractColumnMapping {
    /** Constant for the default name of the SOURCE_REFERENCE column */
    public static final String DEFAULT_COLUMN_NAME = "SOURCE_REFERENCE";
    private static final long serialVersionUID = 5781456051409189118L;

    /**
     * Create an instance of {@link SourceReferenceColumnMapping}.
     */
    public SourceReferenceColumnMapping() {
        this(builder().exasolColumnName(DEFAULT_COLUMN_NAME));
    }

    @Override
    public DataType getExasolDataType() {
        return DataType.createVarChar(2000, DataType.ExaCharset.UTF8);
    }

    @Override
    public boolean isExasolColumnNullable() {
        return false;
    }

    @Override
    public ColumnMapping withNewExasolName(final String newExasolName) {
        return this.toBuilder().exasolColumnName(newExasolName).build();
    }

    @Override
    public void accept(final ColumnMappingVisitor visitor) {
        visitor.visit(this);
    }

    /**
     * Builder class for {@link SourceReferenceColumnMapping}.
     */
    public abstract static class SourceReferenceColumnMappingBuilder>
            extends AbstractColumnMapping.Builder {

        @Override
        protected abstract B self();

        @Override
        public abstract C build();

        @Override
        public String toString() {
            return "SourceReferenceColumnMapping.SourceReferenceColumnMappingBuilder(super=" + super.toString() + ")";
        }
    }

    private static final class SourceReferenceColumnMappingBuilderImpl extends
            SourceReferenceColumnMapping.SourceReferenceColumnMappingBuilder {

        private SourceReferenceColumnMappingBuilderImpl() {
        }

        @Override
        protected SourceReferenceColumnMapping.SourceReferenceColumnMappingBuilderImpl self() {
            return this;
        }

        /**
         * Build a new instance.
         * 
         * @return new instance
         */
        @Override
        public SourceReferenceColumnMapping build() {
            return new SourceReferenceColumnMapping(this);
        }
    }

    private SourceReferenceColumnMapping(
            final SourceReferenceColumnMapping.SourceReferenceColumnMappingBuilder builder) {
        super(builder);
    }

    /**
     * Create a new builder for {@link SourceReferenceColumnMapping}.
     * 
     * @return a new builder
     */
    @SuppressWarnings("java:S1452") // Generic wildcard type is ok here
    public static SourceReferenceColumnMapping.SourceReferenceColumnMappingBuilder builder() {
        return new SourceReferenceColumnMapping.SourceReferenceColumnMappingBuilderImpl();
    }

    private SourceReferenceColumnMapping.SourceReferenceColumnMappingBuilder toBuilder() {
        return new SourceReferenceColumnMapping.SourceReferenceColumnMappingBuilderImpl().fillValuesFrom(this);
    }

    @Override
    public String toString() {
        return "SourceReferenceColumnMapping(super=" + super.toString() + ")";
    }

    @Override
    public boolean equals(final java.lang.Object o) {
        if (o == this) {
            return true;
        }
        if (!(o instanceof SourceReferenceColumnMapping)) {
            return false;
        }
        if (!(this instanceof SourceReferenceColumnMapping)) {
            return false;
        }
        return super.equals(o);
    }

    @Override
    public int hashCode() {
        return super.hashCode();
    }
}