ai.grakn.graql

Class Autocomplete

java.lang.Object

ai.grakn.graql.Autocomplete

public class Autocomplete
extends Object

An autocomplete result suggesting keywords, types and variables that the user may wish to type

Method Summary

Modifier and Type	Method and Description
static Autocomplete	create(Set<String> types, String query, int cursorPosition)
Set<String>	getCandidates()
int	getCursorPosition()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Autocomplete create(Set<String> types,
                                  String query,
                                  int cursorPosition)

Parameters:

types - a set of type IDs to autocomplete

query - the query to autocomplete

cursorPosition - the cursor position in the query

Returns:

an autocomplete object containing potential candidates and cursor position to autocomplete from

getCandidates

public Set<String> getCandidates()

Returns:

all candidate autocomplete words

getCursorPosition

public int getCursorPosition()

Returns:

the cursor position that autocompletions should start from