View Javadoc

1   /*
2    * ModeShape (http://www.modeshape.org)
3    * See the COPYRIGHT.txt file distributed with this work for information
4    * regarding copyright ownership.  Some portions may be licensed
5    * to Red Hat, Inc. under one or more contributor license agreements.
6    * See the AUTHORS.txt file in the distribution for a full listing of 
7    * individual contributors.
8    *
9    * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10   * is licensed to you under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation; either version 2.1 of
12   * the License, or (at your option) any later version.
13   * 
14   * ModeShape is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17   * Lesser General Public License for more details.
18   *
19   * You should have received a copy of the GNU Lesser General Public
20   * License along with this software; if not, write to the Free
21   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23   */
24  package org.modeshape.graph.query.model;
25  
26  import net.jcip.annotations.Immutable;
27  import org.modeshape.common.util.CheckArg;
28  import org.modeshape.common.util.HashCode;
29  
30  /**
31   * A constraint requiring that the selected node is a child of the node reachable by the supplied absolute path
32   */
33  @Immutable
34  public class ChildNode implements Constraint {
35      private static final long serialVersionUID = 1L;
36  
37      private final SelectorName selectorName;
38      private final String parentPath;
39      private final int hc;
40  
41      /**
42       * Create a constraint requiring that the node identified by the selector is a child of the node reachable by the supplied
43       * absolute path.
44       * 
45       * @param selectorName the name of the selector
46       * @param parentPath the absolute path to the parent
47       */
48      public ChildNode( SelectorName selectorName,
49                        String parentPath ) {
50          CheckArg.isNotNull(selectorName, "selectorName");
51          CheckArg.isNotNull(parentPath, "parentPath");
52          this.selectorName = selectorName;
53          this.parentPath = parentPath;
54          this.hc = HashCode.compute(this.selectorName, this.parentPath);
55      }
56  
57      /**
58       * Get the name of the selector representing the child
59       * 
60       * @return the selector name; never null
61       */
62      public final SelectorName selectorName() {
63          return selectorName;
64      }
65  
66      /**
67       * Get the path of the parent.
68       * 
69       * @return the parent path; never null
70       */
71      public final String parentPath() {
72          return parentPath;
73      }
74  
75      /**
76       * {@inheritDoc}
77       * 
78       * @see java.lang.Object#toString()
79       */
80      @Override
81      public String toString() {
82          return Visitors.readable(this);
83      }
84  
85      /**
86       * {@inheritDoc}
87       * 
88       * @see java.lang.Object#hashCode()
89       */
90      @Override
91      public int hashCode() {
92          return hc;
93      }
94  
95      /**
96       * {@inheritDoc}
97       * 
98       * @see java.lang.Object#equals(java.lang.Object)
99       */
100     @Override
101     public boolean equals( Object obj ) {
102         if (obj == this) return true;
103         if (obj instanceof ChildNode) {
104             ChildNode that = (ChildNode)obj;
105             if (this.hc != that.hc) return false;
106             if (!this.selectorName.equals(that.selectorName)) return false;
107             if (!this.parentPath.equals(that.parentPath)) return false;
108             return true;
109         }
110         return false;
111     }
112 
113     /**
114      * {@inheritDoc}
115      * 
116      * @see org.modeshape.graph.query.model.Visitable#accept(org.modeshape.graph.query.model.Visitor)
117      */
118     public void accept( Visitor visitor ) {
119         visitor.visit(this);
120     }
121 }