| org.sape.carbon.core.config.node |
|
The node package contains the data structure used to hold configuration within
the ConfigurationService. The data structure is a graph
of Nodes. Each Node has some basic functionality
described by the Node interface. There are 3 sub-types of
Node, Folder, LinkNode and
ConfigurationDocument, described by their own interfaces.
Folder objects are responsible for the hierachy of the data
structure. They contain other Nodes.
LinkNodes link to other Nodes either within the
same data store or in a different one.
ConfigurationDocuments contain the configuration data.
There is an abstract class for each of these interfaces. These classes
implement all the required functionality that is not specific to the
underlying data store. They provide method signatures for extending classes
to implement to provide access to specific data sources.
Nodes should only be constructed using a NodeFactory
or a LinkNodeFactory.
|
| Java Source File Name | Type | Comment |
| AbstractConfigurationDocument.java | Class | This implementation of ConfigurationDocument uses a
ConfigurationFormatService to read and write
Configurations from and to the backing data store and
caches the results for future use.
This implementation interfaces with the backing data store via sub-classes
implementing the methods openInputStream and
openOutputStream. |
| AbstractFolder.java | Class | This implementation of the Folder interface caches its
children as they are requested. |
| AbstractNode.java | Class | Abstract implementation of the Node interface. |
| ConfigurationDocument.java | Interface | A ConfigurationDocument is a Node that contains
configuration information. |
| Folder.java | Interface | A Folder is a Node that contains
other Nodes. |
| NestedConfigurationDocument.java | Class | ConfigurationDocument implementation for configurations nested within
other ConfigurationDocuments. |
| NestedConfigurationDocumentFactory.java | Class | Factory for creating NestedConfigurationDocument nodes
Note that this implementation of nested nodes can only be used in
conjunction with nodes that extend the abstract classes found in this
package. |
| Node.java | Interface |
The base interface of all
objects within the ConfigurationService data structure. |
| NodeCreationException.java | Class | Signifies there was a problem creating a Node. |
| NodeException.java | Class | Base exception for all exceptions in the node package. |
| NodeFactory.java | Interface | Factory interface for objects that can construct Nodes. |
| NodeIOException.java | Class | Exception thrown when an Exception is encountered reading from or
writing to a node. |
| NodeNotFoundException.java | Class | Thrown when a requested configuration Node is not found. |
| NodeRemovalException.java | Class | Thrown when a Node could not be removed. |
| NodeRemovedException.java | Class | This exception is thrown by nodes when methods are call upon them after
they have been removed. |