|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.droplet.EmptyFormHandler atg.droplet.GenericFormHandler atg.search.query.formhandlers.BaseSearchFormHandler atg.search.query.formhandlers.StructuredQueryFormHandler
public class StructuredQueryFormHandler
This form handler issues requests using the <structquery> tag
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
Fields inherited from class atg.search.query.formhandlers.BaseSearchFormHandler |
---|
DEFAULT_ANONYMOUS_USERNAME, DEFAULT_SITE_NAME |
Fields inherited from class atg.droplet.GenericFormHandler |
---|
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
StructuredQueryFormHandler()
|
Method Summary | |
---|---|
protected ClientRequest |
createClientRequest(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Creates and initializes the ClientRequest for this form handler, which is of type ClientStructuredRequest. |
protected SearchMessage |
createSearchMessage(ClientRequest pQueryRequest,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Create the JMS message to represent a ClientStructuredRequest and associated response data. |
protected ClientStructuredRequest |
getClientStructuredRequest()
A convenience method to get the request object as the specific type for this request |
StructuredStatement |
getStatement(int pIndex)
Get a StructuredStatement at specified index, if one does not yet exist, create it and return it. |
protected StructuredStatement[] |
getStructuredStatements()
Return an array of structured statements |
protected DocumentSetConstraint |
getWeightedProps()
Get the <weightedProps> tag contents as a DocumentSetConstraint object. |
XMLBuilder |
getWeightedPropsXMLBuilder()
Get optional <weightedProps> XMLBuilder object. |
protected void |
prepareClientRequest(DynamoHttpServletRequest pDynamoHttpServletRequest)
Overrides method in parent class, first calls parent method to set common request attributes/properties, then sets request specific weightedProperties and statments values into request. |
void |
setStatement(int pIndex,
StructuredStatement pStatement)
Set a StructuredStatement a specified index. |
void |
setWeightedPropsXMLBuilder(XMLBuilder pWeightedPropsBuilder)
Set an optional <weightedProps> XMLBuilder object. |
Methods inherited from class atg.droplet.EmptyFormHandler |
---|
afterGet |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
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 StructuredQueryFormHandler()
Method Detail |
---|
public void setWeightedPropsXMLBuilder(XMLBuilder pWeightedPropsBuilder)
pWeightedPropsBuilder
- the <weightedProps>
constraints builder or nullgetWeightedProps()
public XMLBuilder getWeightedPropsXMLBuilder()
getWeightedProps()
protected DocumentSetConstraint getWeightedProps()
XMLBuilder
,
MapXMLBuilder
protected ClientRequest createClientRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
createClientRequest
in class BaseSearchFormHandler
pRequest
- the dynamo requestpResponse
- the dynamo response
public StructuredStatement getStatement(int pIndex)
pIndex
- the statement index
public void setStatement(int pIndex, StructuredStatement pStatement)
pIndex
- the indexpStatement
- the statement to addprotected void prepareClientRequest(DynamoHttpServletRequest pDynamoHttpServletRequest)
prepareClientRequest
in class BaseSearchFormHandler
pDynamoHttpServletRequest
- DynamoHttpServletRequestprotected StructuredStatement[] getStructuredStatements()
protected SearchMessage createSearchMessage(ClientRequest pQueryRequest, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
createSearchMessage
in class BaseSearchFormHandler
pQueryRequest
- the client requestpRequest
- the Dynamo http requestpResponse
- the Dynamo http response
protected ClientStructuredRequest getClientStructuredRequest()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |