01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16:
17: package org.compass.core.engine.naming;
18:
19: /**
20: * A path representation abstraction. Note, implementations should
21: * take care and override <code>equals</code> and <code>hashCode</code>.
22: *
23: * @author kimchy
24: * @see DynamicPropertyNamingStrategy
25: * @see StaticPropertyNamingStrategy
26: */
27: public interface PropertyPath {
28:
29: /**
30: * Returns the path. Note, the dynamic path construction might occur.
31: */
32: String getPath();
33:
34: /**
35: * Compass path construction process will hint on heavily used path
36: * elements that might be better off made static. The implementation
37: * might decide to create a {@link PropertyPath} implementation that
38: * is more static in nature.
39: */
40: PropertyPath hintStatic();
41: }
|