IMongoDeepJobConfig.java

/*
 * 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.mongodb.config;

import com.mongodb.DBObject;
import com.mongodb.QueryBuilder;
import com.stratio.deep.commons.config.DeepJobConfig;

/**
 * Defines the public methods that each Stratio Deep MongoDB configuration object should implement.
 */
public interface IMongoDeepJobConfig<T, S extends DeepJobConfig> {
    /**
     * The MongoDB's collection name
     */
    S collection(String collection);

    String getCollection();

    /**
     * The MongoDB's database name
     */
    S database(String database);

    /**
     * The replica set identifier.
     */
    S replicaSet(String replicaSet);

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

    /**
     * Filter query
     *
     * @param query
     * @return this object.
     */
    S filterQuery(DBObject query);

    /**
     * Filter query
     *
     * @param query
     * @return this object.
     */
    S filterQuery(QueryBuilder query);

    /**
     * Fiels to be returned, you can also use inputFields() and ignoreIdField()
     *
     * @param fields
     * @return this object.
     */
    S fields(DBObject fields);

    /**
     * Sorting
     *
     * @param sort
     * @return this object.
     */
    S sort(String sort);

    /**
     * Sorting
     *
     * @param sort
     * @return this object.
     */
    S sort(DBObject sort);

    /**
     * This is {@code true} by default now, but if {@code false}, only one InputSplit (your whole collection) will be
     * assigned to Spark – severely reducing parallel mapping.
     *
     * @param createInputSplit
     * @return this object.
     */
    S createInputSplit(boolean createInputSplit);

    /**
     * If {@code true} in a sharded setup splits will be made to connect to individual backend {@code mongod}s.  This
     * can be unsafe. If {@code mongos} is moving chunks around you might see duplicate data, or miss some data
     * entirely. Defaults to {@code false}
     *
     * @param useShards
     * @return this object.
     */
    S useShards(boolean useShards);

    /**
     * If {@code true} have one split = one shard chunk.  If {SPLITS_USE_SHARDS} is not true splits will still
     * use chunks, but will connect through {@code mongos} instead of the individual backend {@code mongod}s (the safe
     * thing to do). If {SPLITS_USE_SHARDS} is {@code true} but this is {@code false} one split will be made for
     * each backend shard. THIS IS UNSAFE and may result in data being run multiple times <p> Defaults to {@code true }
     *
     * @param splitsUseChunks
     * @return this object.
     */
    S splitsUseChunks(boolean splitsUseChunks);

    /**
     * @param inputKey
     * @return this object.
     */
    S inputKey(String inputKey);

    /**
     * If use it, MongoDB will not return _id field.
     *
     * @return this object.
     */
    S ignoreIdField();

    String getDatabase();

}