/
AutomaticIndex.java
36 lines (30 loc) · 1.16 KB
/
AutomaticIndex.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
package com.tinkerpop.blueprints.pgm;
import java.util.Set;
/**
* An automatic index will automatically maintain an index of element properties as the element properties mutate.
* The key/value pairs that are automatically monitored are element properties and their values.
*
* @author Marko A. Rodriguez (http://markorodriguez.com)
*/
public interface AutomaticIndex<T extends Element> extends Index<T> {
/**
* Add an element property key that should be indexed.
* If null is provided as the key, then all properties are indexed (i.e. null is wildcard)
*
* @param key the element property key to be indexed
*/
public void addAutoIndexKey(String key);
/**
* Remove an element property key from being indexed.
*
* @param key the element property to key to not be indexed
*/
public void removeAutoIndexKey(String key);
/**
* Get all the element property keys currently being indexed.
* If what is returned is null, then all keys are currently being indexed (i.e. null is wildcard)
*
* @return the set of element property keys being indexed
*/
public Set<String> getAutoIndexKeys();
}