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

Modifier and Type	Method and Description
String	formatDimLocation(UrlState pUrlState, com.endeca.navigation.DimLocation pDimLocation) Formats the specified DimLocation for the specified UrlState.
Object	getKey() The dimension name or id used to associate a DimLocationFormatter with a specific dimension.

Method Detail

getKey

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

String formatDimLocation(UrlState pUrlState,
                         com.endeca.navigation.DimLocation pDimLocation)
                  throws 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:

UrlFormatException - if the DimLocation cannot be properly formatted