Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1)

E13403-03

oracle.ide.model
Class Connections

java.lang.Object
  extended by oracle.ide.model.DefaultDisplayable
      extended by oracle.ide.model.DefaultElement
          extended by oracle.ide.model.DefaultFolder
              extended by oracle.ide.model.Connections
All Implemented Interfaces:
Displayable, Element, Folder, SubDirtyable, Subject, Dirtyable, Copyable

public class Connections
extends DefaultFolder
implements Copyable, SubDirtyable, Subject

Top level IDE level Connections Node. Under this node is where various datastores should be mounted. Examples of these include but are not limited to Database Connections, Oracle SCM Connections, WebDAV Connections, CVS Connections.


Field Summary
static java.lang.String CONNECTIONS
           
 
Fields inherited from class oracle.ide.model.DefaultFolder
_children
 
Constructor Summary
Connections()
          Default constructor.
Connections(Connections otherConnections)
          Copy constructor.
 
Method Summary
 void attach(Observer observer)
          Registers an observer interested in being notified when the internal state of the class implementing the Subject interface changes.
 java.lang.Object copyTo(java.lang.Object object)
          Copies the internal state of this object to the specified copy.
 void detach(Observer observer)
          Unregisters an observer that is not interested anymore in being notified when the internal state of the class implementing the Subject interface changes.
 javax.swing.Icon getIcon()
          Part of Element interface.
 java.lang.String getLongLabel()
          This implementation delegates to DefaultDisplayable.getShortLabel().
 java.lang.String getShortLabel()
          This implementation returns a place-holder String.
 java.lang.String getToolTipText()
          This implementation delegates to DefaultDisplayable.getLongLabel().
 boolean isDirty()
          True if the data in the object has been modified.
 void markDirty(boolean dirty)
          Marks the data with the specified dirty state.
 void notifyObservers(java.lang.Object subject, UpdateMessage change)
          Notifies all observers that the state of the subject has changed.
 void setOwner(Dirtyable owner)
          This method should be called to set the document in which a SubDirtyable implementation will be persisted.
 
Methods inherited from class oracle.ide.model.DefaultFolder
add, canAdd, canRemove, containsChild, copyToImpl, equalsImpl, getChildren, mayHaveChildren, remove, removeAll, size
 
Methods inherited from class oracle.ide.model.DefaultElement
getAttributes, getData
 
Methods inherited from class oracle.ide.model.DefaultDisplayable
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface oracle.ide.model.Element
getAttributes, getData
 
Methods inherited from interface oracle.ide.model.Displayable
toString
 

Field Detail

CONNECTIONS

public static final java.lang.String CONNECTIONS
See Also:
Constant Field Values
Constructor Detail

Connections

public Connections()
Default constructor. Required for JavaBean status.


Connections

public Connections(Connections otherConnections)
Copy constructor.

Method Detail

copyTo

public java.lang.Object copyTo(java.lang.Object object)
Description copied from interface: Copyable
Copies the internal state of this object to the specified copy. If copy is null, then this method should create a new instance of this class and proceed to copy the internal state to the newly created object. Generally, only the persistent state of the object should be copied, but whether or not it is appropriate to copy transient properties is at the discretion of the individual implementor.

Regardless of whether the copy occurs to an existing object or to a newly created object, the return value is object to which this object's state was copied.

There is a standard implementation pattern for the copyTo method that helps avoid problems that arise when a Copyable object is subclassed. The pattern is:


    public Object copyTo( Object target )
    {
      final <this_class> copy =
        target != null ? (<this_class>) target : new <this_class>();
      copyToImpl( copy );
      return copy;
    }

    protected final void copyToImpl( <this_class> copy )
    {
      super.copyToImpl( copy );  //  if necessary
      //  put code here for copying the properties of <this_class>
    }
  
