org.dizitart.no2.spatial.SpatialModule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nitrite-spatial Show documentation

Spatial indexing support for Nitrite

The newest version!

/*
 * Copyright (c) 2017-2020. Nitrite author or authors.
 *
 * 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 org.dizitart.no2.spatial;

import org.dizitart.no2.common.module.NitriteModule;
import org.dizitart.no2.common.module.NitritePlugin;
import org.dizitart.no2.spatial.converter.GeometryConverter;

import java.util.Set;

import static org.dizitart.no2.common.util.Iterables.setOf;


/**
 * A Nitrite module for spatial indexing. This module provides a
 * {@link SpatialIndexer} plugin for Nitrite database.
 * 
 * @since 4.0
 * @author Anindya Chatterjee
 */
public class SpatialModule implements NitriteModule {
    /**
     * {@inheritDoc}
     * Returns a set of Nitrite plugins, which includes the SpatialIndexer.
     *
     * @return a set of Nitrite plugins, which includes the SpatialIndexer.
     */
    @Override
    public Set plugins() {
        return setOf(new SpatialIndexer(), new GeometryConverter());
    }
}