View Javadoc
1   /**
2    * This file Copyright (c) 2011-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.jcr.decoration;
35  
36  import info.magnolia.jcr.wrapper.DelegateNodeWrapper;
37  
38  import javax.jcr.Node;
39  import javax.jcr.NodeIterator;
40  import javax.jcr.Property;
41  import javax.jcr.PropertyIterator;
42  import javax.jcr.Session;
43  import javax.jcr.Workspace;
44  import javax.jcr.version.Version;
45  import javax.jcr.version.VersionHistory;
46  import javax.jcr.version.VersionIterator;
47  import javax.jcr.version.VersionManager;
48  
49  /**
50   * Abstract implementation of {@link ContentDecorator} that filters out nothing and wraps everything to carry the
51   * decoration to the entire graph.
52   */
53  public abstract class AbstractContentDecorator implements ContentDecorator {
54  
55      @Override
56      public Session wrapSession(Session session) {
57          return new ContentDecoratorSessionWrapper(session, this);
58      }
59  
60      @Override
61      public Workspace wrapWorkspace(Workspace workspace) {
62          return new ContentDecoratorWorkspaceWrapper(workspace, this);
63      }
64  
65      @Override
66      public Node wrapNode(Node node) {
67          return new ContentDecoratorNodeWrapper(node, this);
68      }
69  
70      @Override
71      public NodeIterator wrapNodeIterator(NodeIterator nodeIterator) {
72          return new ContentDecoratorNodeIterator(nodeIterator, this);
73      }
74  
75      @Override
76      public boolean evaluateNode(Node node) {
77          return true;
78      }
79  
80      @Override
81      public Property wrapProperty(Property property) {
82          return new ContentDecoratorPropertyWrapper(property, this);
83      }
84  
85      @Override
86      public PropertyIterator wrapPropertyIterator(PropertyIterator propertyIterator) {
87          return new ContentDecoratorPropertyIterator(propertyIterator, this);
88      }
89  
90      @Override
91      public boolean evaluateProperty(Property property) {
92          return true;
93      }
94  
95      @Override
96      public Version wrapVersion(Version version) {
97          return new ContentDecoratorVersionWrapper(version, this);
98      }
99  
100     @Override
101     public VersionIterator wrapVersionIterator(VersionIterator versionIterator) {
102         return new ContentDecoratorVersionIterator(versionIterator, this);
103     }
104 
105     @Override
106     public VersionHistory wrapVersionHistory(VersionHistory versionHistory) {
107         return new ContentDecoratorVersionHistoryWrapper(versionHistory, this);
108     }
109 
110     @Override
111     public VersionManager wrapVersionManager(VersionManager versionManager) {
112         return new ContentDecoratorVersionManagerWrapper(versionManager, this);
113     }
114 
115     /**
116      * Check if node is decorated by this class. Subclasses are not taken into account.
117      */
118     protected boolean isDecorating(Node node) {
119         if (node instanceof ContentDecoratorNodeWrappera/jcr/decoration/ContentDecoratorNodeWrapper.html#ContentDecoratorNodeWrapper">ContentDecoratorNodeWrapper && ((ContentDecoratorNodeWrapper) node).getContentDecorator().getClass().equals(this.getClass())) {
120             return true;
121         }
122         if (node instanceof DelegateNodeWrapper) {
123             return isDecorating(((DelegateNodeWrapper) node).getWrappedNode());
124         }
125         return false;
126     }
127 }