com.endeca.soleng.urlformatter.seo
Interface DimLocationFormatter

All Known Implementing Classes:

SeoDimLocationFormatter

public interface DimLocationFormatter

An extension point used by various SEO URL formatting classes to control the rendering of DimLocation objects into path-encoded keyword strings.

See Also:

SeoNavStateFormatter.setDimLocationFormatters(DimLocationFormatter[]), SeoERecFormatter.setDimLocationFormatters(DimLocationFormatter[])

Method Summary

java.lang.String	formatDimLocation(com.endeca.soleng.urlformatter.UrlState pUrlState, com.endeca.navigation.DimLocation pDimLocation) Formats the specified DimLocation for the specified UrlState.
java.lang.Object	getKey() The dimension name or id used to associate a DimLocationFormatter with a specific dimension.

Method Detail

getKey

java.lang.Object getKey()

The dimension name or id used to associate a DimLocationFormatter with a specific dimension.

Returns:

the dimension name or id (a String or Long respectively)

See Also:

SeoNavStateFormatter.setUseDimensionNameAsKey(boolean), SeoERecFormatter.setUseDimensionNameAsKey(boolean)

formatDimLocation

java.lang.String formatDimLocation(com.endeca.soleng.urlformatter.UrlState pUrlState,
                                   com.endeca.navigation.DimLocation pDimLocation)
                                   throws com.endeca.soleng.urlformatter.UrlFormatException

Formats the specified DimLocation for the specified UrlState.

Parameters:

pUrlState - the UrlState that contains the specified DimLocation

pDimLocation - the DimLocation to be formatted

Returns:

a formatted string

Throws:

com.endeca.soleng.urlformatter.UrlFormatException - if the DimLocation cannot be properly formatted