oracle.ide.db.util

Class InsightSupport

java.lang.Object

oracle.ide.db.util.InsightSupport

public class InsightSupport
extends java.lang.Object

This helper class provides common methods for components that utilise code completion and insight e.g. SQLQueryPanel and Expression editor.

Constructor Summary

Constructors

Constructor and Description
InsightSupport()

Method Summary

Methods

Modifier and Type	Method and Description
void	addToInsightTextField(java.lang.String text, javax.swing.text.JTextComponent textComponent) Adds the given text to the given text component.
java.lang.String	completeInsight(java.lang.Object insert, int insertIndx, javax.swing.text.Document doc, boolean matchCase) Complete insight with given insert object.
static java.lang.String	convertToString(java.lang.Object obj) Static helper method for converting insight objects to a String
java.lang.Object[]	filter(java.lang.Object[] filterObjects, java.lang.String filter, boolean applyContainsFilter) Filter given objects by given filter value
static java.util.Comparator	getComparator() Gets a Comparator that generically compares objects.
java.lang.String	getLastInserted() Get last inserted value.
int	getSelectionEndIndex() Get selection end index.
int	getSelectionStartIndex() Get selection start index.
boolean	isInQuotes(java.lang.String text) Helper method to determine if given text is in quotes.
int[]	lastNonAlphaNumIndex(java.lang.String text, int i) Returns the last letter of digit in the given string before or at the given index.
int	nextNonAlphaNumIndex(java.lang.String text, int i) Returns the next index that contains a non letter or digit, or the end of the string if none are found.
boolean	partOfName(char c) Is the given character part of a name.
void	setLastInserted(java.lang.String lastInserted) Set last inserted insight value.
void	setSelectionEndIndex(int selectionEndIndex) Set selection end index.
void	setSelectionStartIndex(int selectionStartIndex) Set selection start index.

Methods inherited from class java.lang.Object

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

Constructor Detail

InsightSupport

public InsightSupport()

Method Detail

filter

public java.lang.Object[] filter(java.lang.Object[] filterObjects,
                        java.lang.String filter,
                        boolean applyContainsFilter)

Filter given objects by given filter value

Parameters:

filterObjects - objects to filter

filter - filter value

applyContainsFilter - if true then include any objects that contain the filter value otherwise return objects that start with the filter value

Returns:

completeInsight

public java.lang.String completeInsight(java.lang.Object insert,
                               int insertIndx,
                               javax.swing.text.Document doc,
                               boolean matchCase)
                                 throws javax.swing.text.BadLocationException

Complete insight with given insert object.

Parameters:

insert - object to insert into text document

insertIndx - point at which toisert insight object

doc - document of insight text component

matchCase - if true then match case of the word that is being auto-completed else just insert object without changing case

Returns:

the actual text that was inserted

Throws:

javax.swing.text.BadLocationException - when exception occurs

addToInsightTextField

public void addToInsightTextField(java.lang.String text,
                         javax.swing.text.JTextComponent textComponent)

Adds the given text to the given text component.

Parameters:

text - text to add

textComponent - text component to add to

setLastInserted

public void setLastInserted(java.lang.String lastInserted)

Set last inserted insight value.

Parameters:

lastInserted - value that was last inserted

getLastInserted

public java.lang.String getLastInserted()

Get last inserted value.

Returns:

last inserted value

setSelectionStartIndex

public void setSelectionStartIndex(int selectionStartIndex)

Set selection start index. Used with selection end index to highlight part of text after completion occurs.

Parameters:

selectionStartIndex - index for selection to begin

getSelectionStartIndex

public int getSelectionStartIndex()

Get selection start index.

Returns:

selection start index

setSelectionEndIndex

public void setSelectionEndIndex(int selectionEndIndex)

Set selection end index. Used with selection start index to highlight part of text after completion occurs.

Parameters:

selectionEndIndex - index for selection to begin*

getSelectionEndIndex

public int getSelectionEndIndex()

Get selection end index.

Returns:

selection end index

isInQuotes

public boolean isInQuotes(java.lang.String text)

Helper method to determine if given text is in quotes.

Parameters:

text - text to search

Returns:

true if in quotes else false

partOfName

public boolean partOfName(char c)

Is the given character part of a name.

Parameters:

c - character

Returns:

true if character could be in a name

lastNonAlphaNumIndex

public int[] lastNonAlphaNumIndex(java.lang.String text,
                         int i)

Returns the last letter of digit in the given string before or at the given index.

Parameters:

text - the text to search in

i - the index to start searching BEFORE.

Returns:

array of size 2 - first entry is the position and second is the char in question.

nextNonAlphaNumIndex

public int nextNonAlphaNumIndex(java.lang.String text,
                       int i)

Returns the next index that contains a non letter or digit, or the end of the string if none are found.

Parameters:

text - the text to search in

i - the index to start searching from.

Returns:

index of next non letter or digit

convertToString

public static java.lang.String convertToString(java.lang.Object obj)

Static helper method for converting insight objects to a String

getComparator

public static java.util.Comparator getComparator()

Gets a Comparator that generically compares objects. It is expected to be used only with the insight collection/maps returned by this class. Always use a more specific Comparator if appropriate (e.g. DBUtil.getNameComparator() ).