com.esri.gpt.server.csw.provider3.local
Class QueryResponse

java.lang.Object
  com.esri.gpt.server.csw.provider3.local.DiscoveryAdapter
      com.esri.gpt.server.csw.provider3.local.QueryResponse

All Implemented Interfaces:

IResponseGenerator

public class QueryResponse
extends DiscoveryAdapter
implements IResponseGenerator

Generates a CSW query response.

Applies to the GetRecordById and GetRecords operation response.

Constructor Summary

QueryResponse(OperationContext context)
Default constructor

Method Summary

protected void	appendAtomResultsElement(OperationContext context) Creates and appends the Atom elements to the XML document.
protected PropertyMeaning	appendDiscoveredField(OperationContext context, Element record, Returnable returnable) Creates and appends elements associated with a returnable property to a record element.
protected void	appendDiscoveredRecords(OperationContext context, Document root)
protected void	appendDiscoveredRecords(OperationContext context, Element parent) Creates and appends the discovered record elements to the XML document.
protected void	appendGeometry(Element record, Document responseDom, Envelope env) methods =================================================================
protected void	appendSearchResultsElement(OperationContext context, Element parent) Creates and appends the csw:SearchResults element to the XML document.
void	generateResponse(OperationContext context) Generates the response.
Document	newResponseDom(OperationContext context)
Element	newResponseDom(OperationContext context, String rootName) Creates a new XML document for response construction.

Methods inherited from class com.esri.gpt.server.csw.provider3.local.DiscoveryAdapter

getDiscoveryContext, parsePropertyName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryResponse

public QueryResponse(OperationContext context)

Default constructor

Method Detail

appendGeometry

protected void appendGeometry(Element record,
                              Document responseDom,
                              Envelope env)

methods =================================================================

appendDiscoveredField

protected PropertyMeaning appendDiscoveredField(OperationContext context,
                                                Element record,
                                                Returnable returnable)

Creates and appends elements associated with a returnable property to a record element.

Parameters:

context - the operation context

record - the parent element that will hold the fields (a Record)

returnable - the returnable property

Returns:

property meaning of the added element or null if element not added

appendDiscoveredRecords

protected void appendDiscoveredRecords(OperationContext context,
                                       Element parent)
                                throws Exception

Creates and appends the discovered record elements to the XML document.
Applies to csw:GetRecordByIdResponse and csw:GetRecordsResponse.

Parameters:

context - the operation context

parent - the parent element that will hold the records

Throws:

Exception

appendSearchResultsElement

protected void appendSearchResultsElement(OperationContext context,
                                          Element parent)
                                   throws Exception

Creates and appends the csw:SearchResults element to the XML document.
Applies to csw:GetRecordsResponse.
Discovered records are also created and appended.

Parameters:

parent - the parent element that will hold the results (typically the root)

Throws:

Exception

appendAtomResultsElement

protected void appendAtomResultsElement(OperationContext context)
                                 throws Exception

Creates and appends the Atom elements to the XML document.
Applies to csw:GetRecordsResponse.
Discovered records are also created and appended.

Parameters:

root - the parent element that will hold the results (typically the root)

Throws:

Exception

generateResponse

public void generateResponse(OperationContext context)
                      throws Exception

Generates the response.

Specified by:

generateResponse in interface IResponseGenerator

Parameters:

context - the operation context

Throws:

Exception - if a processing exception occurs

newResponseDom

public Document newResponseDom(OperationContext context)
                        throws Exception

Throws:

Exception

newResponseDom

public Element newResponseDom(OperationContext context,
                              String rootName)
                       throws Exception

Creates a new XML document for response construction.

Parameters:

rootName - the name of the root element

Returns:

the root element

Throws:

Exception - if a processing exception occurs

appendDiscoveredRecords

protected void appendDiscoveredRecords(OperationContext context,
                                       Document root)
                                throws Exception

Throws:

Exception