|
Java URL Optimization API (SEO API) 2.1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
public class SeoNavStateFormatter
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 |
|
empty |
Constructor Summary | |
---|---|
SeoNavStateFormatter()
|
Method Summary | |
---|---|
java.lang.String |
formatNavState(com.endeca.soleng.urlformatter.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 |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SeoNavStateFormatter()
Method Detail |
---|
public boolean getUseDimensionNameAsKey()
DimLocationFormatter
objects should be associated
to this formatter by dimension name or id.
public void setUseDimensionNameAsKey(boolean pUseDimensionNameAsKey)
DimLocationFormatter
objects should be associated
to this formatter by dimension name or id.
pUseDimensionNameAsKey
- flag indicating whether dimension name should be used.SeoDimLocationFormatter.getKey()
,
setDimLocationFormatters(DimLocationFormatter[])
public char getSeparator()
DimLocation
objects.
public void setSeparator(char pSeparator)
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
pSeparator
- the separator character to use.public DimLocationFormatter[] getDimLocationFormatters()
public void setDimLocationFormatters(DimLocationFormatter[] pDimLocationFormatters)
pDimLocationFormatters
- Array of DimLocationFormatter objects used to format the UrlState.public java.lang.String formatNavState(com.endeca.soleng.urlformatter.UrlState pUrlState, com.endeca.navigation.DimLocationList pNavState) throws com.endeca.soleng.urlformatter.UrlFormatException
formatNavState
in interface NavStateFormatter
com.endeca.soleng.urlformatter.UrlFormatException
|
Java URL Optimization API (SEO API) 2.1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@VERSION PRODUCT: Java URL Optimization API (SEO API) (urlFormatterSeo) VERSION: 2.1.0 BUILD: 12010DEV ARCH_OS: n/a DATE: 2010-06-29T04:02:48-0400