io.evitadb.api.requestResponse.extraResult.AttributeHistogram Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of evita_api Show documentation

Module contains external API of the evitaDB.

The newest version!

/*
 *
 *                         _ _        ____  ____
 *               _____   _(_) |_ __ _|  _ \| __ )
 *              / _ \ \ / / | __/ _` | | | |  _ \
 *             |  __/\ V /| | || (_| | |_| | |_) |
 *              \___| \_/ |_|\__\__,_|____/|____/
 *
 *   Copyright (c) 2023
 *
 *   Licensed under the Business Source License, Version 1.1 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *   https://github.com/FgForrest/evitaDB/blob/master/LICENSE
 *
 *   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 io.evitadb.api.requestResponse.extraResult;

import io.evitadb.api.requestResponse.EvitaResponseExtraResult;
import lombok.EqualsAndHashCode;
import lombok.RequiredArgsConstructor;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.ThreadSafe;
import java.io.Serial;
import java.util.Collections;
import java.util.Map;
import java.util.stream.Collectors;

/**
 * Attribute histogram is just index for {@link Histogram} objects for multiple attributes.
 *
 * @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2021
 * @see Histogram
 */
@RequiredArgsConstructor
@EqualsAndHashCode
@ThreadSafe
public class AttributeHistogram implements EvitaResponseExtraResult {
	@Serial private static final long serialVersionUID = -7146180484780093482L;
	private final Map histograms;

	/**
	 * Returns {@link Histogram} for the passed attribute when it was requested to be created by the query requirements.
	 */
	@Nullable
	public HistogramContract getHistogram(@Nonnull String attributeName) {
		return histograms.get(attributeName);
	}

	/**
	 * Returns all attached histograms.
	 */
	@Nonnull
	public Map getHistograms() {
		return Collections.unmodifiableMap(histograms);
	}

	@Override
	public String toString() {
		return histograms.entrySet().stream()
			.map(it -> it.getKey() + ": " + it.getValue().toString())
			.collect(Collectors.joining("\n"));
	}
}