Package oracle.ide.model

Contains interfaces and classes implementing JDeveloper's data model.

See:
Description

Interface Summary

Attributes
Dependable	Dependable interface.
DependableRecognizer	DependableRecognizer interface.
Dirtyable	Objects that implement the Dirtyable interface indicate that they are able to track their own dirty state.
Displayable	The Displayable interface defines methods that an object must implement in order to be displayed in the various controls used by the IDE.
Element	The Element interface defines the protocol used by the IDE to communicate with data objects in order to display the objects in the UI.
Folder	The Folder interface extends Element by adding methods for managing child Elements contained by the Folder.
LazyLoadable	Elements that should be lazily loaded need to be implement this interface to avoid forcing their loading.
Locatable
LocatableItem	The LocatableItem interface specifies the methods an object needs to support so it can act as a LocatableItem Examples of LocatableItems are bookmarks and to do items.
NodeInfo	An instance of NodeInfo is used to configure a generic node class such as XMLDataNode or XMLDataContainer.
NodeUtil.NodeFilter	A NodeFilter can be passed to the NodeUtil.storeTimestamps(java.util.Map, java.util.Collection) method to control which timestamps are stored.
Observer	Observe interface defines the notification API through which interested observers are notified of subject changes.
PseudoTechnologyCallback	The PseudoTechnologyCallback interface allows clients to register "pseudo-technologies" with the TechnologyRegistry.
SubDirtyable	Objects that implement the SubDirtyable interface indicate that they are to be saved as content of the document that owns them.
Subject	Subject interface defines the API to register observers interested in receiving notifications of subject changes.
SupportsInspection	This is a marker interface which may be used in cooperation with Element implementations that wish to have the properties of their data made available to the Property Inspector.
VetoableSubject	VetoableSubject interface defines the API to register observers interested in receiving notifications of pending subject changes.
VetoObserver	VetoObserver interface defines the notification API through which interested observers are notified of pending subject changes.

Class Summary

