oracle.ide.db.model

Class BaseDBObjectTextNode

java.lang.Object

oracle.ide.model.Node

oracle.ide.model.TextNode

oracle.ide.db.model.BaseDBObjectTextNode

All Implemented Interfaces:

DBObjectNode, DBObjectProviderNode, DBObjectTypeNode, Displayable, Element, LazyLoadable, Locatable, Subject, Dirtyable

Direct Known Subclasses:

BasePlSqlTextNode

public abstract class BaseDBObjectTextNode
extends TextNode
implements DBObjectNode

Convenience subclass of TextNode that implements DBObjectNode. Client code should not register against, or rely on this class. Where possible use the interface. For PL/SQL there is another subclass that specifically implements DBObjectPlSqlNode.

See Also:

DBObjectNode, BaseDBObjectNode, BasePlSqlTextNode

Field Summary

Fields inherited from class oracle.ide.model.Node

LOG_READONLY

Constructor Summary

Constructors

Constructor and Description
BaseDBObjectTextNode()

Method Summary

Modifier and Type	Method and Description
void	cancelCurrentBuild() Deprecated.
protected SourceObject	findProviderDBObject() Returns the instance of the DBbject this node represents that is owned by the provider.
DBObject	getDBObject() Returns the DBObject for the node.
SourceObject	getDBObject(boolean fullyBuilt) Deprecated. Use #getDBObjectFromBuffer
SourceObject	getDBObjectFromBuffer() Return a SourceObject whose source matches the current contents of the TextBuffer.
javax.swing.Icon	getIcon() Default implementation of this Displayable method returns the appropriate icon for the object's type.
int	getLine(int offset) Returns the line number in the TextBuffer for the given offset if it can be found, zero otherwise.
DBObjectProvider	getProvider() Gets the provider from the DBObjectProviderFactory using the key returned by getProviderIdentifier().
java.lang.String	getProviderType() By default this returns "db".
java.lang.String	getShortLabel() Default implementation of this Displayable method returns the object name.
protected void	openImpl() Subclasses should override this method to customize the open() behavior.
protected void	resetBuffer(SourceObject obj) Aquires the TextBuffer and resets its contents to match the source on the given SourceObject.
protected void	updateSource(SourceObject so, java.lang.String source) Sets the source on the SourceObject.

Methods inherited from class oracle.ide.model.TextNode

acquireTextBuffer, acquireTextBufferInterruptibly, acquireTextBufferOrThrow, addTextBufferListener, addWeakTextBufferListener, closeImpl, createOutputStreamWriter, createReader, facadeBuffer, getInputStream, getInputStream, getLoadEncoding, getReader, getSaveEncoding, getTextBufferDirectly, hasEmptyTextBuffer, isDirty, isReadOnly, markDirty, markDirtyImpl, readUnlock, releaseTextBuffer, removeTextBufferListener, removeWeakTextBufferListener, reportOpenException, revertImpl, saveImpl, setDefaultLineTerminator, setLoadEncoding, setSaveEncoding, tryAcquireTextBuffer, upgradeUnlock, urlReadOnlyChanged, writeUnlock

Methods inherited from class oracle.ide.model.Node

addNodeListener, addNodeListenerForType, addNodeListenerForTypeHierarchy, addWeakNodeListener, attach, beginThreadNodeUsageCycle, callUnderReadLock, callUnderWriteLock, close, createSubject, delete, deleteImpl, detach, endThreadNodeUsage, endThreadNodeUsageCycle, ensureOpen, equalsImpl, getAttributes, getChildren, getData, getLongLabel, getSubject, getTimestamp, getTimestampLoadedUnsafe, getToolTipText, getTransientProperties, getUnmodifiedTimestamp, getURL, isLoaded, isLockHeld, isMigrating, isNew, isOpen, isReadLocked, isReadLockHeld, isReadOrWriteLocked, isTrackedInNodeCache, isTrackingThreadNodeUsage, isWriteLocked, isWriteLockHeld, lockCount, mayHaveChildren, nodeLock, notifyObservers, open, readLock, readLockCount, readLockInterruptibly, refreshTimestamp, removeNodeListener, removeNodeListenerForType, removeNodeListenerForTypeHierarchy, removeWeakNodeListener, rename, renameImpl, revert, runUnderReadLock, runUnderWriteLock, save, setEventLog, setMigrating, setOpen, setReadOnly, setTimestampDirectly, setURL, toString, tryRunUnderReadLock, tryRunUnderWriteLock, unsetMigrating, upgradeLock, writeLock, writeLockCount, writeLockInterruptibly

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.db.model.DBObjectNode

