|
Java URL Optimization API (Core API) 2.1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UrlFormatter
An interface that is responsible for formatting UrlState
objects into URL strings. Implementations are also responsible for
parsing HttpServletRequest
objects into UrlState
objects.
UrlState
Method Summary | |
---|---|
AggrERecUrlParam |
createAggrERecUrlParam(UrlState pUrlState,
com.endeca.navigation.AggrERec pAggrERec)
Creates an URL parameter containing an AggrERec . |
ERecUrlParam |
createERecUrlParam(UrlState pUrlState,
com.endeca.navigation.ERec pERec)
Creates an URL parameter containing an ERec . |
NavStateUrlParam |
createNavStateUrlParam(UrlState pUrlState)
Creates an URL parameter containing an empty NavState . |
UrlParam |
createUrlParam(UrlState pUrlState,
java.lang.String pKey,
java.lang.String pValue)
Creates an URL parameter for the specified UrlState . |
java.lang.String |
formatUrl(UrlState pUrlState)
Formats the specified UrlState into an URL string. |
java.lang.String |
getAggrERecParamKey()
The parameter key used for aggregate record detail links - typically "A". |
java.lang.String |
getDefaultEncoding()
Returns the default character encoding that should be used when transforming URLs to and from various string forms. |
java.lang.String |
getERecParamKey()
The parameter key used for record detail links - typically "R". |
java.lang.String |
getNavStateParamKey()
The parameter key used for navigation state - typically "N". |
UrlState |
parseRequest(javax.servlet.http.HttpServletRequest pRequest)
Parses the specified request into an UrlState . |
Method Detail |
---|
UrlState parseRequest(javax.servlet.http.HttpServletRequest pRequest) throws UrlFormatException
UrlState
.
pRequest
- the request to parse.
UrlFormatException
- if the request cannot be parsed.java.lang.String formatUrl(UrlState pUrlState) throws UrlFormatException
UrlState
into an URL string.
pUrlState
- the UrlState
to format.
UrlFormatException
- if the UrlState
cannot be formatted.java.lang.String getDefaultEncoding()
UrlState
.
UrlState.UrlState(UrlFormatter,String)
UrlParam createUrlParam(UrlState pUrlState, java.lang.String pKey, java.lang.String pValue)
UrlState
. This is
an internal method used by an UrlState
. You shouldn't need to
use this method unless you are implementing a custom UrlFormatter
.
pUrlState
- the UrlState
that will contain the parameter.pKey
- the parameter key.pValue
- the parameter string value (fully decoded).
ERecUrlParam createERecUrlParam(UrlState pUrlState, com.endeca.navigation.ERec pERec)
ERec
. This is
an internal method used by an UrlState
. You shouldn't need to
use this method unless you are implementing a custom UrlFormatter
.
pUrlState
- the UrlState
that will contain the parameter.pERec
- the ERec
to be contained in the UrlState
.
getERecParamKey()
AggrERecUrlParam createAggrERecUrlParam(UrlState pUrlState, com.endeca.navigation.AggrERec pAggrERec)
AggrERec
. This is
an internal method used by an UrlState
. You shouldn't need to
use this method unless you are implementing a custom UrlFormatter
.
pUrlState
- the UrlState
that will contain the parameter.pAggrERec
- the AggrERec
to be contained in the UrlState
.
getAggrERecParamKey()
NavStateUrlParam createNavStateUrlParam(UrlState pUrlState)
NavState
. This is
an internal method used by an UrlState
. You shouldn't need to
use this method unless you are implementing a custom UrlFormatter
.
pUrlState
- the UrlState
that will contain the parameter.
getNavStateParamKey()
java.lang.String getNavStateParamKey()
createNavStateUrlParam(UrlState)
java.lang.String getERecParamKey()
createERecUrlParam(UrlState,com.endeca.navigation.ERec)
java.lang.String getAggrERecParamKey()
createAggrERecUrlParam(UrlState,com.endeca.navigation.AggrERec)
|
Java URL Optimization API (Core 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 (Core API) (urlFormatterCore) VERSION: 2.1.0 BUILD: 12010DEV ARCH_OS: n/a DATE: 2010-06-29T04:02:40-0400