|
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.basic.BasicUrlFormatter com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
public class SeoUrlFormatter
An UrlFormatter
that parses and formats optimized URLs.
Property Summary | ||
---|---|---|
Property | Type | Default Value |
pathSeparatorToken |
String |
_ (underscore) |
pathKeyValueSeparator |
char |
- (hyphen) |
navStateFormatter |
|
null |
ERecFormatter |
|
null |
aggrERecFormatter |
|
null |
pathParamKeys |
String[] |
null |
urlParamEncoders |
|
null |
navStateCanonicalizer |
|
null |
See properties inherited from BasicUrlFormatter |
Field Summary | |
---|---|
static char |
PATH_SEPARATOR
|
Constructor Summary | |
---|---|
SeoUrlFormatter()
|
Method Summary | |
---|---|
com.endeca.soleng.urlformatter.AggrERecUrlParam |
createAggrERecUrlParam(com.endeca.soleng.urlformatter.UrlState pUrlState,
com.endeca.navigation.AggrERec pAggrERec)
|
com.endeca.soleng.urlformatter.ERecUrlParam |
createERecUrlParam(com.endeca.soleng.urlformatter.UrlState pUrlState,
com.endeca.navigation.ERec pERec)
|
com.endeca.soleng.urlformatter.NavStateUrlParam |
createNavStateUrlParam(com.endeca.soleng.urlformatter.UrlState pUrlState)
|
com.endeca.soleng.urlformatter.UrlParam |
createUrlParam(com.endeca.soleng.urlformatter.UrlState pUrlState,
java.lang.String pKey,
java.lang.String pValue)
|
protected java.lang.String |
formatAggrERec(com.endeca.soleng.urlformatter.UrlState pUrlState)
|
protected java.lang.String |
formatERec(com.endeca.soleng.urlformatter.UrlState pUrlState)
|
protected java.lang.String |
formatNavState(com.endeca.soleng.urlformatter.UrlState pUrlState)
|
protected java.lang.String |
formatPathKeywords(com.endeca.soleng.urlformatter.UrlState pUrlState)
|
protected java.lang.String |
formatPathParams(com.endeca.soleng.urlformatter.UrlState pUrlState)
|
protected java.lang.String |
formatQueryString(com.endeca.soleng.urlformatter.UrlState pUrlState)
|
java.lang.String |
formatUrl(com.endeca.soleng.urlformatter.UrlState pUrlState)
|
AggrERecFormatter |
getAggrERecFormatter()
The AggrERecFormatter used to render aggregate record
attributes to the URL path keywords. |
ERecFormatter |
getERecFormatter()
The ERecFormatter used to render endeca record
attributes to the URL path keywords. |
NavStateCanonicalizer |
getNavStateCanonicalizer()
Returns the canonicalizer used to sort the navigation state before rendering an UrlState . |
NavStateFormatter |
getNavStateFormatter()
The NavStateFormatter property used to render navigation
state information to the URL path keywords. |
char |
getPathKeyValueSeparator()
The character used to separate key/value pairs in the path parameter section of the URL. |
java.lang.String[] |
getPathParamKeys()
The parameter keys that will be appended to the path. |
java.lang.String |
getPathSeparatorToken()
The separator token that is used to separate the misc-path section of the URL from the path parameter section. |
UrlParamEncoder[] |
mUrlParamEncoders()
The UrlParamEncoder objects used by this SeoUrlFormatter . |
protected void |
parsePathInfo(com.endeca.soleng.urlformatter.UrlState pUrlState,
java.lang.String pPathInfo)
|
protected void |
parseQueryString(com.endeca.soleng.urlformatter.UrlState pUrlState,
java.lang.String pQueryString)
|
com.endeca.soleng.urlformatter.UrlState |
parseRequest(javax.servlet.http.HttpServletRequest pRequest)
|
com.endeca.soleng.urlformatter.UrlState |
parseRequest(java.lang.String pQueryString,
java.lang.String pPathInfo,
java.lang.String pCharacterEncoding)
|
void |
setAggrERecFormatter(AggrERecFormatter pAggrERecFormatter)
Sets the aggrERecFormatter property, which is used to render
directory-style (path-encoded) keywords for UrlState objects
containing an Endeca aggregate record. |
void |
setERecFormatter(ERecFormatter pERecFormatter)
Sets the ERecFormatter property, which is used to render
directory-style (path-encoded) keywords for UrlState objects
containing an Endeca record. |
void |
setNavStateCanonicalizer(NavStateCanonicalizer pNavStateCanonicalizer)
Specifies the canonicalizer used to sort the navigation state before rendering an UrlState . |
void |
setNavStateFormatter(NavStateFormatter pNavStateFormatter)
Sets the navStateFormatter property, which is used to render
directory-style (path-encoded) keywords for UrlState objects
containing dimensional navigation state. |
void |
setPathKeyValueSeparator(char pPathKeyValueSeparator)
Specifies the character used to separate key/value pairs in the path parameter section of the URL. |
void |
setPathParamKeys(java.lang.String[] pPathParamKeys)
Specifies the parameter keys that will be appended to the path, rather than the query string, which is the default setting for any given key. |
void |
setPathSeparatorToken(java.lang.String pPathSeparatorToken)
Specifies the separator token that is used to separate the misc-path section of the URL from the path parameter section. |
void |
setUrlParamEncoders(UrlParamEncoder[] pUrlParamEncoders)
Specifies the UrlParamEncoder objects used by this SeoUrlFormatter . |
Methods inherited from class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter |
---|
getAggrERecParamKey, getDefaultEncoding, getERecParamKey, getNavStateParamKey, getPrependQuestionMark, parseRequest, setAggrERecParamKey, setDefaultEncoding, setERecParamKey, setNavStateParamKey, setPrependQuestionMark |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final char PATH_SEPARATOR
Constructor Detail |
---|
public SeoUrlFormatter()
Method Detail |
---|
public java.lang.String getPathSeparatorToken()
public void setPathSeparatorToken(java.lang.String pPathSeparatorToken)
In the following URL, "XX" is the pathSeparatorToken:
http://www.mysite.com/controller/Wine+Type/Sparkling/Blanc+de+Blancs/XX/N-6202
pPathSeparatorToken
- Path separator token to set. Cannot be null.
java.lang.IllegalArgumentException
- if pPathSeparatorToken is null.public char getPathKeyValueSeparator()
public void setPathKeyValueSeparator(char pPathKeyValueSeparator)
In the following URL, '*' is the keyValueSeparator:
http://www.mysite.com/controller/Wine+Type/Sparkling/Blanc+de+Blancs/_/N*6202
pPathKeyValueSeparator
- key value separator. Cannot be null.public NavStateFormatter getNavStateFormatter()
NavStateFormatter
property used to render navigation
state information to the URL path keywords.
public void setNavStateFormatter(NavStateFormatter pNavStateFormatter)
navStateFormatter
property, which is used to render
directory-style (path-encoded) keywords for UrlState
objects
containing dimensional navigation state.
pNavStateFormatter
- object that is used to format the UrlState.SeoNavStateFormatter
public ERecFormatter getERecFormatter()
ERecFormatter
used to render endeca record
attributes to the URL path keywords.
public void setERecFormatter(ERecFormatter pERecFormatter)
ERecFormatter
property, which is used to render
directory-style (path-encoded) keywords for UrlState
objects
containing an Endeca record.
pERecFormatter
- object that is used to format the UrlState.SeoERecFormatter
public AggrERecFormatter getAggrERecFormatter()
AggrERecFormatter
used to render aggregate record
attributes to the URL path keywords.
public void setAggrERecFormatter(AggrERecFormatter pAggrERecFormatter)
aggrERecFormatter
property, which is used to render
directory-style (path-encoded) keywords for UrlState
objects
containing an Endeca aggregate record.
pAggrERecFormatter
- object that is used to format the UrlState.SeoAggrERecFormatter
public java.lang.String[] getPathParamKeys()
public void setPathParamKeys(java.lang.String[] pPathParamKeys)
http://www.mysite.com/controller/Wine-Sparkling-Blanc-de-Blancs/Other-US/_/N-6202+4294963118
If N had not been added to the pathParamKeys, the URL would be output as follows:
http://www.mysite.com/controller/Wine-Sparkling-Blanc-de-Blancs/Other-US?N=6202+4294963118
pPathParamKeys
- Array of keys that will be added to the path, rather than the query string.public UrlParamEncoder[] mUrlParamEncoders()
UrlParamEncoder
objects used by this SeoUrlFormatter
.
public void setUrlParamEncoders(UrlParamEncoder[] pUrlParamEncoders)
UrlParamEncoder
objects used by this SeoUrlFormatter
.
pUrlParamEncoders
- array of encoders that are used to encode various URL parameters.public NavStateCanonicalizer getNavStateCanonicalizer()
UrlState
.
public void setNavStateCanonicalizer(NavStateCanonicalizer pNavStateCanonicalizer)
UrlState
.
pNavStateCanonicalizer
- the NavStateCanonicalizer
class to use.public com.endeca.soleng.urlformatter.UrlState parseRequest(javax.servlet.http.HttpServletRequest pRequest) throws com.endeca.soleng.urlformatter.UrlFormatException
parseRequest
in interface com.endeca.soleng.urlformatter.UrlFormatter
parseRequest
in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
com.endeca.soleng.urlformatter.UrlFormatException
public com.endeca.soleng.urlformatter.UrlState parseRequest(java.lang.String pQueryString, java.lang.String pPathInfo, java.lang.String pCharacterEncoding) throws com.endeca.soleng.urlformatter.UrlFormatException
com.endeca.soleng.urlformatter.UrlFormatException
public java.lang.String formatUrl(com.endeca.soleng.urlformatter.UrlState pUrlState) throws com.endeca.soleng.urlformatter.UrlFormatException
formatUrl
in interface com.endeca.soleng.urlformatter.UrlFormatter
formatUrl
in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
com.endeca.soleng.urlformatter.UrlFormatException
public com.endeca.soleng.urlformatter.UrlParam createUrlParam(com.endeca.soleng.urlformatter.UrlState pUrlState, java.lang.String pKey, java.lang.String pValue)
createUrlParam
in interface com.endeca.soleng.urlformatter.UrlFormatter
createUrlParam
in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
public com.endeca.soleng.urlformatter.ERecUrlParam createERecUrlParam(com.endeca.soleng.urlformatter.UrlState pUrlState, com.endeca.navigation.ERec pERec)
createERecUrlParam
in interface com.endeca.soleng.urlformatter.UrlFormatter
createERecUrlParam
in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
public com.endeca.soleng.urlformatter.AggrERecUrlParam createAggrERecUrlParam(com.endeca.soleng.urlformatter.UrlState pUrlState, com.endeca.navigation.AggrERec pAggrERec)
createAggrERecUrlParam
in interface com.endeca.soleng.urlformatter.UrlFormatter
createAggrERecUrlParam
in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
public com.endeca.soleng.urlformatter.NavStateUrlParam createNavStateUrlParam(com.endeca.soleng.urlformatter.UrlState pUrlState)
createNavStateUrlParam
in interface com.endeca.soleng.urlformatter.UrlFormatter
createNavStateUrlParam
in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter
protected java.lang.String formatPathKeywords(com.endeca.soleng.urlformatter.UrlState pUrlState) throws com.endeca.soleng.urlformatter.UrlFormatException
com.endeca.soleng.urlformatter.UrlFormatException
protected java.lang.String formatNavState(com.endeca.soleng.urlformatter.UrlState pUrlState) throws com.endeca.soleng.urlformatter.UrlFormatException
com.endeca.soleng.urlformatter.UrlFormatException
protected java.lang.String formatERec(com.endeca.soleng.urlformatter.UrlState pUrlState) throws com.endeca.soleng.urlformatter.UrlFormatException
com.endeca.soleng.urlformatter.UrlFormatException
protected java.lang.String formatAggrERec(com.endeca.soleng.urlformatter.UrlState pUrlState) throws com.endeca.soleng.urlformatter.UrlFormatException
com.endeca.soleng.urlformatter.UrlFormatException
protected java.lang.String formatPathParams(com.endeca.soleng.urlformatter.UrlState pUrlState) throws com.endeca.soleng.urlformatter.UrlFormatException
com.endeca.soleng.urlformatter.UrlFormatException
protected java.lang.String formatQueryString(com.endeca.soleng.urlformatter.UrlState pUrlState) throws com.endeca.soleng.urlformatter.UrlFormatException
com.endeca.soleng.urlformatter.UrlFormatException
protected void parsePathInfo(com.endeca.soleng.urlformatter.UrlState pUrlState, java.lang.String pPathInfo) throws com.endeca.soleng.urlformatter.UrlFormatException
com.endeca.soleng.urlformatter.UrlFormatException
protected void parseQueryString(com.endeca.soleng.urlformatter.UrlState pUrlState, java.lang.String pQueryString) throws com.endeca.soleng.urlformatter.UrlFormatException
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