A B C E F G I N P Q R S T U

A

addParamBinding(BasicQueryBuilder.ParamBinding) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

AggrERecUrlParam - Interface in com.endeca.soleng.urlformatter

An interface used internally by an UrlState to store an AggrERec for aggregate record detail page links.

B

BasicQueryBuilder - Class in com.endeca.soleng.urlformatter.basic

A QueryBuilder, used to create an UrlENEQuery from a UrlState object.

BasicQueryBuilder() - Constructor for class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

BasicQueryBuilder.ParamBinding - Class in com.endeca.soleng.urlformatter.basic

Used by the BasicQueryBuilder class to bind parameters to the UrlENEQuery.

BasicQueryBuilder.ParamBinding() - Constructor for class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder.ParamBinding

BasicUrlFormatter - Class in com.endeca.soleng.urlformatter.basic

An UrlFormatter that formats traditional Endeca URLs.

BasicUrlFormatter() - Constructor for class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

bind(UrlParam, UrlState, UrlENEQuery) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder.ParamBinding

buildQuery(UrlState) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

buildQuery(UrlState) - Method in interface com.endeca.soleng.urlformatter.QueryBuilder

Marshals the specified UrlState into an ENEQuery.

C

clearNavState() - Method in class com.endeca.soleng.urlformatter.UrlState

Clears any existing navigation state from this UrlState.

clone() - Method in interface com.endeca.soleng.urlformatter.UrlParam

Creates a cloned instance of the parameter.

clone() - Method in class com.endeca.soleng.urlformatter.UrlState

Returns a cloned instance of this UrlState object.

com.endeca.soleng.urlformatter - package com.endeca.soleng.urlformatter

The core of the URL Optimization API containing the fundamental components required for URL manipulation and generation - including the primary UrlState class and its related UrlFormatter and QueryBuilder interfaces.

com.endeca.soleng.urlformatter.basic - package com.endeca.soleng.urlformatter.basic

Contains the BasicUrlFormatter and BasicQueryBuilder classes.

containsAggrERec() - Method in class com.endeca.soleng.urlformatter.UrlState

Returns true if this UrlState contains an AggrERec parameter.

containsERec() - Method in class com.endeca.soleng.urlformatter.UrlState

Returns true if this UrlState contains an ERec parameter.

containsNavState() - Method in class com.endeca.soleng.urlformatter.UrlState

Returns true if this UrlState contains a navigation state parameter.

createAggrERecUrlParam(UrlState, AggrERec) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

createAggrERecUrlParam(UrlState, AggrERec) - Method in interface com.endeca.soleng.urlformatter.UrlFormatter

Creates an URL parameter containing an AggrERec.

createERecUrlParam(UrlState, ERec) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

createERecUrlParam(UrlState, ERec) - Method in interface com.endeca.soleng.urlformatter.UrlFormatter

Creates an URL parameter containing an ERec.

createNavStateUrlParam(UrlState) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

createNavStateUrlParam(UrlState) - Method in interface com.endeca.soleng.urlformatter.UrlFormatter

Creates an URL parameter containing an empty NavState.

createUrlParam(UrlState, String, String) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

createUrlParam(UrlState, String, String) - Method in interface com.endeca.soleng.urlformatter.UrlFormatter

Creates an URL parameter for the specified UrlState.

E

ERecUrlParam - Interface in com.endeca.soleng.urlformatter

An interface used internally by an UrlState to store an ERec for record detail page links.

F

formatUrl(UrlState) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

formatUrl(UrlState) - Method in interface com.endeca.soleng.urlformatter.UrlFormatter

Formats the specified UrlState into an URL string.

G

getAggrERec() - Method in interface com.endeca.soleng.urlformatter.AggrERecUrlParam

The AggrERec contained by this parameter.

getAggrERec() - Method in class com.endeca.soleng.urlformatter.UrlState

Returns the associated AggrERec for this UrlState.

getAggrERecParamKey() - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

getAggrERecParamKey() - Method in interface com.endeca.soleng.urlformatter.UrlFormatter

The parameter key used for aggregate record detail links - typically "A".

getBaseAggrERecUrlENEQuery() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

getBaseERecUrlENEQuery() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

getBaseNavigationUrlENEQuery() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

getBaseUrlENEQuery() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

getDefaultEncoding() - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

Returns the default encoding for this URL formatter.

getDefaultEncoding() - Method in interface com.endeca.soleng.urlformatter.UrlFormatter