The parameter passed into the copyToImpl method is the same type of this class. The responsibility of copyToImpl is to copy the state of this class through direct access of the fields. The copyToImpl method should not use getters and setters since these may be overridden, causing the state of this class to be incompletely copied.

Specified by:
copyTo in interface Copyable
Parameters:
object - The target object to which the state of this object should be copied. If target is null, then the copyTo method will return a new instance of this class.
Returns:
The object to which the state of this object was copied. If the target was non-null, then the return value is the same as the target object that was passed in; otherwise, the return value is a new instance of this class.

isDirty

public boolean isDirty()
Description copied from interface: Dirtyable
True if the data in the object has been modified.

Specified by:
isDirty in interface Dirtyable
Returns:
true if the data in the object has been modified.

markDirty

public void markDirty(boolean dirty)
Description copied from interface: Dirtyable
Marks the data with the specified dirty state. This method is called markDirty(...) instead of setDirty(...) so that the JavaBeans Introspector will not mistakenly identify "dirty" as a JavaBean property.

Specified by:
markDirty in interface Dirtyable
Parameters:
dirty - If true, sets the object as being dirty; if false, sets the object as being up-to-date.

setOwner

public void setOwner(Dirtyable owner)
Description copied from interface: SubDirtyable
This method should be called to set the document in which a SubDirtyable implementation will be persisted.

Specified by:
setOwner in interface SubDirtyable
Parameters:
owner - The Dirtyable object in which this SubDirtyable will be saved.

getShortLabel

public java.lang.String getShortLabel()
Description copied from class: DefaultDisplayable
This implementation returns a place-holder String.

Specified by:
getShortLabel in interface Displayable
Overrides:
getShortLabel in class DefaultDisplayable
Returns:
a short descriptive label of the Displayable that can be shown to the user.
See Also:
Displayable.getShortLabel()

getLongLabel

public java.lang.String getLongLabel()
Description copied from class: DefaultDisplayable
This implementation delegates to DefaultDisplayable.getShortLabel().

Specified by:
getLongLabel in interface Displayable
Overrides:
getLongLabel in class DefaultDisplayable
Returns:
a long descriptive label of the Displayable that can be shown to the user.
See Also:
Displayable.getLongLabel()

getIcon

public javax.swing.Icon getIcon()
Description copied from class: DefaultFolder
Part of Element interface. The default implementation returns null, which causes a default folder icon to be used.

Specified by:
getIcon in interface Displayable
Overrides:
getIcon in class DefaultFolder
Returns:
the Icon to be displayed for the Displayable.
See Also:
Displayable.getIcon()

getToolTipText

public java.lang.String getToolTipText()
Description copied from class: DefaultDisplayable
This implementation delegates to DefaultDisplayable.getLongLabel().

Specified by:
getToolTipText in interface Displayable
Overrides:
getToolTipText in class DefaultDisplayable
Returns:
the tooltip to show when the mouse pointer pauses over a UI component that represents this Displayable.
See Also:
Displayable.getToolTipText()

attach

public void attach(Observer observer)
Description copied from interface: Subject
Registers an observer interested in being notified when the internal state of the class implementing the Subject interface changes. Implementors should do nothing when the same observer is added more than once.

Specified by:
attach in interface Subject
Parameters:
observer - the Observer interested in change notification messages.

detach

public void detach(Observer observer)
Description copied from interface: Subject
Unregisters an observer that is not interested anymore in being notified when the internal state of the class implementing the Subject interface changes. Implementors should do nothing when the same observer is removed more than once.

Specified by:
detach in interface Subject
Parameters:
observer - the Observer disinterested in change notification messages.

notifyObservers

public void notifyObservers(java.lang.Object subject,
                            UpdateMessage change)
Description copied from interface: Subject
Notifies all observers that the state of the subject has changed.

Specified by:
notifyObservers in interface Subject
Parameters:
subject - the subject whose state has changed.
change - what changed.

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1)

E13403-03

Copyright © 1997, 2009, Oracle. All rights reserved.