oracle.ide.dependency.index

Class IndexDeclaration

java.lang.Object

oracle.ide.dependency.IdDeclaration

oracle.ide.dependency.index.IndexDeclaration

All Implemented Interfaces:

Declaration, SourceDeclaration

public abstract class IndexDeclaration
extends IdDeclaration
implements SourceDeclaration

A declaration stored in the index.

Field Summary

Fields inherited from class oracle.ide.dependency.IdDeclaration

id

Constructor Summary

Constructors

Constructor and Description
IndexDeclaration(java.lang.String id, IndexingContext context, int startOffset, int endOffset)
IndexDeclaration(java.lang.String id, 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 declaration in the source file.
Project	getProject() Get the project containing the source file this declaration appears in.
QueryCriteria	getQueryCriteria() Get the index query criteria that matches this declaration.
int	getStartOffset() Get the start offset of the declaration in the source file.
java.net.URL	getURL() Get the URL containing this declaration, if there is one.
Workspace	getWorkspace() Get the workspace containing the source file this declaration appears in.
void	show() Show this declaration to the user.

Methods inherited from class oracle.ide.dependency.IdDeclaration

canDelete, delete, equals, findDeclaration, getDeclarationId, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.dependency.Declaration

canDelete, delete

Constructor Detail

IndexDeclaration

public IndexDeclaration(java.lang.String id,
                        IndexingContext context,
                        int startOffset,
                        int endOffset)

IndexDeclaration

public IndexDeclaration(java.lang.String id,
                        Workspace workspace,
                        Project project,
                        java.net.URL url,
                        int startOffset,
                        int endOffset)

Method Detail

getWorkspace

public Workspace getWorkspace()

Description copied from interface: SourceDeclaration

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

Specified by:

getWorkspace in interface SourceDeclaration

Returns:

the workspace

getProject

public Project getProject()

Description copied from interface: SourceDeclaration

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

Specified by:

getProject in interface SourceDeclaration

Returns:

the project

getURL

public java.net.URL getURL()

Description copied from interface: Declaration

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

Specified by:

getURL in interface Declaration

Returns:

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

getStartOffset

public int getStartOffset()

Description copied from interface: SourceDeclaration

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

Specified by:

getStartOffset in interface SourceDeclaration

Returns:

the start offset

getEndOffset

public int getEndOffset()

Description copied from interface: SourceDeclaration

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

Specified by:

getEndOffset in interface SourceDeclaration

Returns:

the end offset

show

public void show()

Description copied from interface: Declaration

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

Specified by:

show in interface Declaration

getQueryCriteria

public QueryCriteria getQueryCriteria()

Get the index query criteria that matches this declaration.

Returns:

the query criteria