com.azure.cosmos.CompositePath Maven / Gradle / Ivy
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.cosmos;
import com.azure.cosmos.implementation.Constants;
import org.apache.commons.lang3.StringUtils;
/**
* Represents a composite path of the IndexingPolicy in the Azure Cosmos DB database service.
* A composite path is used in a composite index. For example if you want to run a query like
* "SELECT * FROM c ORDER BY c.age, c.height", then you need to add "/age" and "/height"
* as composite paths to your composite index.
*/
public class CompositePath extends JsonSerializable {
/**
* Constructor.
*/
public CompositePath() {
super();
}
/**
* Constructor.
*
* @param jsonString the json string that represents the included path.
*/
public CompositePath(String jsonString) {
super(jsonString);
}
/**
* Gets path.
*
* @return the path.
*/
public String getPath() {
return super.getString(Constants.Properties.PATH);
}
/**
* Sets path.
*
* @param path the path.
* @return the CompositePath.
*/
public CompositePath setPath(String path) {
super.set(Constants.Properties.PATH, path);
return this;
}
/**
* Gets the sort order for the composite path.
*
* For example if you want to run the query "SELECT * FROM c ORDER BY c.age asc, c.height desc",
* then you need to make the order for "/age" "ascending" and the order for "/height" "descending".
*
* @return the sort order.
*/
public CompositePathSortOrder getOrder() {
String strValue = super.getString(Constants.Properties.ORDER);
if (!StringUtils.isEmpty(strValue)) {
try {
return CompositePathSortOrder
.valueOf(StringUtils.upperCase(super.getString(Constants.Properties.ORDER)));
} catch (IllegalArgumentException e) {
this.getLogger().warn("INVALID getIndexingMode getValue {}.",
super.getString(Constants.Properties.ORDER));
return CompositePathSortOrder.ASCENDING;
}
}
return CompositePathSortOrder.ASCENDING;
}
/**
* Gets the sort order for the composite path.
*
* For example if you want to run the query "SELECT * FROM c ORDER BY c.age asc, c.height desc",
* then you need to make the order for "/age" "ascending" and the order for "/height" "descending".
*
* @param order the sort order.
* @return the CompositePath.
*/
public CompositePath setOrder(CompositePathSortOrder order) {
super.set(Constants.Properties.ORDER, order.toString());
return this;
}
}