oracle.ide.db.insight.model

Class ParentLocator

java.lang.Object

oracle.ide.db.insight.model.ParentLocator

public class ParentLocator
extends java.lang.Object

A class to find the object represented by a dot seperated list of names which is the parent of the insight data being built.

Constructor Summary

Constructors

Constructor and Description
ParentLocator()

Method Summary

Modifier and Type	Method and Description
protected DBObject	getContextObjectAtOffset() Returns the DBObject that is most closely associated with the location in the text of the offset.
protected java.util.logging.Logger	getLogger() Gets a Logger for logging messages related to this locator.
protected int	getOffset()
protected DBObject	getParent(java.util.List<java.lang.String> names) Finds the object represented by a dot seperated list of names.
protected DBObjectProvider	getProvider()
protected Schema	getSchema()
protected java.lang.String	getSearchString()
protected java.lang.String	getText()
protected void	setDBInsightProvider(DBInsightProvider insightProvider) Called by the DBInsightProvider that instatiates this class (or subclass).

Methods inherited from class java.lang.Object

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

Constructor Detail

ParentLocator

public ParentLocator()

Method Detail

setDBInsightProvider

protected final void setDBInsightProvider(DBInsightProvider insightProvider)

Called by the DBInsightProvider that instatiates this class (or subclass).

Parameters:

insightProvider - the DBInsightProvider

getContextObjectAtOffset

protected final DBObject getContextObjectAtOffset()

Returns the DBObject that is most closely associated with the location in the text of the offset. This will typically be the context object in the DBInsightContext, or the schema for anything other than PL/SQL. For PL/SQL, it can be a block, varibale, parameter etc.

getProvider

protected final DBObjectProvider getProvider()

Returns:

The DBObjectProvider

getText

protected final java.lang.String getText()

Returns:

The text specified in the DBInsightContext (within the given range if applicable)

getOffset

protected final int getOffset()

Returns:

The offset in the text where the Insight is requested.

getSearchString

protected final java.lang.String getSearchString()

Returns:

The text entered by the user prior to invoking the insight provider. Typically this is the text from the end of preceding white space or dot up to the cursor location.

getSchema

protected final Schema getSchema()

Returns:

The current schema. This may be as defined on the DBInsightContext, but may be derived from the provider's default if not.

getParent

protected DBObject getParent(java.util.List<java.lang.String> names)
                      throws CancelledException

Finds the object represented by a dot seperated list of names.

Parameters:

names - Each of the dot seperated names in a List.

Returns:

The parent object

Throws:

CancelledException

getLogger

protected java.util.logging.Logger getLogger()

Gets a Logger for logging messages related to this locator.

Returns:

a logger