|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.search.query.formhandlers.MapXMLBuilder
public class MapXMLBuilder
This class supports building arbitrarily complex constraints tags in JSP via form handler input tags.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Constructor Summary | |
---|---|
MapXMLBuilder()
|
Method Summary | |
---|---|
java.lang.String |
buildXML(BaseSearchFormHandler pFormHandler,
ClientRequest pClientRequest,
java.lang.String pTagName)
Build the constraints XML and return it as a string. |
protected void |
dumpHashMapMap(java.util.Map pMap,
java.lang.String pIndent)
For debugging, dump the map of tag data using the form handler's logDebug() |
java.lang.String |
getDefaultValue()
Get the default XML value to return from buildXML |
protected BaseSearchFormHandler |
getFormHandler()
Get the form handler invoking buildXML() |
protected java.lang.String |
getTagName()
Get the name of the constraints tag passed to buildXML() |
java.util.Map |
getTags()
Get the map used to store tag creation/value data |
protected java.lang.String |
getWrappedXML(java.lang.String pXML)
Get XML request wrapped with optional wrappingXML. |
java.lang.String |
getWrappingXML()
Get the wrapping XML. |
void |
setDefaultValue(java.lang.String pDefaultValue)
Set the default value to return from buildXML() |
void |
setWrappingXML(java.lang.String pWrappingXML)
Set the wrapping XML. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public MapXMLBuilder()
Method Detail |
---|
public java.lang.String buildXML(BaseSearchFormHandler pFormHandler, ClientRequest pClientRequest, java.lang.String pTagName)
buildXML
in interface XMLBuilder
pFormHandler
- the invoking form handlerpClientRequest
- the client requestpTagName
- the name of the tag into which to put the
constraints.
public java.util.Map getTags()
public java.lang.String getWrappingXML()
getWrappedXML(java.lang.String)
public void setWrappingXML(java.lang.String pWrappingXML)
pWrappingXML
- the wrapping XML or nullgetWrappedXML(java.lang.String)
public void setDefaultValue(java.lang.String pDefaultValue)
pDefaultValue
- the default XML as a stringpublic java.lang.String getDefaultValue()
protected java.lang.String getWrappedXML(java.lang.String pXML)
pXML
- the XML to wrapsetWrappingXML(java.lang.String)
protected BaseSearchFormHandler getFormHandler()
protected java.lang.String getTagName()
protected void dumpHashMapMap(java.util.Map pMap, java.lang.String pIndent)
pMap
- the root level mappIndent
- the indent string or null for top-level map
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |