com.exasol.adapter.document.documentfetcher.files.FileFinderFactory 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-files Show documentation

Adapter for document data access from files.

There is a newer version: 8.1.3

Show newest version

package com.exasol.adapter.document.documentfetcher.files;

import java.io.Serializable;

import com.exasol.adapter.document.connection.ConnectionPropertiesReader;
import com.exasol.adapter.document.documentfetcher.DocumentFetcher;
import com.exasol.adapter.document.files.stringfilter.StringFilter;

/**
 * Factory interface for {@link RemoteFileFinder}.
 * 
 * 
 * Classes implementing this interface must be serializable since they are shipped along with the
 * {@link DocumentFetcher} to the UDF.
 * 
 */
public interface FileFinderFactory extends Serializable {

    /**
     * Get a {@link RemoteFileFinder}.
     *
     * @param filePattern              files to load
     * @param connectionPropertyReader reader for connection properties like remote database credentials
     * @return {@link RemoteFileFinder}
     */
    public RemoteFileFinder getFinder(StringFilter filePattern,
            final ConnectionPropertiesReader connectionPropertyReader);

    /**
     * Get the URL of the file type specific to user guide.
     *
     * @return user guide URL
     */
    public String getUserGuideUrl();
}