-
Notifications
You must be signed in to change notification settings - Fork 169
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
246 additions
and
50 deletions.
There are no files selected for viewing
127 changes: 127 additions & 0 deletions
127
...ingbird-server/src/main/java/com/vaadin/hummingbird/template/model/ModelPathResolver.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| /* | ||
| * Copyright 2000-2016 Vaadin Ltd. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
| * use this file except in compliance with the License. You may obtain a copy of | ||
| * the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations under | ||
| * the License. | ||
| */ | ||
| package com.vaadin.hummingbird.template.model; | ||
|
|
||
| import java.io.Serializable; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import com.vaadin.hummingbird.StateNode; | ||
| import com.vaadin.hummingbird.dom.impl.TemplateElementStateProvider; | ||
| import com.vaadin.hummingbird.nodefeature.ModelMap; | ||
| import com.vaadin.hummingbird.nodefeature.NodeFeature; | ||
|
|
||
| /** | ||
| * Resolver for finding the state node or model map for a given model path. | ||
| */ | ||
| public class ModelPathResolver { | ||
| private static final Pattern DOT_PATTERN = Pattern.compile("\\."); | ||
| private String[] modelPathParts; | ||
|
|
||
| /** | ||
| * Constructs a representation of the given model path. | ||
| * | ||
| * @param modelPath | ||
| * the path, in the format | ||
| * {@literal parent1.parent2.propertyName}. | ||
| */ | ||
| public ModelPathResolver(String modelPath) { | ||
| modelPathParts = DOT_PATTERN.split(modelPath); | ||
| } | ||
|
|
||
| /** | ||
| * Resolves the model path starting from the given stateNode. Returns the | ||
| * {@link ModelMap} which contains the property defined by the path, i.e. | ||
| * uses all parts up until the last "." in the path. | ||
| * | ||
| * @param stateNode | ||
| * the state node to start resolving from | ||
| * @return the model map of the resolved node | ||
| */ | ||
| public ModelMap resolveModelMap(StateNode stateNode) { | ||
| Class<ModelMap> childFeature = ModelMap.class; | ||
| StateNode node = stateNode; | ||
| // The last part is the propertyName | ||
| for (int i = 0; i < modelPathParts.length - 1; i++) { | ||
| node = resolveStateNode(node, modelPathParts[i], childFeature); | ||
| } | ||
| return node.getFeature(childFeature); | ||
| } | ||
|
|
||
| /** | ||
| * Gets the the property name, i.e. the last part of the path. | ||
| * | ||
| * @return the property name | ||
| */ | ||
| public String getPropertyName() { | ||
| return modelPathParts[modelPathParts.length - 1]; | ||
| } | ||
|
|
||
| /** | ||
| * Finds a child node with the given name (one part of a model path) inside | ||
| * the given parent node. | ||
| * <p> | ||
| * Creates a new node with the given feature if no node is found or if a | ||
| * node is found but it does not have the correct feature. | ||
| * | ||
| * @param parentNode | ||
| * The parent state node | ||
| * @param childNodeName | ||
| * The name of the child node | ||
| * @param childFeature | ||
| * The feature to require from the child node | ||
| * @return a state node, old or new, with the required feature | ||
| */ | ||
| public static StateNode resolveStateNode(StateNode parentNode, | ||
| String childNodeName, Class<? extends NodeFeature> childFeature) { | ||
| assert !childNodeName.contains("."); | ||
|
|
||
| ModelMap parentLevel = parentNode.getFeature(ModelMap.class); | ||
| if (parentLevel.hasValue(childNodeName)) { | ||
| Serializable value = parentLevel.getValue(childNodeName); | ||
| if (value instanceof StateNode | ||
| && ((StateNode) value).hasFeature(childFeature)) { | ||
| // reuse old one | ||
| return (StateNode) value; | ||
| } else { | ||
| // just override | ||
| return createSubModel(parentLevel, childNodeName, childFeature); | ||
| } | ||
| } else { | ||
| return createSubModel(parentLevel, childNodeName, childFeature); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Creates a sub model node with the given model feature and attaches it to | ||
| * the parent with the given name. | ||
| * | ||
| * @param parent | ||
| * the parent model map | ||
| * @param propertyName | ||
| * the name to use when attaching | ||
| * @param childFeature | ||
| * the feature (ModelMap or ModelList) to use | ||
| * @return a new state node with the given feature | ||
| */ | ||
| private static StateNode createSubModel(ModelMap parent, | ||
| String propertyName, Class<? extends NodeFeature> childFeature) { | ||
| StateNode node = TemplateElementStateProvider | ||
| .createSubModelNode(childFeature); | ||
| parent.setValue(propertyName, node); | ||
| return node; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
98 changes: 98 additions & 0 deletions
98
...ird-server/src/test/java/com/vaadin/hummingbird/template/model/ModelPathResolverTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /* | ||
| * Copyright 2000-2016 Vaadin Ltd. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
| * use this file except in compliance with the License. You may obtain a copy of | ||
| * the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations under | ||
| * the License. | ||
| */ | ||
| package com.vaadin.hummingbird.template.model; | ||
|
|
||
| import org.junit.Assert; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
|
|
||
| import com.vaadin.hummingbird.StateNode; | ||
| import com.vaadin.hummingbird.dom.impl.TemplateElementStateProvider; | ||
| import com.vaadin.hummingbird.nodefeature.ModelMap; | ||
|
|
||
| public class ModelPathResolverTest { | ||
|
|
||
| StateNode root; | ||
|
|
||
| @Before | ||
| public void setup() { | ||
| root = TemplateElementStateProvider.createRootNode(); | ||
| } | ||
|
|
||
| @Test | ||
| public void resolveEmptyPath() { | ||
| ModelPathResolver resolver = new ModelPathResolver(""); | ||
| ModelMap map = resolver.resolveModelMap(root); | ||
| Assert.assertEquals(root.getFeature(ModelMap.class), map); | ||
| } | ||
|
|
||
| @Test | ||
| public void resolveProperty() { | ||
| ModelPathResolver resolver = new ModelPathResolver("foo"); | ||
| ModelMap map = resolver.resolveModelMap(root); | ||
| Assert.assertEquals(root.getFeature(ModelMap.class), map); | ||
| } | ||
|
|
||
| @Test | ||
| public void resolveSubProperty() { | ||
| ModelMap rootMap = root.getFeature(ModelMap.class); | ||
| Assert.assertFalse(rootMap.hasValue("foo")); | ||
|
|
||
| ModelMap map = new ModelPathResolver("foo.bar").resolveModelMap(root); | ||
| Assert.assertTrue(rootMap.hasValue("foo")); | ||
| ModelMap fooMap = ((StateNode) rootMap.getValue("foo")) | ||
| .getFeature(ModelMap.class); | ||
| Assert.assertEquals(fooMap, map); | ||
| } | ||
|
|
||
| @Test | ||
| public void resolveSubSubProperty() { | ||
| ModelMap map = new ModelPathResolver("foo.bar.baz") | ||
| .resolveModelMap(root); | ||
| ModelMap rootMap = root.getFeature(ModelMap.class); | ||
| ModelMap fooMap = ((StateNode) rootMap.getValue("foo")) | ||
| .getFeature(ModelMap.class); | ||
| ModelMap barMap = ((StateNode) fooMap.getValue("bar")) | ||
| .getFeature(ModelMap.class); | ||
|
|
||
| Assert.assertEquals(barMap, map); | ||
| } | ||
|
|
||
| @Test | ||
| public void propertyNameForEmpty() { | ||
| ModelPathResolver resolver = new ModelPathResolver(""); | ||
| Assert.assertEquals("", resolver.getPropertyName()); | ||
| } | ||
|
|
||
| @Test | ||
| public void propertyNameForProperty() { | ||
| ModelPathResolver resolver = new ModelPathResolver("foo"); | ||
| Assert.assertEquals("foo", resolver.getPropertyName()); | ||
| } | ||
|
|
||
| @Test | ||
| public void propertyNameForSubProperty() { | ||
| ModelPathResolver resolver = new ModelPathResolver("foo.bar"); | ||
| Assert.assertEquals("bar", resolver.getPropertyName()); | ||
| } | ||
|
|
||
| @Test | ||
| public void propertyNameForSubSubProperty() { | ||
| ModelPathResolver resolver = new ModelPathResolver("foo.bar.baz"); | ||
| Assert.assertEquals("baz", resolver.getPropertyName()); | ||
| } | ||
|
|
||
| } |