Esri Geoportal Server
1.0

com.esri.gpt.catalog.search
Class SearchEngineExternalCsw

java.lang.Object
  extended by com.esri.gpt.catalog.search.ASearchEngine
      extended by com.esri.gpt.catalog.search.SearchEngineCSW
          extended by com.esri.gpt.catalog.search.SearchEngineExternalCsw
All Implemented Interfaces:
IRequest<SearchRequestDefinition>

public class SearchEngineExternalCsw
extends SearchEngineCSW

The Class SearchEngineExternalCsw. Request based. For searching Harvest Site CSWs in our repositories. Parameters that can be used are is "uuid" of harvest site


Nested Class Summary
 
Nested classes/interfaces inherited from class com.esri.gpt.catalog.search.SearchEngineCSW
SearchEngineCSW.AimsContentTypes, SearchEngineCSW.Scheme, SearchEngineCSW.SEARCH_OPERATION
 
Field Summary
 
Fields inherited from class com.esri.gpt.catalog.search.SearchEngineCSW
DATE_FORMAT, KEY_LINK_INFO, KEY_REFERENCES, KEY_TYPES
 
Constructor Summary
SearchEngineExternalCsw()
          Instantiates a new search engine external csw.
 
Method Summary
 Map<String,Object> createInstances(StringSet rids)
          Creates the instances.
 String getFormerId()
          Gets the former hint.
 HrRecord getHrRecord()
          Gets the hr record.
 String getKeyAbstract()
          Gets the abstract associated with the key
protected  CswRecord getMetadata(String uuid)
          Gets the metadata as a csw client api record.
 void init()
          Initialization
protected  void marshallRecords(CswRecords cswRecords)
          Marshalls csw records
protected  boolean readIsExternalSearch()
          Tells us if the search is external to GPT9 or Internal
protected  CswRecords sendRequest(String cswRequest)
          Sends a CSW GetRecords request to CSW service.
 void setFormerId(String formerHint)
          Sets the former hint.
 void setHrRecord(HrRecord hrRecord)
          Sets the hr record.
 
Methods inherited from class com.esri.gpt.catalog.search.SearchEngineCSW
doSearch, doSearch, getCapabilities, getCswClient, getCswProfile, getGetCapabiltiesUrl, getGetMetadataRecordUrl, getGetRecordsUrl, getMetadataAsSearchResultRecord, getMetadataAsText, getMetadataUrl, getProfileId, getSearchQuery, marshallGptToCswClientCriteria, marshallGptToCswClientCriteria2, marshallRecord, parseResponse, setCapabilities, setCswClient, setGetCapabiltiesUrl, setGetMetadataRecordUrl, setGetRecordsUrl, setProfileId, transformGptToCswRequest
 
Methods inherited from class com.esri.gpt.catalog.search.ASearchEngine
checkPagination, getConnectionTimeoutMs, getConnectionUri, getCredentials, getFactoryAttributes, getHitsOnly, getKey, getMessageBroker, getRequestContext, getRequestDefinition, getResourceLinkBuilder, getResponseTimeoutMs, getSearchTimeInMillis, getTimeInSeconds, readInputCharacters, setConnectionTimeoutMs, setConnectionUri, setCredentials, setFactoryAttributes, setHitsOnly, setKey, setMessageBroker, setRequestContext, setRequestDefinition, setResourceLinkBuilder, setResponseTimeout, setSearchTimeInMillis
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchEngineExternalCsw

public SearchEngineExternalCsw()
Instantiates a new search engine external csw.

Method Detail

getFormerId

public String getFormerId()
Gets the former hint.

Returns:
the former hint

setFormerId

public void setFormerId(String formerHint)
Sets the former hint.

Parameters:
formerHint - the new former hint

getHrRecord

public HrRecord getHrRecord()
Gets the hr record.

Returns:
the hr record (possibly null)

setHrRecord

public void setHrRecord(HrRecord hrRecord)
Sets the hr record.

Parameters:
hrRecord - the new hr record

readIsExternalSearch

protected boolean readIsExternalSearch()
Tells us if the search is external to GPT9 or Internal

Overrides:
readIsExternalSearch in class SearchEngineCSW
Returns:
true

sendRequest

protected CswRecords sendRequest(String cswRequest)
                          throws SearchException
Sends a CSW GetRecords request to CSW service.

Overrides:
sendRequest in class SearchEngineCSW
Parameters:
cswRequest - the CSW XML request
Returns:
the resultant records
Throws:
SearchException - the search exception

marshallRecords

protected void marshallRecords(CswRecords cswRecords)
                        throws SearchException
Marshalls csw records

Overrides:
marshallRecords in class SearchEngineCSW
Parameters:
cswRecords - CSW records
Throws:
SearchException

getMetadata

protected CswRecord getMetadata(String uuid)
                         throws SearchException
Gets the metadata as a csw client api record.

Overrides:
getMetadata in class SearchEngineCSW
Parameters:
uuid - the uuid
Returns:
the metadata
Throws:
SearchException - the search exception

init

public void init()
          throws SearchException
Initialization

Overrides:
init in class SearchEngineCSW
Throws:
SearchException

getKeyAbstract

public String getKeyAbstract()
                      throws SearchException
Gets the abstract associated with the key

Overrides:
getKeyAbstract in class ASearchEngine
Returns:
the abstract
Throws:
SearchException

createInstances

public Map<String,Object> createInstances(StringSet rids)
                                   throws SearchException
Creates the instances.

Overrides:
createInstances in class SearchEngineCSW
Parameters:
rids - the rids
Returns:
the array list
Throws:
SearchException
SearchException - the search exception

Esri Geoportal Server
1.0

Copyright 2011 Environmental Systems Research Institute. All rights reserved. Use is subject to license terms.