Returns the default character encoding that should be used when transforming URLs to and from various string forms.

getDefaultUrlENEQuery() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

getDimLocationList() - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam

Internal method delegated from an UrlState.

getEncodedKey() - Method in interface com.endeca.soleng.urlformatter.UrlParam

The encoded key.

getEncodedValue() - Method in interface com.endeca.soleng.urlformatter.UrlParam

The encoded string value.

getEncoding() - Method in class com.endeca.soleng.urlformatter.UrlState

Returns the character encoding that is used when marshaling parameters and strings contained within this UrlState.

getERec() - Method in interface com.endeca.soleng.urlformatter.ERecUrlParam

The ERec contained by this parameter.

getERec() - Method in class com.endeca.soleng.urlformatter.UrlState

Returns the associated ERec for this UrlState.

getERecParamKey() - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

getERecParamKey() - Method in interface com.endeca.soleng.urlformatter.UrlFormatter

The parameter key used for record detail links - typically "R".

getKey() - Method in interface com.endeca.soleng.urlformatter.UrlParam

The parameter key.

getNavState() - Method in class com.endeca.soleng.urlformatter.UrlState

Returns the navigation state for this UrlState or null if there is no navigation state.

getNavStateParamKey() - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

getNavStateParamKey() - Method in interface com.endeca.soleng.urlformatter.UrlFormatter

The parameter key used for navigation state - typically "N".

getParam(String) - Method in class com.endeca.soleng.urlformatter.UrlState

Returns the value associated with the specified key in the underlying parameter map.

