net.sf.jabref.autocompleter

Class AbstractAutoCompleter

java.lang.Object

net.sf.jabref.autocompleter.AbstractAutoCompleter

Direct Known Subclasses:

CrossrefAutoCompleter, DefaultAutoCompleter, EntireFieldAutoCompleter, NameFieldAutoCompleter

public abstract class AbstractAutoCompleter
extends java.lang.Object

An autocompleter delivers possible completions for a given String. There are different types of autocompleters for different use cases. Example: NameFieldAutoCompleter, EntireFieldAutoCompleter

Author:

kahlert, cordes, olly98

See Also:

AutoCompleterFactory

Field Summary

Fields

Modifier and Type	Field and Description
static int	SHORTEST_TO_COMPLETE
static int	SHORTEST_WORD

Constructor Summary

Constructors

Constructor and Description
AbstractAutoCompleter()

Method Summary

Modifier and Type	Method and Description
abstract void	addBibtexEntry(BibtexEntry entry) Add a BibtexEntry to this autocompleter.
void	addWordToIndex(java.lang.String word)
java.lang.String[]	complete(java.lang.String str) Returns one or more possible completions for a given String.
java.lang.String	getPrefix()
boolean	indexContainsWord(java.lang.String word)
abstract boolean	isSingleUnitField() States whether the field consists of multiple values (false) or of a single value (true) Symptom: if false, AutoCompleteListener.getCurrentWord(JTextComponent comp) returns current word only, if true, it returns the text beginning from the buffer

Methods inherited from class java.lang.Object

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

Field Detail

SHORTEST_TO_COMPLETE

public static int SHORTEST_TO_COMPLETE

SHORTEST_WORD

public static final int SHORTEST_WORD

See Also:

Constant Field Values

Constructor Detail

AbstractAutoCompleter

public AbstractAutoCompleter()

Method Detail

addBibtexEntry

public abstract void addBibtexEntry(BibtexEntry entry)

Add a BibtexEntry to this autocompleter. The autocompleter (respectively to the concrete implementations of AbstractAutoCompleter) itself decides which information should be stored for later completion.

isSingleUnitField

public abstract boolean isSingleUnitField()

States whether the field consists of multiple values (false) or of a single value (true) Symptom: if false, AutoCompleteListener.getCurrentWord(JTextComponent comp) returns current word only, if true, it returns the text beginning from the buffer

complete

public java.lang.String[] complete(java.lang.String str)

Returns one or more possible completions for a given String. The returned completion depends on which informations were stored while adding BibtexEntries by the used implementation of AbstractAutoCompleter .

See Also:

addBibtexEntry(BibtexEntry)

addWordToIndex

public void addWordToIndex(java.lang.String word)

indexContainsWord

public boolean indexContainsWord(java.lang.String word)

getPrefix

public java.lang.String getPrefix()