com.endeca.soleng.urlformatter.seo

Class SeoNavStateFormatter

java.lang.Object

com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter

All Implemented Interfaces:

NavStateFormatter

public class SeoNavStateFormatter
extends Object
implements NavStateFormatter

A NavStateFormatter that formats an UrlState in SEO Optimized format, formatting each of the the Navigation state's DimLocations with SeoNavStateFormatters. NavStateFormatter is aggregated by the SeoUrlFormatter class.

Property Summary
Property	Type	Default Value
useDimensionNameAsKey	boolean	false
separator	char	/
dimLocationFormatters	DimLocationFormatter[]	empty

Constructor Summary

Constructors

Constructor and Description
SeoNavStateFormatter()

Method Summary

Modifier and Type	Method and Description
SeoNavStateFormatter	clone() Makes a shallow copy of the SeoNavStateFormatter.
String	formatNavState(UrlState pUrlState, com.endeca.navigation.DimLocationList pNavState)
DimLocationFormatter[]	getDimLocationFormatters() The list of DimLocationFormatters that will be used to format the UrlState.
char	getSeparator() The separator character that is used to separate fully formatted DimLocation objects.
boolean	getUseDimensionNameAsKey() Indicates whether DimLocationFormatter objects should be associated to this formatter by dimension name or id.
void	setDimLocationFormatters(DimLocationFormatter[] pDimLocationFormatters) Specifies a list of DimLocationFormatters that will be used to format the UrlState.
void	setSeparator(char pSeparator) Specifies the separator character that is used to separate fully formatted DimLocation objects.
void	setUseDimensionNameAsKey(boolean pUseDimensionNameAsKey) Specifies whether DimLocationFormatter objects should be associated to this formatter by dimension name or id.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SeoNavStateFormatter

public SeoNavStateFormatter()

Method Detail

getUseDimensionNameAsKey

public boolean getUseDimensionNameAsKey()

Indicates whether DimLocationFormatter objects should be associated to this formatter by dimension name or id.

setUseDimensionNameAsKey

public void setUseDimensionNameAsKey(boolean pUseDimensionNameAsKey)

Specifies whether DimLocationFormatter objects should be associated to this formatter by dimension name or id.

Parameters:

pUseDimensionNameAsKey - flag indicating whether dimension name should be used.

See Also:

SeoDimLocationFormatter.getKey(), setDimLocationFormatters(DimLocationFormatter[])

getSeparator

public char getSeparator()

The separator character that is used to separate fully formatted DimLocation objects.

setSeparator

public void setSeparator(char pSeparator)

Specifies the separator character that is used to separate fully formatted DimLocation objects.

In the following example, '+' is the separator character:

  http://wines.endeca.com/browse/New-Zealand+Wine-Type-White-Sauvignon-Blanc+Cloudy-Bay/_/N-1z141hbZ66sZ1z1413q
 

Parameters:

pSeparator - the separator character to use.

getDimLocationFormatters

public DimLocationFormatter[] getDimLocationFormatters()

The list of DimLocationFormatters that will be used to format the UrlState. Each DimLocationFormatter will specify one particular DimLocation's formatting in the URL.

setDimLocationFormatters

public void setDimLocationFormatters(DimLocationFormatter[] pDimLocationFormatters)

Specifies a list of DimLocationFormatters that will be used to format the UrlState. Each DimLocationFormatter will specify one particular DimLocation's formatting in the URL.

Parameters:

pDimLocationFormatters - Array of DimLocationFormatter objects used to format the UrlState.

formatNavState

public String formatNavState(UrlState pUrlState,
                             com.endeca.navigation.DimLocationList pNavState)
                      throws UrlFormatException

Specified by:

formatNavState in interface NavStateFormatter

Throws:

UrlFormatException

clone

public SeoNavStateFormatter clone()

Makes a shallow copy of the SeoNavStateFormatter.

Overrides:

clone in class Object

Returns:

a shallow copy of the SeoNavStateFormatter.