getParamBinding(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

getParamBindings() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

getParameters() - Method in class com.endeca.soleng.urlformatter.UrlState

Returns a collection of all UrlParam mappings contained within this UrlState.

getParamKey() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder.ParamBinding

getPrependQuestionMark() - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

getQueryEncoding() - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

getUrlParam(String) - Method in class com.endeca.soleng.urlformatter.UrlState

Returns the full UrlParam value associated with the specified key in the underlying parameter map.

getValue() - Method in interface com.endeca.soleng.urlformatter.UrlParam

The parameter string value.

I

inform(ENEQueryResults) - Method in class com.endeca.soleng.urlformatter.UrlState

Initializes this UrlState using state from the specified ENEQueryResults.

N

NavStateUrlParam - Interface in com.endeca.soleng.urlformatter

An interface used internally by an UrlState to manage state for navigation pages.

P

parseRequest(HttpServletRequest) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

parseRequest(String, String) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

parseRequest(HttpServletRequest) - Method in interface com.endeca.soleng.urlformatter.UrlFormatter

Parses the specified request into an UrlState.

Q

QueryBuilder - Interface in com.endeca.soleng.urlformatter

An interface that is responsible for marshaling UrlState objects into ENEQuery objects.

QueryBuildException - Exception in com.endeca.soleng.urlformatter

Indicates that an error occurred while marshaling an UrlState into an ENEQuery object.

QueryBuildException() - Constructor for exception com.endeca.soleng.urlformatter.QueryBuildException

Constructs a QueryBuildException with no message or cause.

QueryBuildException(String) - Constructor for exception com.endeca.soleng.urlformatter.QueryBuildException

Constructs a QueryBuildException with the specified message.

QueryBuildException(String, Throwable) - Constructor for exception com.endeca.soleng.urlformatter.QueryBuildException

Constructs a QueryBuildException with the specified message and cause.

QueryBuildException(Throwable) - Constructor for exception com.endeca.soleng.urlformatter.QueryBuildException

Constructs a QueryBuildException with the specified cause.

R

removeDescriptor(DimVal) - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam

Internal method delegated from an UrlState.

removeDescriptor(DimVal, boolean) - Method in class com.endeca.soleng.urlformatter.UrlState

Removes the specifed descriptor DimVal from the current navigation state.

removeNavState() - Method in class com.endeca.soleng.urlformatter.UrlState

Fully removes any navigation state from this UrlState.

removeParam(String) - Method in class com.endeca.soleng.urlformatter.UrlState

Removes any value associated with the specified key from the underlying parameter map.

S

selectAncestor(DimVal, DimVal) - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam

Internal method delegated from an UrlState.

selectAncestor(DimVal, DimVal, boolean) - Method in class com.endeca.soleng.urlformatter.UrlState

Selects an ancestor DimVal for the specified descriptor DimVal.

selectRefinement(Dimension, DimVal) - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam

Internal method delegated from an UrlState.

selectRefinement(DimLocation) - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam

Internal method delegated from an UrlState.

selectRefinement(Dimension, DimVal, boolean) - Method in class com.endeca.soleng.urlformatter.UrlState

Selects a navigation refinement DimVal from the specified refinement Dimension.

selectRefinement(DimLocation, boolean) - Method in class com.endeca.soleng.urlformatter.UrlState

Selects a navigation refinement using a DimLocation object.

setAggrERec(AggrERec) - Method in class com.endeca.soleng.urlformatter.UrlState

Sets the associated AggrERec for this UrlState.

setAggrERecParamKey(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

Sets the AggrERecParamKey.

setBaseAggrERecUrlENEQuery(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

Sets the baseAggrERecUrlENE Query.

setBaseERecUrlENEQuery(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

Sets the baseERecUrlENEQuery.

setBaseNavigationUrlENEQuery(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

Sets the baseNavigationUrlENEQuery.

setBaseUrlENEQuery(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

Sets the baseUrlENEQuery.

setDefaultEncoding(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

Sets the default encoding for this URL formatter.

setDefaultUrlENEQuery(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

Sets the detaultUrlENEQuery.

setDimLocationList(DimLocationList) - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam

Internal method delegated from an UrlState.

setDimLocationList(DimensionList) - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam

Internal method delegated from an UrlState.

setDimLocationList(ERec, DimValList) - Method in interface com.endeca.soleng.urlformatter.NavStateUrlParam

Internal method delegated from an UrlState.

setERec(ERec) - Method in class com.endeca.soleng.urlformatter.UrlState

Sets the associated ERec for this UrlState.

setERecParamKey(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

Sets the ERecParamKey.

setNavState(DimLocationList) - Method in class com.endeca.soleng.urlformatter.UrlState

Sets the navigation state for this UrlState using a DimLocationList.

setNavState(DimensionList) - Method in class com.endeca.soleng.urlformatter.UrlState

Sets the navigation state for this UrlState using a DimensionList.

setNavState(ERec, DimValList) - Method in class com.endeca.soleng.urlformatter.UrlState

Sets the navigation state for this UrlState using an ERec and a DimValList.

setNavStateParamKey(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

Sets the NavStateParamKey.

setParam(String, String) - Method in class com.endeca.soleng.urlformatter.UrlState

Associates the specified value with the specified key in the underlying parameter map.

setParamBindings(BasicQueryBuilder.ParamBinding[]) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

Sets the parameters that, if present in the UrlState, will be set in the query.

setParamKey(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder.ParamBinding

Sets the parameter key to be used by the QueryBuilder object, when it constructs a UrlENEQuery from an UrlState.

setPrependQuestionMark(boolean) - Method in class com.endeca.soleng.urlformatter.basic.BasicUrlFormatter

Determines whether or not question marks will be appended to the Url.

setQueryEncoding(String) - Method in class com.endeca.soleng.urlformatter.basic.BasicQueryBuilder

Sets the encoding for this Query.

T

toString() - Method in class com.endeca.soleng.urlformatter.UrlState

Returns an encoded string representation of this UrlState.

U

UrlFormatException - Exception in com.endeca.soleng.urlformatter

Indicates that an error occurred while formatting an UrlState object into an URL string - or while parsing a request into an UrlState.

UrlFormatException() - Constructor for exception com.endeca.soleng.urlformatter.UrlFormatException

Constructs a UrlFormatException with no message or cause.

UrlFormatException(String) - Constructor for exception com.endeca.soleng.urlformatter.UrlFormatException

Constructs a UrlFormatException with the specified message.

UrlFormatException(String, Throwable) - Constructor for exception com.endeca.soleng.urlformatter.UrlFormatException

Constructs a UrlFormatException with the specified message and cause.

UrlFormatException(Throwable) - Constructor for exception com.endeca.soleng.urlformatter.UrlFormatException

Constructs a UrlFormatException with the specified cause.

UrlFormatter - Interface in com.endeca.soleng.urlformatter

An interface that is responsible for formatting UrlState objects into URL strings.

UrlParam - Interface in com.endeca.soleng.urlformatter

An interface used internally by an UrlState to store a single URL parameter.

UrlState - Class in com.endeca.soleng.urlformatter

An object that represents URL state for a web application request - a central component for this API.

UrlState(UrlFormatter, String) - Constructor for class com.endeca.soleng.urlformatter.UrlState

Constructs an empty UrlState object.

A B C E F G I N P Q R S T U