org.neo4j.kernel.api.explicitindex.AutoIndexing Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ongdb-kernel Show documentation

ONgDB kernel is a lightweight, embedded Java database designed to store data structured as graphs rather than tables. For more information, see https://graphfoundation.org.

There is a newer version: 3.6.2

Show newest version

/*
 * Copyright (c) 2018-2020 "Graph Foundation,"
 * Graph Foundation, Inc. [https://graphfoundation.org]
 *
 * This file is part of ONgDB.
 *
 * ONgDB is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
/*
 * Copyright (c) 2002-2020 "Neo4j,"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.kernel.api.explicitindex;

/**
 * Abstract interface for accessing legacy auto indexing facilities for nodes and relationships
 *
 * @see AutoIndexOperations
 * @see org.neo4j.kernel.impl.api.explicitindex.InternalAutoIndexing
 */
public interface AutoIndexing
{
    /**
     * An instance of {@link AutoIndexing} that only returns {@link AutoIndexOperations}
     * that throw {@link UnsupportedOperationException} when any method is invoked on them.
     */
    AutoIndexing UNSUPPORTED = new AutoIndexing()
    {
        @Override
        public AutoIndexOperations nodes()
        {
            return AutoIndexOperations.UNSUPPORTED;
        }

        @Override
        public AutoIndexOperations relationships()
        {
            return AutoIndexOperations.UNSUPPORTED;
        }
    };

    /**
     * @return {@link AutoIndexOperations} for nodes
     */
    AutoIndexOperations nodes();

    /**
     * @return {@link AutoIndexOperations} for relationships
     */
    AutoIndexOperations relationships();
}