oracle.ide.dependency.index

Class IndexReference

java.lang.Object

oracle.ide.dependency.IdReference

oracle.ide.dependency.index.IndexReference

All Implemented Interfaces:

Reference, SourceReference

public abstract class IndexReference
extends IdReference
implements SourceReference

A reference stored in the index.

Constructor Summary

Constructors

Constructor and Description
IndexReference(IndexingContext context, int startOffset, int endOffset)
IndexReference(Workspace workspace, Project project, java.net.URL url, int startOffset, int endOffset)

Method Summary

Modifier and Type	Method and Description
int	getEndOffset() Get the end offset of the reference in the source file.
Project	getProject() Get the project containing the source file this reference appears in.
QueryCriteria	getQueryCriteria() Get the index query criteria that matches this reference.
int	getStartOffset() Get the start offset of the reference in the source file.
java.net.URL	getURL() Get the URL containing this reference, if there is one.
Workspace	getWorkspace() Get the workspace containing the source file this reference appears in.
void	show() Show this reference to the user.

Methods inherited from class oracle.ide.dependency.IdReference

getDeclarationId, isReferenceTo, resolve, setDeclarationId

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.dependency.Reference

isReferenceTo, resolve

Constructor Detail

IndexReference

public IndexReference(IndexingContext context,
                      int startOffset,
                      int endOffset)

IndexReference

public IndexReference(Workspace workspace,
                      Project project,
                      java.net.URL url,
                      int startOffset,
                      int endOffset)

Method Detail

getWorkspace

public Workspace getWorkspace()

Description copied from interface: SourceReference

Get the workspace containing the source file this reference appears in.

Specified by:

getWorkspace in interface SourceReference

Returns:

the workspace

getProject

public Project getProject()

Description copied from interface: SourceReference

Get the project containing the source file this reference appears in.

Specified by:

getProject in interface SourceReference

Returns:

the project

getURL

public java.net.URL getURL()

Description copied from interface: Reference

Get the URL containing this reference, if there is one.

Specified by:

getURL in interface Reference

Returns:

the URL, or null if there is no URL associated with this reference

getStartOffset

public int getStartOffset()

Description copied from interface: SourceReference

Get the start offset of the reference in the source file.

Specified by:

getStartOffset in interface SourceReference

Returns:

the start offset

getEndOffset

public int getEndOffset()

Description copied from interface: SourceReference

Get the end offset of the reference in the source file.

Specified by:

getEndOffset in interface SourceReference

Returns:

the end offset

show

public void show()

Description copied from interface: Reference

Show this reference to the user. For example, this might open an editor with the reference selected.

Specified by:

show in interface Reference

getQueryCriteria

public QueryCriteria getQueryCriteria()

Get the index query criteria that matches this reference.

Returns:

the query criteria