Examples of org.apache.commons.configuration2.SubnodeConfiguration

Package org.apache.commons.configuration2

Examples of org.apache.commons.configuration2.SubnodeConfiguration

org.apache.commons.configuration2.tree.xpath.XPathExpressionEngine

A specialized hierarchical configuration class with a node model that uses a tracked node of another node model as its root node.

Configurations of this type are initialized with a special {@link NodeModel}operating on a specific tracked node of the parent configuration and the corresponding {@link NodeSelector}. All property accessor methods are evaluated relative to this root node. A good use case for a {@code SubnodeConfiguration} is when multiple properties from a specific subtree of the whole configuration need to be accessed. Then a {@code SubnodeConfiguration} can be created with the parent node of theaffected sub tree as root node. This allows for simpler property keys and is also more efficient.

By making use of a tracked node as root node, a {@code SubnodeConfiguration}and its parent configuration initially operate on the same hierarchy of configuration nodes. So if modifications are performed at the subnode configuration, these changes are immediately visible in the parent configuration. Analogously will updates of the parent configuration affect the {@code SubnodeConfiguration} if the sub tree spanned by the{@code SubnodeConfiguration}'s root node is involved.

Note that by making use of a {@code NodeSelector} the{@code SubnodeConfiguration} is not associated with a physical node instance,but the selection criteria stored in the selector are evaluated after each change of the nodes structure. As an example consider that the selector uses a key with an index into a list element, say index 2. Now if an update occurs on the underlying nodes structure which removes the first element in this list structure, the {@code SubnodeConfiguration} still references the elementwith index 2 which is now another one.

There are also possible changes of the underlying nodes structure which completely detach the {@code SubnodeConfiguration} from its parentconfiguration. For instance, the key referenced by the {@code SubnodeConfiguration} could be removed in the parent configuration. Ifthis happens, the {@code SubnodeConfiguration} stays functional; however, itnow operates on a separate node model than its parent configuration. Changes made by one configuration are no longer visible for the other one (as the node models have no longer overlapping nodes, there is no way to have a synchronization here).

When a subnode configuration is created, it inherits the settings of its parent configuration, e.g. some flags like the {@code throwExceptionOnMissing} flag or the settings for handling listdelimiters) or the expression engine. If these settings are changed later in either the subnode or the parent configuration, the changes are not visible for each other. So you could create a subnode configuration, and change its expression engine without affecting the parent configuration.

Because the {@code SubnodeConfiguration} operates on the same nodes structureas its parent it uses the same {@code Synchronizer} instance per default.This means that locks held on one {@code SubnodeConfiguration} also impactthe parent configuration and all of its other {@code SubnodeConfiguration}objects. You should not change this without a good reason! Otherwise, there is the risk of data corruption when multiple threads access these configuration concurrently.

From its purpose this class is quite similar to {@link SubsetConfiguration}. The difference is that a subset configuration of a hierarchical configuration may combine multiple configuration nodes from different sub trees of the configuration, while all nodes in a subnode configuration belong to the same sub tree. If an application can live with this limitation, it is recommended to use this class instead of {@code SubsetConfiguration} because creating asubset configuration is more expensive than creating a subnode configuration.

It is strongly recommended to create {@code SubnodeConfiguration} instancesonly through the {@code configurationAt()} methods of a hierarchicalconfiguration. These methods ensure that all necessary initializations are done. Creating instances manually without doing proper initialization may break some of the functionality provided by this class.
@since 1.3 @version $Id: SubnodeConfiguration.java 1624601 2014-09-12 18:04:36Z oheger $

            catch (ConfigurationRuntimeException iex)
            {
                // the passed in key does not map to exactly one node
                // obtain the node for the section, create it on demand
                InMemoryNodeModel parentModel = getSubConfigurationParentModel();
                NodeSelector selector = parentModel.trackChildNodeWithCreation(null, name, this);
                return createSubConfigurationForTrackedNode(selector, this);
            }
        }
    }

