Java URL Optimization API (SEO API) 2.1.1
A C D E F G L M N P R S U

A

AggrERecFormatter - Interface in com.endeca.soleng.urlformatter.seo
Interface that specifies the formatting of a UrlState associated with an aggregate record, used by SeoUrlFormatter.

C

canonicalize(NavStateUrlParam) - Method in interface com.endeca.soleng.urlformatter.seo.NavStateCanonicalizer
 
canonicalize(NavStateUrlParam) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
 
com.endeca.soleng.urlformatter.seo - package com.endeca.soleng.urlformatter.seo
Contains the SeoUrlFormatter and its associated classes for configuring and tuning the behavior of this SEO-friendly implementation of the core UrlFormatter interface.
compare(Object, Object) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
 
createAggrERecUrlParam(UrlState, AggrERec) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
createERecUrlParam(UrlState, ERec) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
createNavStateUrlParam(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
createUrlParam(UrlState, String, String) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 

D

decodeValue(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateEncoder
 
decodeValue(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.UrlParamEncoder
 
DimLocationFormatter - Interface in com.endeca.soleng.urlformatter.seo
An extension point used by various SEO URL formatting classes to control the rendering of DimLocation objects into path-encoded keyword strings.

E

encodeValue(UrlState, UrlParam) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateEncoder
 
encodeValue(UrlState, UrlParam) - Method in class com.endeca.soleng.urlformatter.seo.UrlParamEncoder
 
equals(Object) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
 
ERecFormatter - Interface in com.endeca.soleng.urlformatter.seo
Interface that specifies the formatting of a UrlState associated with an Endeca record, aggregated by an SeoUrlFormatter.

F

format(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.LowerCaseStringFormatter
 
format(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
 
format(UrlState, String) - Method in interface com.endeca.soleng.urlformatter.seo.StringFormatter
 
format(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.StringFormatterChain
 
format(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.UpperCaseStringFormatter
 
format(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.UrlEncodedStringFormatter
 
formatAggrERec(UrlState, AggrERec) - Method in interface com.endeca.soleng.urlformatter.seo.AggrERecFormatter
 
formatAggrERec(UrlState, AggrERec) - Method in class com.endeca.soleng.urlformatter.seo.SeoAggrERecFormatter
 
formatAggrERec(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
formatDimLocation(UrlState, DimLocation) - Method in interface com.endeca.soleng.urlformatter.seo.DimLocationFormatter
Formats the specified DimLocation for the specified UrlState.
formatDimLocation(UrlState, DimLocation) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
 
formatERec(UrlState, ERec) - Method in interface com.endeca.soleng.urlformatter.seo.ERecFormatter
 
formatERec(UrlState, ERec) - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
 
formatERec(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
formatNavState(UrlState, DimLocationList) - Method in interface com.endeca.soleng.urlformatter.seo.NavStateFormatter
 
formatNavState(UrlState, DimLocationList) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
 
formatNavState(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
formatPathKeywords(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
formatPathParams(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
formatQueryString(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
formatUrl(UrlState) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 

G

getAggrERecFormatter() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
The AggrERecFormatter used to render aggregate record attributes to the URL path keywords.
getAppendAncestors() - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
Indicates whether or not to append ancestor DimVal names to the URL.
getAppendDescriptor() - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
Indicates whether or not to append the descriptor DimVal name to the URL.
getAppendRoot() - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
Indicates whether or not to append the root DimVal name to the URL.
getAscending() - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
 
getDimLocationFormatters() - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
 
getDimLocationFormatters() - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
The list of DimLocationFormatters that will be used to format the UrlState.
getDimValStringFormatter() - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
The StringFormatter that is used to process the ancestor and descriptor DimVal names.
getERecFormatter() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
The ERecFormatter used to render endeca record attributes to the URL path keywords.
getIgnoreCase() - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
 
getIsPathParam() - Method in interface com.endeca.soleng.urlformatter.seo.SeoUrlParam
 
getKey() - Method in interface com.endeca.soleng.urlformatter.seo.DimLocationFormatter
The dimension name or id used to associate a DimLocationFormatter with a specific dimension.
getKey() - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
The dimension name or id used to associate a DimLocationFormatter with a specific dimension.
getNavStateCanonicalizer() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
Returns the canonicalizer used to sort the navigation state before rendering an UrlState.
getNavStateFormatter() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
The NavStateFormatter property used to render navigation state information to the URL path keywords.
getParamKey() - Method in class com.endeca.soleng.urlformatter.seo.UrlParamEncoder
 
getPathKeyValueSeparator() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
The character used to separate key/value pairs in the path parameter section of the URL.
getPathParamKeys() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
The parameter keys that will be appended to the path.
getPathSeparatorToken() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
The separator token that is used to separate the misc-path section of the URL from the path parameter section.
getPattern() - Method in class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
 
getPropertyFormatter() - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
 
getPropertyKeys() - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
 
getReplaceAll() - Method in class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
 
getReplacement() - Method in class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
 
getRootStringFormatter() - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
The StringFormatter that is used to process the root DimVal name.
getSeparator() - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
The separator character that is used to separate root, ancestor, and descriptor DimVal names.
getSeparator() - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
The separator character that is used to separate fully formatted DimLocation objects.
getSortByDimension() - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
 
getSortByName() - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
 
getStringFormatters() - Method in class com.endeca.soleng.urlformatter.seo.StringFormatterChain
 
getUrlParamEncoder() - Method in interface com.endeca.soleng.urlformatter.seo.SeoUrlParam
 
getUseDimensionNameAsKey() - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
Indicates whether DimLocationFormatter objects should be associated to this formatter by dimension name or id.
getUseDimensionNameAsKey() - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
Indicates whether DimLocationFormatter objects should be associated to this formatter by dimension name or id.

L

LowerCaseStringFormatter - Class in com.endeca.soleng.urlformatter.seo
A StringFormatter that formats strings to lower case.
LowerCaseStringFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.LowerCaseStringFormatter
 

M

mUrlParamEncoders() - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
The UrlParamEncoder objects used by this SeoUrlFormatter.

N

NavStateCanonicalizer - Interface in com.endeca.soleng.urlformatter.seo
An interface that specifies canonicalization of a NavStateUrlParam, aggregated by an SeoUrlFormatter.
NavStateFormatter - Interface in com.endeca.soleng.urlformatter.seo
An interface that specifies the formatting of an UrlState associated with a Navigation State, aggregated by an SeoUrlFormatter.

P

parsePathInfo(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
parseQueryString(UrlState, String) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
parseRequest(HttpServletRequest) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
parseRequest(String, String, String) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
PATH_SEPARATOR - Static variable in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 

R

RegexStringFormatter - Class in com.endeca.soleng.urlformatter.seo
A StringFormatter that specifies a regular expression for find/replace manipulations on strings.
RegexStringFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
 

S

SeoAggrERecFormatter - Class in com.endeca.soleng.urlformatter.seo
An ERecFormatter that formats an Aggregate record in SEO Optimized format, by formatting its representative record using the SeoERecFormatter.
SeoAggrERecFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.SeoAggrERecFormatter
 
SeoDimLocationFormatter - Class in com.endeca.soleng.urlformatter.seo
A formatter that generates URL path keywords from a DimLocation object in the order [root][ancestors][descriptor].
SeoDimLocationFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
 
SeoDimLocationFormatter(Object, boolean, boolean, boolean, char) - Constructor for class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
 
SeoERecFormatter - Class in com.endeca.soleng.urlformatter.seo
An ERecFormatter that formats the UrlState associated with an Endecan record in SEO Optimized format, taking into account record Dimension Values and Properties.
SeoERecFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
 
SeoNavStateCanonicalizer - Class in com.endeca.soleng.urlformatter.seo
A class that creates a canonical sort order for a NavStateUrlParam.
SeoNavStateCanonicalizer() - Constructor for class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
 
SeoNavStateEncoder - Class in com.endeca.soleng.urlformatter.seo
Specifies the encoding of a URL parameter, can be aggregated by the SeoUrlFormatter in an UrlParamEncoder[] array using the toString method of the Long class to perform base 36 encoding.
SeoNavStateEncoder() - Constructor for class com.endeca.soleng.urlformatter.seo.SeoNavStateEncoder
 
SeoNavStateFormatter - Class in com.endeca.soleng.urlformatter.seo
A NavStateFormatter that formats an UrlState in SEO Optimized format, formatting each of the the Navigation state's DimLocations with SeoNavStateFormatters.
SeoNavStateFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
 
SeoUrlFormatter - Class in com.endeca.soleng.urlformatter.seo
An UrlFormatter that parses and formats optimized URLs.
SeoUrlFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
 
SeoUrlParam - Interface in com.endeca.soleng.urlformatter.seo
An interface that specifies the storage of an SeoUrlParam.
setAggrERecFormatter(AggrERecFormatter) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
Sets the aggrERecFormatter property, which is used to render directory-style (path-encoded) keywords for UrlState objects containing an Endeca aggregate record.
setAppendAncestors(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
Specifies whether or not to append ancestor DimVal names to the URL.
setAppendDescriptor(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
Specifies whether or not to append the descriptor DimVal name to the URL.
setAppendRoot(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
Specifies whether or not to append the root DimVal name to the URL.
setAscending(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
Specifies whether or not canonicalization is done in ascending or descending order.
setDimLocationFormatters(DimLocationFormatter[]) - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
Specifies a list of DimLocationFormatters that will be used to format the DimLocations in the UrlState.
setDimLocationFormatters(DimLocationFormatter[]) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
Specifies a list of DimLocationFormatters that will be used to format the UrlState.
setDimValStringFormatter(StringFormatter) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
Specifies the StringFormatter that is used to process the ancestor and descriptor DimVal names.
setERecFormatter(ERecFormatter) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
Sets the ERecFormatter property, which is used to render directory-style (path-encoded) keywords for UrlState objects containing an Endeca record.
setIgnoreCase(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
Specifies whether or not canonicalization ignores case.
setKey(Object) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
Specifies the dimension name or id used to associate a DimLocationFormatter with a specific dimension.
setNavStateCanonicalizer(NavStateCanonicalizer) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
Specifies the canonicalizer used to sort the navigation state before rendering an UrlState.
setNavStateFormatter(NavStateFormatter) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
Sets the navStateFormatter property, which is used to render directory-style (path-encoded) keywords for UrlState objects containing dimensional navigation state.
setParamKey(String) - Method in class com.endeca.soleng.urlformatter.seo.UrlParamEncoder
Sets the key of the parameter to encode.
setPathKeyValueSeparator(char) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
Specifies the character used to separate key/value pairs in the path parameter section of the URL.
setPathParamKeys(String[]) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
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.
setPathSeparatorToken(String) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
Specifies the separator token that is used to separate the misc-path section of the URL from the path parameter section.
setPattern(String) - Method in class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
Specifies a pattern to find and replace with the replacement value.
setPropertyFormatter(StringFormatter) - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
Specifies a class that implements StringFormatter to format each of the properties included in the propertyKeys.
setPropertyKeys(String[]) - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
Specifies a list of Record Property keys that will be included in the formatted Url.
setReplaceAll(boolean) - Method in class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
Specifies whether or not all matching patterns will be replaced.
setReplacement(String) - Method in class com.endeca.soleng.urlformatter.seo.RegexStringFormatter
Specifies the replacement value.
setRootStringFormatter(StringFormatter) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
Specifies the StringFormatter that is used to process the root DimVal name.
setSeparator(char) - Method in class com.endeca.soleng.urlformatter.seo.SeoDimLocationFormatter
Specifies the separator character that is used to separate root, ancestor, and descriptor DimVal names.
setSeparator(char) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
Specifies the separator character that is used to separate fully formatted DimLocation objects.
setSortByDimension(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
Specifies canonicalization to be done based on Dimension (rather than DimVal).
setSortByName(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer
Specifies canonicalization to be done based on the name of the dimension/dimval (rather than ID).
setStringFormatters(StringFormatter[]) - Method in class com.endeca.soleng.urlformatter.seo.StringFormatterChain
Specifies an array of StringFormatters to be applied.
setUrlParamEncoders(UrlParamEncoder[]) - Method in class com.endeca.soleng.urlformatter.seo.SeoUrlFormatter
Specifies the UrlParamEncoder objects used by this SeoUrlFormatter.
setUseDimensionNameAsKey(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoERecFormatter
Specifies whether DimLocationFormatter objects should be associated to this formatter by dimension name or id.
setUseDimensionNameAsKey(boolean) - Method in class com.endeca.soleng.urlformatter.seo.SeoNavStateFormatter
Specifies whether DimLocationFormatter objects should be associated to this formatter by dimension name or id.
StringFormatter - Interface in com.endeca.soleng.urlformatter.seo
An interface for string formatting, implementations of which are aggregated by SeoDimLocationFormatter, SeoERecFormatter, SeoAggrERecFormatter, and StringFormatterChain.
StringFormatterChain - Class in com.endeca.soleng.urlformatter.seo
A StringFormatter that aggregates an array of StringFormatter objects, which it uses to apply a series of operations on a string.
StringFormatterChain() - Constructor for class com.endeca.soleng.urlformatter.seo.StringFormatterChain
 

U

UpperCaseStringFormatter - Class in com.endeca.soleng.urlformatter.seo
A StringFormatter that formats strings to upper case.
UpperCaseStringFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.UpperCaseStringFormatter
 
UrlEncodedStringFormatter - Class in com.endeca.soleng.urlformatter.seo
A StringFormatter that URL encodes strings.
UrlEncodedStringFormatter() - Constructor for class com.endeca.soleng.urlformatter.seo.UrlEncodedStringFormatter
 
UrlParamEncoder - Class in com.endeca.soleng.urlformatter.seo
Specifies the encoding of a URL parameter, aggregated by an SeoUrlFormatter in an UrlParamEncoder[] array.
UrlParamEncoder() - Constructor for class com.endeca.soleng.urlformatter.seo.UrlParamEncoder
 

A C D E F G L M N P R S U
Java URL Optimization API (SEO API) 2.1.1

Copyright © 2012 Endeca Technologies, Inc. All Rights Reserved.
@VERSION
PRODUCT: Java URL Optimization API (SEO API) (urlFormatterSeo)
VERSION: 2.1.1
BUILD:   12083DEV
ARCH_OS: n/a
DATE:    2012-02-16T20:40:10-0500