Connections	Top level IDE level Connections Node.
ContentFilterFactory
ContentLevel	Warning: this API is still in flux.
ContentLevelFilter	This class is responsible for filtering the breadth-first traversal implemented by the ContentLevel class to provide a virtual representation of each level that differs from its physical representation.
ContentSet	The ContentSet is the fundamental data structure that describes the contents of a Project.
ContentSetFilter	The ChildFilterHelper that implements ContentSet support.
ContentSetHelper	The ContentSetHelper handles adding, restoring content, and removing content from a content set.
ContentSetProvider	Callback class used to configure a Project with a ContentSet.
ContentType	Type-safe enumeration class for document content types related to file extensions, associated by the DefaultRecognizer.
DataContainer
DataList
DataNode
DefaultAttributes	This class encapsulates the notion of attributes, which is a collection of boolean flags.
DefaultContainer	The DefaultContainer class is a default implementation of a Node that implements the Folder interface.
DefaultDirtyable	Default implementation of the Dirtyable interface.
DefaultDisplayable	Default implementation of the Displayable interface.
DefaultElement	DefaultElement is a complete, default implementation of the Element interface.
DefaultFilter	The DefaultFilter class.
DefaultFolder	DefaultFolder is a complete, default implementation of the Folder interface.
DefaultSubDirtyable	Objects that implement the SubDirtyable interface indicate that they want to be saved as content of the document that owns them.
DependableFactory	DependableFactory class.
DependencyConfiguration
DeployableTextNode	Trivial subclass of TextNode that has the ElementAttributes#DEPLYOABLE attribute set.
DocumentInfo	DocumentInfo class.
ElementAttributes	Extends Attributes to focus on the notion of Element attributes.
ElementFactory	The ElementFactory class is responsible for creating intances of Elements.
ElementRecognizer	The ElementRecognizer interface provides the API for recognizing data types from specific object identifiers.
IdeSubject	The IdeSubject class defines the API to register Observers that are interested in receiving notifications of Subject changes.
IdeSystem	This a new class that is under development to replace IdeSystem.
IdeSystemMigrator
IdeTechnologies	The IdeTechnologies class defines the technology keys for the core IDE.
IdeVetoableSubject	The IdeVetoableSubject class is a default implementation of the VetoableSubject interface.
ImageNode	Node subclass for GIF, JPEG, and PNG image files.
MiscellaneousFolder
Node	The Node class is the base class for all document types that need to interact with the IDE framework.
NodeEvent	Event object for the NodeListener callback.
NodeFactory	The NodeFactory class is responsible for creating intances of Node.
NodeIdentityUtils	Suffixs are defined as including the preceeding dot in this class.
NodeListener	Callback interface for Node events.
NodeUtil	Utilities involving Nodes.
ObservableFolder	ObservableFolder is a complete, default implementation of the Folder and Subject interfaces.
OwnerMap
Preferences	This a new class that is under development to replace Preferences.
Project	This class represents a user project in the IDE.
ProjectChangeEvent
ProjectChangeListener
ProjectContent
ProjectMigrator	Project migrator.
ProjectVersion	This class provides a standardized means of storing and retrieving version history information in the project file.
Recognizer	The Recognizer class is the IDE mechanism by which URLs are mapped to Node types.
Reference	The Reference class is used to reference data nodes such as workspaces and projects from their containers.
RelativeDirectoryContextFolder	Folder representing a directory displayed in a navigator.
ResourcePaths	This class holds the Resources content set data.
ResourcePathsMigrator
TechId	The TechId class is a unique identifier for representing a technology in the system.
TechnologyRegistry	The TechnologyRegistry is used to create and look up technologies in the system.
TechnologyScope	The TechnologyScope class is used to group a set of technologies.
TechnologyScopeConfiguration
TextBufferTracker	A tracker of changes to the TextBuffer of a TextNode.
TextNode	The TextNode class extends Nodeand should be used for all objects that can be opened as a text file inside a code editor.
TextNodeHistorian	TextNodeHistorian is a subclass of Historian which has been optimized for working with the TextBuffer storage of a TextNode while taking into account the expected save encoding.
UnrecognizedTextNode	The UnrecognizedTextNode is used for files that are not recognized by the node recognizer system.
UpdateMessage	An UpdateMessage represents the message from a Subject to an Observer about a change that has already happened or, in the case of vetoable updates, a change that is about to happen.
UserPropertiesMigrator	Migrates the Project user properties.
WorkingSet
WorkingSets
Workspace	Workspace represents an Application.
WorkspaceMigrator	Workspace migrator.
Workspaces	This class holds all Workspace objects currently available to the user in the IDE.
XMLDataContainer	The XMLDataContainer is the Node wrapper for a Folder-implementing JavaBean that can be persisted to XML using the XML marshalling framework in oracle.ide.marshal.xml.
XMLDataNode	The XMLDataNode class is the Node wrapper for a JavaBean class that can be persisted to XML using the XML marshalling framework Object2Dom.
XMLDataNode.DataCastPacket	The DataCastPacket class is a data class that is helpful for reducing the number of type-cast operations that need to occur.

Exception Summary

RecognizerException

This is an Exception class that is thrown by a Recognizer when validation fails.

Package oracle.ide.model Description

Contains interfaces and classes implementing JDeveloper's data model. In JDeveloper persistent data, such as projects and java files, are encapsulated by objects implementing the Node or oracle.ide.model.Container interface. Other objects, such as the structure of an xml file, are encapsulated by implementations of the Element or Folder interface. Generally, these structural elements are transient objects that are constantly re-created as the content of the xml file is updated by the user.

Data model classes are oracle.ide.addin.Subjects that can be observed by objects that implement the oracle.ide.addin.Observer interface. In general, changes to the data model should be undoable and delegated from a oracle.ide.addin.View to that view's oracle.ide.addin.Controller. It is the responsability of the Controller to use the oracle.ide.CommandProcessor to execute a oracle.ide.addin.Command implementation that changes the data model, notifies model observers of the change, and has the ability to undo the changes done to the model.

Note from the description above it is the responsability of the object that modifies data to send oracle.ide.addin.UpdateMessage notifications when the data model is changed. This allows batching up data model changes avoiding thus the proliferation of change notification messages. In the framework, the data model is only responsible for maintaining data.

Related Documentation

See Extending JDeveloper Using the Addin API for detailed information.