getObjectName, init

Methods inherited from interface oracle.ide.db.model.DBObjectTypeNode

getObjectType, getProviderIdentifier, getSchemaName

Methods inherited from interface oracle.ide.model.Locatable

getURL, setURL

Methods inherited from interface oracle.ide.model.Element

getAttributes, getChildren, getData, mayHaveChildren

Methods inherited from interface oracle.ide.model.Displayable

getAttributedLabel, getLongLabel, getToolTipText, toString

Constructor Detail

BaseDBObjectTextNode

public BaseDBObjectTextNode()

Method Detail

getProviderType

public java.lang.String getProviderType()

By default this returns "db". Override if needed.

Specified by:

getProviderType in interface DBObjectProviderNode

getDBObject

public DBObject getDBObject()

Returns the DBObject for the node. This abstract implementation gets the node from the provider and will therefore hit the database. If possible override in a subclass.

Specified by:

getDBObject in interface DBObjectNode

getProvider

public DBObjectProvider getProvider()

Gets the provider from the DBObjectProviderFactory using the key returned by getProviderIdentifier().

Specified by:

getProvider in interface DBObjectNode

See Also:

DBObjectTypeNode.getProviderIdentifier()

getIcon

public javax.swing.Icon getIcon()

Default implementation of this Displayable method returns the appropriate icon for the object's type.

Specified by:

getIcon in interface Displayable

Overrides:

getIcon in class Node

Returns:

the Icon to be displayed for the Displayable.

getShortLabel

public java.lang.String getShortLabel()

Default implementation of this Displayable method returns the object name.

Specified by:

getShortLabel in interface Displayable

Overrides:

getShortLabel in class Node

Returns:

a short descriptive label of the Displayable that can be shown to the user.

getLine

public int getLine(int offset)

Returns the line number in the TextBuffer for the given offset if it can be found, zero otherwise.

Parameters:

offset - The offset from the start of the TextBuffer

Returns:

The line number

openImpl

protected void openImpl()
                 throws java.io.IOException

Description copied from class: Node

Subclasses should override this method to customize the open() behavior. Node.open() invokes this only if the node is not open, under write lock. The Node implementation does nothing.

Overrides:

openImpl in class TextNode

Throws:

java.io.IOException - if an I/O error occurred while opening

getDBObject

@Deprecated
public final SourceObject getDBObject(boolean fullyBuilt)

Deprecated. Use #getDBObjectFromBuffer

getDBObjectFromBuffer

public final SourceObject getDBObjectFromBuffer()

Return a SourceObject whose source matches the current contents of the TextBuffer.

cancelCurrentBuild

@Deprecated
public final void cancelCurrentBuild()

Deprecated.

findProviderDBObject

protected SourceObject findProviderDBObject()

Returns the instance of the DBbject this node represents that is owned by the provider.

updateSource

protected void updateSource(SourceObject so,
                            java.lang.String source)

Sets the source on the SourceObject.

Parameters:

so - The Source Object

source - The source

resetBuffer

protected void resetBuffer(SourceObject obj)

Aquires the TextBuffer and resets its contents to match the source on the given SourceObject. Called when the object is changed and the Node/TextBuffer must be changed to keep sync.

Parameters:

obj - the object with the correct source that the text buffer should match