View Full Code Here

     * @return the sub configuration for the global section
     */
    private SubnodeConfiguration getGlobalSection()
    {
        InMemoryNodeModel parentModel = getSubConfigurationParentModel();
        NodeSelector selector = new NodeSelector(null); // selects parent
        parentModel.trackNode(selector, this);
        GlobalSectionNodeModel model =
                new GlobalSectionNodeModel(this, selector);
        SubnodeConfiguration sub = new SubnodeConfiguration(this, model);
        initSubConfigurationForThisParent(sub);

View Full Code Here

        x1.addProperty("key2", "value2");
        x1.addProperty("key2[@override]", "USER2");
        XMLConfiguration x2 = new XMLConfiguration();
        x2.addProperty("key2", "value2.2");
        x2.addProperty("key2[@override]", "USER2");
        config.setNodeCombiner(new OverrideCombiner());
        config.addConfiguration(x2);
        config.addConfiguration(x1);
        XMLConfiguration x3 = new XMLConfiguration(config);
        assertEquals("Wrong element value", "value2.2", x3.getString("key2"));
        assertEquals("Wrong attribute value", "USER2",

View Full Code Here

     */
    private TrackedNodeModel setUpTrackedModel(NodeSelector selector)
    {
        InMemoryNodeModel parentModel = (InMemoryNodeModel) parent.getModel();
        parentModel.trackNode(selector, parent);
        return new TrackedNodeModel(parent, selector, true);
    }

View Full Code Here

    public void testClone()
    {
        setUpSubnodeConfig();
        SubnodeConfiguration copy = (SubnodeConfiguration) config.clone();
        assertNotSame("Same model", config.getModel(), copy.getModel());
        TrackedNodeModel subModel = (TrackedNodeModel) copy.getModel();
        assertEquals("Wrong selector", SELECTOR, subModel.getSelector());
        InMemoryNodeModel parentModel = (InMemoryNodeModel) parent.getModel();
        assertEquals("Wrong parent model", parentModel,
                subModel.getParentModel());


        // Check whether the track count was increased
        parentModel.untrackNode(SELECTOR);
        parentModel.untrackNode(SELECTOR);
        assertTrue("Wrong finalize flag",
                subModel.isReleaseTrackedNodeOnFinalize());
    }

View Full Code Here

     * Tests whether the configuration can be closed.
     */
    @Test
    public void testClose()
    {
        TrackedNodeModel model = EasyMock.createMock(TrackedNodeModel.class);
        EasyMock.expect(model.getSelector()).andReturn(SELECTOR).anyTimes();
        model.close();
        EasyMock.replay(model);


        SubnodeConfiguration config = new SubnodeConfiguration(parent, model);
        config.close();
        EasyMock.verify(model);

View Full Code Here

     * Tests if setting a node combiner causes an invalidation.
     */
    @Test
    public void testSetNodeCombiner()
    {
        NodeCombiner combiner = new UnionCombiner();
        config.setNodeCombiner(combiner);
        assertSame("Node combiner was not set", combiner, config
                .getNodeCombiner());
        listener.checkEvent(1, 0);
    }

View Full Code Here

     */
    @Test
    public void testSetNodeCombinerSynchronized()
    {
        SynchronizerTestImpl sync = setUpSynchronizerTest();
        config.setNodeCombiner(new UnionCombiner());
        sync.verify(Methods.BEGIN_WRITE, Methods.END_WRITE);
        checkCombinedRootNotConstructed();
    }

View Full Code Here

     * Tests changing the expression engine.
     */
    @Test
    public void testSetExpressionEngine()
    {
        parent.setExpressionEngine(new XPathExpressionEngine());
        setUpSubnodeConfig("tables/table[1]");
        assertEquals("Wrong field name", NodeStructureHelper.field(0, 1),
                config.getString("fields/field[2]/name"));
        Set<String> keys = ConfigurationAssert.keysToSet(config);
        assertEquals("Wrong number of keys", 2, keys.size());

View Full Code Here

     */
    @Test
    public void testParentChangeDetatchException()
    {
        setUpSubnodeConfig();
        parent.setExpressionEngine(new XPathExpressionEngine());
        parent.addProperty("newProp", "value");
        checkSubConfigContent();
    }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.apache.commons.configuration2.SubnodeConfiguration

com.mockobjects.servlet.MockHttpServletRequest

com.mockobjects.servlet.MockServletConfig

org.apache.commons.beanutils.DynaProperty

org.apache.commons.configuration2.AbstractConfiguration

org.apache.commons.configuration2.BaseConfiguration

org.apache.commons.configuration2.BaseHierarchicalConfiguration

org.apache.commons.configuration2.BaseHierarchicalConfiguration$BuilderVisitor

org.apache.commons.configuration2.beanutils.BeanHelper

org.apache.commons.configuration2.beanutils.ConfigurationDynaBean

org.apache.commons.configuration2.beanutils.XMLBeanDeclaration

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.