|
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 |
java.lang.Object com.endeca.soleng.urlformatter.basic.BasicQueryBuilder
public class BasicQueryBuilder
A QueryBuilder
, used to create an UrlENEQuery from a UrlState object.
Property Summary | ||
---|---|---|
Property | Type | Default Value |
paramBindings |
ParamBinding[] |
{new A(), new Af(),...} |
queryEncoding |
String |
UTF-8 |
baseUrlENEQuery |
String |
null |
baseNavigationUrlENEQuery |
String |
null |
baseErecUrlENEQuery |
String |
null |
baseAggrERecUrlENEQuery |
String |
null |
defaultUrlENEQuery |
String |
null |
Nested Class Summary | |
---|---|
static class |
BasicQueryBuilder.ParamBinding
Used by the BasicQueryBuilder class to bind parameters to the UrlENEQuery. |
Constructor Summary | |
---|---|
BasicQueryBuilder()
|
Method Summary | |
---|---|
void |
addParamBinding(BasicQueryBuilder.ParamBinding pParamBinding)
|
com.endeca.navigation.ENEQuery |
buildQuery(UrlState pUrlState)
Marshals the specified UrlState into an ENEQuery . |
java.lang.String |
getBaseAggrERecUrlENEQuery()
|
java.lang.String |
getBaseERecUrlENEQuery()
|
java.lang.String |
getBaseNavigationUrlENEQuery()
|
java.lang.String |
getBaseUrlENEQuery()
|
java.lang.String |
getDefaultUrlENEQuery()
|
BasicQueryBuilder.ParamBinding |
getParamBinding(java.lang.String pParamKey)
|
BasicQueryBuilder.ParamBinding[] |
getParamBindings()
|
java.lang.String |
getQueryEncoding()
|
void |
setBaseAggrERecUrlENEQuery(java.lang.String pBaseAggrERecUrlENEQuery)
Sets the baseAggrERecUrlENE Query. |
void |
setBaseERecUrlENEQuery(java.lang.String pBaseERecUrlENEQuery)
Sets the baseERecUrlENEQuery. |
void |
setBaseNavigationUrlENEQuery(java.lang.String pBaseNavigationUrlENEQuery)
Sets the baseNavigationUrlENEQuery. |
void |
setBaseUrlENEQuery(java.lang.String pBaseUrlENEQuery)
Sets the baseUrlENEQuery. |
void |
setDefaultUrlENEQuery(java.lang.String pDefaultUrlENEQuery)
Sets the detaultUrlENEQuery. |
void |
setParamBindings(BasicQueryBuilder.ParamBinding[] pParamBindings)
Sets the parameters that, if present in the UrlState, will be set in the query. |
void |
setQueryEncoding(java.lang.String pQueryEncoding)
Sets the encoding for this Query. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BasicQueryBuilder()
Method Detail |
---|
public BasicQueryBuilder.ParamBinding[] getParamBindings()
public void setParamBindings(BasicQueryBuilder.ParamBinding[] pParamBindings)
pParamBindings
- Array of parameters to be set in the query.
If the array is set to {new A(), new An()}, these parameters will be bound
to UrlENEQueries that are generated from UrlStates that are associated with
the "A" parameter or "An" parameter.public void addParamBinding(BasicQueryBuilder.ParamBinding pParamBinding)
public BasicQueryBuilder.ParamBinding getParamBinding(java.lang.String pParamKey)
public java.lang.String getQueryEncoding()
public void setQueryEncoding(java.lang.String pQueryEncoding)
pQueryEncoding
- Encoding to set. Cannot be null.
java.lang.IllegalArgumentException
- if pQueryEncoding is null.public java.lang.String getBaseUrlENEQuery()
public void setBaseUrlENEQuery(java.lang.String pBaseUrlENEQuery)
pBaseUrlENEQuery
- base query to set.public java.lang.String getBaseNavigationUrlENEQuery()
public void setBaseNavigationUrlENEQuery(java.lang.String pBaseNavigationUrlENEQuery)
pBaseNavigationUrlENEQuery
- base navigation query to set.public java.lang.String getBaseERecUrlENEQuery()
public void setBaseERecUrlENEQuery(java.lang.String pBaseERecUrlENEQuery)
pBaseERecUrlENEQuery
- base record UrlENEQuery to set.public java.lang.String getBaseAggrERecUrlENEQuery()
public void setBaseAggrERecUrlENEQuery(java.lang.String pBaseAggrERecUrlENEQuery)
pBaseAggrERecUrlENEQuery
- base aggregate record UrlENEQuery to set.public java.lang.String getDefaultUrlENEQuery()
public void setDefaultUrlENEQuery(java.lang.String pDefaultUrlENEQuery)
pDefaultUrlENEQuery
- default UrlENEQuery to set.public com.endeca.navigation.ENEQuery buildQuery(UrlState pUrlState) throws QueryBuildException
QueryBuilder
UrlState
into an ENEQuery
.
buildQuery
in interface QueryBuilder
pUrlState
- the UrlState
to marshal.
QueryBuildException
- if the UrlState
cannot be
successfully marshaled.
|
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