org.compass.core.engine.naming
Interface PropertyNamingStrategy

All Known Implementing Classes:
DefaultPropertyNamingStrategy, DynamicPropertyNamingStrategy, StaticPropertyNamingStrategy

public interface PropertyNamingStrategy

The property naming strategy that compass will use for hidden properties. Created using PropertyNamingStrategyFactory

Author:
kimchy
See Also:
PropertyNamingStrategyFactory, StaticPropertyNamingStrategy, DynamicPropertyNamingStrategy

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.
 

Method Detail

isInternal

boolean isInternal(String name)
Returns true if the property name is an internal property.

Parameters:
name -
Returns:
true if the name stands for an internal property.

getRootPath

PropertyPath getRootPath()
Returns the root path for hidden properties.

Returns:
The root path for intenral properties.

buildPath

PropertyPath buildPath(PropertyPath root,
                       String name)
Builds the path for a root property, base on the root part and the property name.

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.