Package org.aspectj.org.eclipse.jdt.internal.core.index

Klasse Index

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.core.index.Index

public class Index
extends Object

An Index maps document names to their referenced words in various categories.

Queries can search a single category or several at the same time.

Indexes are not synchronized structures and should only be queried/updated one at a time.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
String	containerPath
protected DiskIndex	diskIndex
protected MemoryIndex	memoryIndex
ReadWriteMonitor	monitor
char	separator

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
Index(IndexLocation location, String containerPath, boolean reuseExistingFile)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addIndexEntry(char[] category, char[] key, String containerRelativePath)
String	containerRelativePath(String documentPath)
File	getIndexFile()
long	getIndexLastModified()
IndexLocation	getIndexLocation()
List<IndexQualifier>	getMetaIndexQualifications()
boolean	hasChanged()
boolean	isIndexForJar()
static boolean	isMatch(char[] pattern, char[] word, int matchRule)
EntryResult[]	query(char[][] categories, char[] key, int matchRule)	Returns the entries containing the given key in a group of categories, or null if no matches are found.
String[]	queryDocumentNames(String substring)	Returns the document names that contain the given substring, if null then returns all of them.
void	remove(String containerRelativePath)
void	reset()	Reset memory and disk indexes.
boolean	save()
void	startQuery()
void	stopQuery()
String	toString()

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

containerPath

public String containerPath

monitor

public volatile ReadWriteMonitor monitor

separator

public char separator

diskIndex

protected DiskIndex diskIndex

memoryIndex

protected MemoryIndex memoryIndex

Konstruktordetails

Index

public Index(IndexLocation location,
 String containerPath,
 boolean reuseExistingFile)
      throws IOException

Löst aus:

IOException

Methodendetails

isMatch

public static boolean isMatch(char[] pattern,
 char[] word,
 int matchRule)

addIndexEntry

public void addIndexEntry(char[] category,
 char[] key,
 String containerRelativePath)

containerRelativePath

public String containerRelativePath(String documentPath)

getIndexFile

public File getIndexFile()

getIndexLocation

public IndexLocation getIndexLocation()

getIndexLastModified

public long getIndexLastModified()

hasChanged

public boolean hasChanged()

query

public EntryResult[] query(char[][] categories,
 char[] key,
 int matchRule)
                    throws IOException

Returns the entries containing the given key in a group of categories, or null if no matches are found. The matchRule dictates whether its an exact, prefix or pattern match, as well as case sensitive or insensitive. If the key is null then all entries in specified categories are returned.

Löst aus:

IOException

queryDocumentNames

public String[] queryDocumentNames(String substring)
                            throws IOException

Returns the document names that contain the given substring, if null then returns all of them.

Löst aus:

IOException

remove

public void remove(String containerRelativePath)

reset

public void reset()
           throws IOException

Reset memory and disk indexes.

Löst aus:

IOException

save

public boolean save()
             throws IOException

Löst aus:

IOException

startQuery

public void startQuery()

stopQuery

public void stopQuery()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object

isIndexForJar

public boolean isIndexForJar()

getMetaIndexQualifications

public List<IndexQualifier> getMetaIndexQualifications()
                                                throws IOException

Löst aus:

IOException