com.arangodb.entity.arangosearch.analyzer.PipelineAnalyzer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of arangodb-java-driver-shaded Show documentation

ArangoDB Java Driver Shaded

There is a newer version: 7.13.0

Show newest version

/*
 * DISCLAIMER
 *
 * Copyright 2016 ArangoDB GmbH, Cologne, Germany
 *
 * 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.
 *
 * Copyright holder is ArangoDB GmbH, Cologne, Germany
 */

package com.arangodb.entity.arangosearch.analyzer;


import com.arangodb.entity.arangosearch.AnalyzerType;

import java.util.Objects;

/**
 * An Analyzer capable of chaining effects of multiple Analyzers into one. The pipeline is a list of Analyzers, where
 * the output of an Analyzer is passed to the next for further processing.
 * 
 * LIMITATIONS: Analyzers of types {@link GeoPointAnalyzer} and {@link GeoJSONAnalyzer} cannot be used in
 * pipelines and
 * will make the creation fail.
 * 
 *
 * @author Michele Rastelli
 * @see API Documentation
 * @since ArangoDB 3.8
 */
public final class PipelineAnalyzer extends SearchAnalyzer {

    private PipelineAnalyzerProperties properties;

    public PipelineAnalyzer() {
        setType(AnalyzerType.pipeline);
    }

    public PipelineAnalyzerProperties getProperties() {
        return properties;
    }

    public void setProperties(PipelineAnalyzerProperties properties) {
        this.properties = properties;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        if (!super.equals(o)) return false;
        PipelineAnalyzer that = (PipelineAnalyzer) o;
        return Objects.equals(properties, that.properties);
    }

    @Override
    public int hashCode() {
        return Objects.hash(super.hashCode(), properties);
    }

}