|
Esri Geoportal Server 1.0
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.gpt.catalog.search.ASearchEngine
public abstract class ASearchEngine
Defines operations to be carried out by the search end point.
Constructor Summary | |
---|---|
ASearchEngine()
Default Constructor. |
|
ASearchEngine(RequestContext context)
Overloaded Constructor. |
Method Summary | |
---|---|
protected void |
checkPagination()
Check pagination. |
Map<String,Object> |
createInstances(StringSet rids)
Creates multiple instances of this search engine. |
abstract void |
doSearch()
Do search. |
int |
getConnectionTimeoutMs()
Gets the connection timeout in milliseconds. |
URI |
getConnectionUri()
Gets the connection uri. |
UsernamePasswordCredentials |
getCredentials()
Gets the credentials. |
Map<String,String> |
getFactoryAttributes()
Gets the factory attributes. |
boolean |
getHitsOnly()
Gets the hits only. |
String |
getKey()
Gets the key associated with the engine. |
String |
getKeyAbstract()
Gets the abstract text connected with the key. |
MessageBroker |
getMessageBroker()
Gets the message broker. |
abstract SearchResultRecord |
getMetadataAsSearchResultRecord(String uuid)
Gets the metadata as object. |
abstract String |
getMetadataAsText(String uuid)
Gets the metadata as text. |
String |
getMetadataUrl(String uuid)
Gets the metadata url for record. |
RequestContext |
getRequestContext()
Gets the request context. |
SearchRequestDefinition |
getRequestDefinition()
Gets the request definition. |
ResourceLinkBuilder |
getResourceLinkBuilder()
Gets the resource link builder. |
int |
getResponseTimeoutMs()
Gets the response timeout in milliseconds. |
abstract String |
getSearchQuery()
Gets the search query as a string representation. |
Long |
getSearchTimeInMillis()
Gets the search time in millis. |
double |
getTimeInSeconds()
Gets the time in seconds. |
void |
init()
Inits the Object after you have set the properties. |
protected String |
readInputCharacters(InputStream is,
String sEncoding)
Fully reads the characters from the request input stream. |
protected abstract boolean |
readIsExternalSearch()
Read is external search. |
void |
setConnectionTimeoutMs(int connectionTimeout)
Sets the connection timeout in milliseconds. |
void |
setConnectionUri(URI connectionUri)
Sets the connection uri. |
void |
setCredentials(UsernamePasswordCredentials credentials)
Sets the credentials. |
void |
setFactoryAttributes(Map<String,String> factoryAttributes)
Sets the factory attributes. |
void |
setHitsOnly(boolean hitsOnly)
Sets the hits only. |
void |
setKey(String key)
Sets the key associated with the key. |
void |
setMessageBroker(MessageBroker messageBroker)
Sets the message broker. |
void |
setRequestContext(RequestContext context)
Sets the request context. |
void |
setRequestDefinition(SearchRequestDefinition requestDefinition)
Sets the request definition. |
void |
setResourceLinkBuilder(ResourceLinkBuilder resourceLinkBuilder)
Sets the resource link builder. |
void |
setResponseTimeout(int responseTimeout)
Sets the response timeout. |
protected void |
setSearchTimeInMillis(Long time)
Sets the search time in millis. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ASearchEngine()
public ASearchEngine(RequestContext context)
context
- the request contextMethod Detail |
---|
public boolean getHitsOnly()
public void setHitsOnly(boolean hitsOnly)
hitsOnly
- the new hits onlypublic ResourceLinkBuilder getResourceLinkBuilder()
public void setResourceLinkBuilder(ResourceLinkBuilder resourceLinkBuilder)
resourceLinkBuilder
- the new resource link builderpublic URI getConnectionUri() throws SearchException
SearchException
- if uri from criteria is invalidpublic void setConnectionUri(URI connectionUri)
connectionUri
- the new connection uripublic RequestContext getRequestContext()
public void setRequestContext(RequestContext context)
context
- the new request contextpublic String getKeyAbstract() throws SearchException
SearchException
- the search exceptionpublic String getKey()
public void setKey(String key) throws SearchException
key
- the key
SearchException
- the search exception (If error)public UsernamePasswordCredentials getCredentials()
public void setCredentials(UsernamePasswordCredentials credentials)
credentials
- the new credentialspublic int getConnectionTimeoutMs()
public void setConnectionTimeoutMs(int connectionTimeout)
connectionTimeout
- the new connection timeoutpublic int getResponseTimeoutMs()
public void setResponseTimeout(int responseTimeout)
responseTimeout
- the new response timeoutpublic abstract void doSearch() throws SearchException
SearchException
- Exceptions from performing a searchpublic abstract String getMetadataAsText(String uuid) throws SearchException
uuid
- the uuid of the metadata
SearchException
- Exception from retrieving the documentpublic abstract SearchResultRecord getMetadataAsSearchResultRecord(String uuid) throws SearchException
uuid
- the uuid of the metadata
SearchException
- the search exceptionpublic double getTimeInSeconds()
public Long getSearchTimeInMillis()
protected void setSearchTimeInMillis(Long time)
time
- the new search time in millispublic abstract String getSearchQuery() throws SearchException
SearchException
- the search exceptionpublic SearchRequestDefinition getRequestDefinition()
getRequestDefinition
in interface IRequest<SearchRequestDefinition>
public void setRequestDefinition(SearchRequestDefinition requestDefinition)
setRequestDefinition
in interface IRequest<SearchRequestDefinition>
requestDefinition
- the new request definitionpublic String getMetadataUrl(String uuid) throws SearchException
uuid
- the uuid
SearchException
- the search exceptionpublic void init() throws SearchException
SearchExcpetion
- the search excpetion
SearchException
- the search exceptionpublic Map<String,String> getFactoryAttributes()
public void setFactoryAttributes(Map<String,String> factoryAttributes)
factoryAttributes
- the factory attributespublic MessageBroker getMessageBroker()
public void setMessageBroker(MessageBroker messageBroker)
messageBroker
- the new message brokerprotected abstract boolean readIsExternalSearch()
public Map<String,Object> createInstances(StringSet rids) throws SearchException
rids
- the rids
SearchException
- the search exceptionprotected void checkPagination() throws SearchException
SearchException
- the search exceptionprotected String readInputCharacters(InputStream is, String sEncoding) throws IOException
is
- input streamsEncoding
- character encoding
IOException
- if an exception occurs
|
Esri Geoportal Server 1.0
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |