org.compass.core.engine.naming
Class DefaultPropertyNamingStrategy

java.lang.Object
  extended by org.compass.core.engine.naming.DefaultPropertyNamingStrategy
All Implemented Interfaces:
PropertyNamingStrategy

public class DefaultPropertyNamingStrategy
extends Object
implements PropertyNamingStrategy

A naming strategy that uses DefaultPropertyPath when building PropertyPath.

Author:
kimchy, lexi
See Also:
PropertyPath, DefaultPropertyPath, PropertyNamingStrategyFactory, DefaultPropertyNamingStrategyFactory

Constructor Summary
DefaultPropertyNamingStrategy()
           
 
Method Summary
 PropertyPath buildPath(PropertyPath root, String name)
          Builds the path for a root property, base on the root part and the property name.
 PropertyPath getRootPath()
          Returns the root path for hidden properties.
 boolean isInternal(String name)
          Returns true if the property name is an internal property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultPropertyNamingStrategy

public DefaultPropertyNamingStrategy()
Method Detail

isInternal

public boolean isInternal(String name)
Description copied from interface: PropertyNamingStrategy
Returns true if the property name is an internal property.

Specified by:
isInternal in interface PropertyNamingStrategy
Returns:
true if the name stands for an internal property.

getRootPath

public PropertyPath getRootPath()
Description copied from interface: PropertyNamingStrategy
Returns the root path for hidden properties.

Specified by:
getRootPath in interface PropertyNamingStrategy
Returns:
The root path for intenral properties.

buildPath

public PropertyPath buildPath(PropertyPath root,
                              String name)
Description copied from interface: PropertyNamingStrategy
Builds the path for a root property, base on the root part and the property name.

Specified by:
buildPath in interface PropertyNamingStrategy
Parameters:
root - The root path to build the path from
name - The name to add to the path
Returns:
The generated path from the root and the name


Copyright (c) 2004-2009 The Compass Project.