com.stratio.deep.config.IMongoDeepJobConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of deep-commons Show documentation
stratio deep common utility classes
There is a newer version: 0.8.0
/*
 * Copyright 2014, Stratio.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.stratio.deep.config;

import org.apache.hadoop.conf.Configuration;

import java.io.Serializable;
import java.util.List;

/**
 * Created by luca on 23/06/14.
 */
public interface IMongoDeepJobConfig extends IDeepJobConfig {
    /**
     * {@inheritDoc}
     */
    @Override
    public abstract IMongoDeepJobConfig password(String password);

    /**
     * {@inheritDoc}
     */
    @Override
    public abstract IMongoDeepJobConfig username(String username);

    /**
     * {@inheritDoc}
     */
    @Override
    public abstract IMongoDeepJobConfig inputColumns(String... columns);

    /**
     * {@inheritDoc}
     */
    @Override
    public abstract IMongoDeepJobConfig host(String hostname);

    /**
     * {@inheritDoc}
     */
    @Override
    public abstract IMongoDeepJobConfig filterByField(String filterColumnName, Serializable filterValue);

    /**
     * {@inheritDoc}
     */
    @Override
    public abstract IMongoDeepJobConfig pageSize(int pageSize);

    /**
     * Creates necessary config to access mongoDB
     *
     * @return
     */
    @Override
    public abstract IMongoDeepJobConfig initialize();

    /**
     * {@inheritDoc}
     */
    public abstract IMongoDeepJobConfig collection(String collection);

    /**
     * {@inheritDoc}
     */
    public abstract IMongoDeepJobConfig database(String database);

    /**
     * {@inheritDoc}
     */
    public abstract IMongoDeepJobConfig host(List host);

    /**
     * {@inheritDoc}
     */
    public abstract IMongoDeepJobConfig replicaSet(String replicaSet);

    /**
     * @return the hadoop configuration object if the concrete implementation has one, null otherwise.
     */
    public abstract Configuration getHadoopConfiguration();

    /**
     * Configures the 'readPreference' MongoDB's config property.
     *
     * @param readPreference the property value to set.
     * @return this object.
     */
    public IMongoDeepJobConfig readPreference(String readPreference);
}