/*
* 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.operation;
import com.mongodb.client.model.IndexModel;
import org.bson.BsonDocument;
import org.bson.BsonNumber;
import org.bson.BsonString;
import org.bson.BsonValue;
import org.bson.codecs.configuration.CodecRegistry;
import java.util.ArrayList;
import java.util.List;
This class is NOT part of the public API. It may change at any time without notification.
/**
* This class is NOT part of the public API. It may change at any time without notification.
*/
public final class IndexHelper {
Get a list of index names for the given list of index models
Params: - indexes – the index models
- codecRegistry – the codec registry to convert each Bson key to a BsonDocument
Returns: the list of index names
/**
* Get a list of index names for the given list of index models
*
* @param indexes the index models
* @param codecRegistry the codec registry to convert each Bson key to a BsonDocument
* @return the list of index names
*/
public static List<String> getIndexNames(final List<IndexModel> indexes, final CodecRegistry codecRegistry) {
List<String> indexNames = new ArrayList<String>(indexes.size());
for (IndexModel index : indexes) {
String name = index.getOptions().getName();
if (name != null) {
indexNames.add(name);
} else {
indexNames.add(IndexHelper.generateIndexName(index.getKeys().toBsonDocument(BsonDocument.class, codecRegistry)));
}
}
return indexNames;
}
Convenience method to generate an index name from the set of fields it is over.
Returns: a string representation of this index's fields
/**
* Convenience method to generate an index name from the set of fields it is over.
*
* @return a string representation of this index's fields
*/
public static String generateIndexName(final BsonDocument index) {
StringBuilder indexName = new StringBuilder();
for (final String keyNames : index.keySet()) {
if (indexName.length() != 0) {
indexName.append('_');
}
indexName.append(keyNames).append('_');
BsonValue ascOrDescValue = index.get(keyNames);
if (ascOrDescValue instanceof BsonNumber) {
indexName.append(((BsonNumber) ascOrDescValue).intValue());
} else if (ascOrDescValue instanceof BsonString) {
indexName.append(((BsonString) ascOrDescValue).getValue().replace(' ', '_'));
}
}
return indexName.toString();
}
private IndexHelper() {
}
}