com.mongodb.internal.bulk.IndexRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-core Show documentation
The Java operations layer for the MongoDB Java Driver. Third parties can wrap this layer to provide custom higher-level APIs
There is a newer version: 5.3.0-beta0
Show newest version
/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * 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.mongodb.internal.bulk;

import com.mongodb.client.model.Collation;
import com.mongodb.lang.Nullable;
import org.bson.BsonDocument;

import java.util.List;
import java.util.concurrent.TimeUnit;

import static com.mongodb.assertions.Assertions.isTrueArgument;
import static com.mongodb.assertions.Assertions.notNull;
import static java.util.Arrays.asList;

/**
 * The settings to apply to the creation of an index.
 *
 * This class is not part of the public API and may be removed or changed at any time
 */
public class IndexRequest {
    private final BsonDocument keys;
    private static final List VALID_TEXT_INDEX_VERSIONS = asList(1, 2, 3);
    private static final List VALID_SPHERE_INDEX_VERSIONS = asList(1, 2, 3);
    private boolean background;
    private boolean unique;
    private String name;
    private boolean sparse;
    private Long expireAfterSeconds;
    private Integer version;
    private BsonDocument weights;
    private String defaultLanguage;
    private String languageOverride;
    private Integer textVersion;
    private Integer sphereVersion;
    private Integer bits;
    private Double min;
    private Double max;
    private Double bucketSize;
    private boolean dropDups;
    private BsonDocument storageEngine;
    private BsonDocument partialFilterExpression;
    private Collation collation;
    private BsonDocument wildcardProjection;
    private boolean hidden;

    public IndexRequest(final BsonDocument keys) {
        this.keys = notNull("keys", keys);
    }

    public BsonDocument getKeys() {
        return keys;
    }

    public boolean isBackground() {
        return background;
    }

    public IndexRequest background(final boolean background) {
        this.background = background;
        return this;
    }

    public boolean isUnique() {
        return unique;
    }

    public IndexRequest unique(final boolean unique) {
        this.unique = unique;
        return this;
    }

    @Nullable
    public String getName() {
        return name;
    }

    public IndexRequest name(@Nullable final String name) {
        this.name = name;
        return this;
    }

    public boolean isSparse() {
        return sparse;
    }

    public IndexRequest sparse(final boolean sparse) {
        this.sparse = sparse;
        return this;
    }

    @Nullable
    public Long getExpireAfter(final TimeUnit timeUnit) {
        if (expireAfterSeconds == null) {
            return null;
        }
        return timeUnit.convert(expireAfterSeconds, TimeUnit.SECONDS);
    }

    public IndexRequest expireAfter(@Nullable final Long expireAfter, final TimeUnit timeUnit) {
        if (expireAfter == null) {
            this.expireAfterSeconds = null;
        } else {
            this.expireAfterSeconds = TimeUnit.SECONDS.convert(expireAfter, timeUnit);
        }
        return this;
    }

    @Nullable
    public Integer getVersion() {
        return this.version;
    }

    public IndexRequest version(@Nullable final Integer version) {
        this.version = version;
        return this;
    }

    @Nullable
    public BsonDocument getWeights() {
        return weights;
    }

    public IndexRequest weights(@Nullable final BsonDocument weights) {
        this.weights = weights;
        return this;
    }

    @Nullable
    public String getDefaultLanguage() {
        return defaultLanguage;
    }

    public IndexRequest defaultLanguage(@Nullable final String defaultLanguage) {
        this.defaultLanguage = defaultLanguage;
        return this;
    }

    @Nullable
    public String getLanguageOverride() {
        return languageOverride;
    }

    public IndexRequest languageOverride(@Nullable final String languageOverride) {
        this.languageOverride = languageOverride;
        return this;
    }

    @Nullable
    public Integer getTextVersion() {
        return textVersion;
    }

    public IndexRequest textVersion(@Nullable final Integer textVersion) {
        if (textVersion != null) {
            isTrueArgument("textVersion must be 1, 2 or 3", VALID_TEXT_INDEX_VERSIONS.contains(textVersion));
        }
        this.textVersion = textVersion;
        return this;
    }

    @Nullable
    public Integer getSphereVersion() {
        return sphereVersion;
    }

    public IndexRequest sphereVersion(@Nullable final Integer sphereVersion) {
        if (sphereVersion != null) {
            isTrueArgument("sphereIndexVersion must be 1, 2 or 3", VALID_SPHERE_INDEX_VERSIONS.contains(sphereVersion));
        }
        this.sphereVersion = sphereVersion;
        return this;
    }

    @Nullable
    public Integer getBits() {
        return bits;
    }

    public IndexRequest bits(@Nullable final Integer bits) {
        this.bits = bits;
        return this;
    }

    @Nullable
    public Double getMin() {
        return min;
    }

    public IndexRequest min(@Nullable final Double min) {
        this.min = min;
        return this;
    }

    @Nullable
    public Double getMax() {
        return max;
    }

    public IndexRequest max(@Nullable final Double max) {
        this.max = max;
        return this;
    }

    @Deprecated
    @Nullable
    public Double getBucketSize() {
        return bucketSize;
    }

    @Deprecated
    public IndexRequest bucketSize(@Nullable final Double bucketSize) {
        this.bucketSize = bucketSize;
        return this;
    }

    public boolean getDropDups() {
        return dropDups;
    }

    public IndexRequest dropDups(final boolean dropDups) {
        this.dropDups = dropDups;
        return this;
    }

    @Nullable
    public BsonDocument getStorageEngine() {
        return storageEngine;
    }

    public IndexRequest storageEngine(@Nullable final BsonDocument storageEngineOptions) {
        this.storageEngine = storageEngineOptions;
        return this;
    }

    @Nullable
    public BsonDocument getPartialFilterExpression() {
        return partialFilterExpression;
    }

    public IndexRequest partialFilterExpression(@Nullable final BsonDocument partialFilterExpression) {
        this.partialFilterExpression = partialFilterExpression;
        return this;
    }

    @Nullable
    public Collation getCollation() {
        return collation;
    }

    public IndexRequest collation(@Nullable final Collation collation) {
        this.collation = collation;
        return this;
    }

    @Nullable
    public BsonDocument getWildcardProjection() {
        return wildcardProjection;
    }

    public IndexRequest wildcardProjection(@Nullable final BsonDocument wildcardProjection) {
        this.wildcardProjection = wildcardProjection;
        return this;
    }

    public boolean isHidden() {
        return hidden;
    }

    public IndexRequest hidden(final boolean hidden) {
        this.hidden = hidden;
        return this;
    }
}