com.esri.gpt.server.csw.client
Class CswSearchRequest

java.lang.Object
  com.esri.gpt.server.csw.client.CswSearchRequest

public class CswSearchRequest
extends Object

CswSearchRequest class. CswSearchRequest class is used to submit CSW search queries and to return CSW search results. Before submiting a request, you need to specify a catalog and provide search criteria.

Constructor Summary

CswSearchRequest()

CswSearchRequest(CswCatalog catalog, String searchText)

Method Summary

CswCatalog	getCatalog() Accessor methods
CswSearchCriteria	getCriteria()
CswClient	getCswClient()
CswSearchResponse	getCswSearchResponse()
void	getMetadataByID(String DocID) Retrieve metadata from CSW service by its ID
CswRecord	getRecordById(String requestURL, String DocID, CswProfile profile) Gets the record by id.
CswRecord	getRecordById(String requestURL, String DocID, CswProfile profile, String username, String password) Gets the record by id.
CswSearchResponse	getResponse() Get the CSW search response of a CSW search request Get the CSW search response of a CSW search request
void	search() Search CSW catalog using the provided criteria.
void	setCatalog(CswCatalog catalog)
void	setCriteria(CswSearchCriteria criteria)
void	setCswClient(CswClient cswClient)
void	setCswSearchResponse(CswSearchResponse response)

Methods inherited from class java.lang.Object

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

Constructor Detail

CswSearchRequest

public CswSearchRequest()

CswSearchRequest

public CswSearchRequest(CswCatalog catalog,
                        String searchText)

Method Detail

getCatalog

public CswCatalog getCatalog()

Accessor methods

setCatalog

public void setCatalog(CswCatalog catalog)

getCriteria

public CswSearchCriteria getCriteria()

setCriteria

public void setCriteria(CswSearchCriteria criteria)

getCswClient

public CswClient getCswClient()

setCswClient

public void setCswClient(CswClient cswClient)

getCswSearchResponse

public CswSearchResponse getCswSearchResponse()

setCswSearchResponse

public void setCswSearchResponse(CswSearchResponse response)

getMetadataByID

public void getMetadataByID(String DocID)
                     throws NullReferenceException,
                            IOException,
                            InvalidOperationException,
                            TransformerException

Retrieve metadata from CSW service by its ID

Parameters:

DocID - Metadata document ID

Throws:

NullReferenceException

IOException

InvalidOperationException

TransformerException

getRecordById

public CswRecord getRecordById(String requestURL,
                               String DocID,
                               CswProfile profile)
                        throws IOException,
                               TransformerException,
                               NullReferenceException,
                               InvalidOperationException

Gets the record by id.

Parameters:

requestURL - the request URL (CSW service url)

DocID - the doc ID (GUID or UUID)

profile - the profile

Returns:

the record by id

Throws:

IOException - Signals that an I/O exception has occurred.

TransformerException - the transformer exception

NullReferenceException - the null reference exception

InvalidOperationException - the invalid operation exception

getRecordById

public CswRecord getRecordById(String requestURL,
                               String DocID,
                               CswProfile profile,
                               String username,
                               String password)
                        throws IOException,
                               TransformerException,
                               NullReferenceException,
                               InvalidOperationException

Gets the record by id.

Parameters:

requestURL - the request URL (CSW service url)

DocID - the doc ID (GUID or UUID)

profile - the profile

Returns:

the record by id

Throws:

IOException - Signals that an I/O exception has occurred.

TransformerException - the transformer exception

NullReferenceException - the null reference exception

InvalidOperationException - the invalid operation exception

getResponse

public CswSearchResponse getResponse()

Get the CSW search response of a CSW search request Get the CSW search response of a CSW search request

Returns:

a CswSearchResponse object.

search

public void search()
            throws NullReferenceException,
                   XPathExpressionException,
                   ParserConfigurationException,
                   SAXException,
                   IOException,
                   TransformerException

Search CSW catalog using the provided criteria. Search result can be accessed by calling GetResponse().

Throws:

IOException

SAXException

ParserConfigurationException

XPathExpressionException

TransformerException

NullReferenceException