<commit_before>/*
 * Copyright (c) 2002-2009 "Neo Technology,"
 *     Network Engine for Objects in Lund AB [http://neotechnology.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 Affero 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 Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
package org.neo4j.index;

import org.neo4j.graphdb.Node;

/**
 * Index service to index nodes with a key and a value. The Neo4j Kernel has no
 * indexing features built-in. Instead you'll have to manage indexing manually.
 * IndexService is a means of providing those indexing capabilities for a Neo4j
 * graph and integrate it as tightly as possible with the graph engine.
 * 
 * See more at <a
 * href="http://wiki.neo4j.org/content/Indexing_with_IndexService"> The Neo4j
 * wiki page on "Indexing with IndexService"</a>.
 */
public interface IndexService
{
    /**
     * Index <code>node</code> with <code>key</code> and <code>value</code>. A
     * node can be associated with any number of key-value pairs.
     * <p>
     * Note about updating an index: If you've indexed a value from a property
     * on a {@link Node} and that value gets updated, you'll have to remove the
     * old value in addition to indexing the new value, else both values (the
     * new and the old) will be indexed for that node.<commit_msg>Fixed some details in the javadoc.<commit_after>/*
 * Copyright (c) 2002-2009 "Neo Technology,"
 *     Network Engine for Objects in Lund AB [http://neotechnology.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 Affero 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 Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
package org.neo4j.index;

import org.neo4j.graphdb.Node;

/**
 * Index service to index nodes with a key and a value. The Neo4j Kernel has no
 * indexing features built-in. Instead you'll have to manage indexing manually.
 * IndexService is a means of providing those indexing capabilities for a Neo4j
 * graph and integrate it as tightly as possible with the graph engine.
 * <p>
 * Note that changes on {@link Node} properties respective nodes that are
 * deleted must be propagated to the index by the application.
 * <p>
 * See more at <a
 * href="http://wiki.neo4j.org/content/Indexing_with_IndexService"> The Neo4j
 * wiki page on "Indexing with IndexService"</a>.
 */
public interface IndexService
{
    /**
     * Index <code>node</code> with <code>key</code> and <code>value</code>. A
     * node can be associated with any number of key-value pairs.
     * <p>
     * Note about updating an index: If you've indexed a value from a property
     * on a {@link Node} and that value gets updated, you'll have to remove the
     * old value in addition to indexing the new value, else both values (the
     * new and the old) will be indexed for that node.
     * <p>
     * When deleting a {@link Node}, application should remove the index entries
     * for the node as well, to keep the index consistent with the node space.
{'fraction_non_alphanumeric': 0.07741459818137135, 'fraction_numerical': 0.008355861391005161, 'mean_word_length': 3.428726877040261, 'pattern_counts': {'":': 0, '<': 26, '<?xml version=': 0, '>': 26, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6712338', 'n_tokens_mistral': 1144, 'n_tokens_neox': 1074, 'n_words': 571}