apoc.meta.SampleMetaConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apoc-common Show documentation

Data types package for Neo4j Procedures

There is a newer version: 5.25.1

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * 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 apoc.meta;

import java.util.Collections;
import java.util.Map;

public class SampleMetaConfig {
    private final long maxRels;
    private final long sample;

    /**
     * - sample: a long, i.e. "1 in (SAMPLE)".  If set to 1000 this means that every 1000th node will be examined.
     * It does **not** mean that a total of 1000 nodes will be sampled.
     * - maxRels: the maximum number of relationships to look at per Node Label.
     */
    public SampleMetaConfig(Map config, Boolean shouldSampleByDefault) {
        config = config != null ? config : Collections.emptyMap();

        this.sample = (long) config.getOrDefault("sample", shouldSampleByDefault ? 1000L : 1L);
        this.maxRels = (long) config.getOrDefault("maxRels", shouldSampleByDefault ? 100L : -1L);
    }

    public SampleMetaConfig(Map config) {
        this(config, true);
    }

    public long getSample() {
        return sample;
    }

    public long getMaxRels() {
        return maxRels;
    }
}