com.esri.gpt.catalog.search
Class SearchResult

java.lang.Object
  com.esri.gpt.framework.request.Result
      com.esri.gpt.framework.request.QueryResult<SearchResultRecords>
          com.esri.gpt.catalog.search.SearchResult

public class SearchResult
extends QueryResult<SearchResultRecords>

The Class SearchResult. Represents a a result from a search. methods also summarise the records contained within.

Constructor Summary

SearchResult()

Method Summary

void	clear() Clear/Reset all instance variables.
Envelope	getCurrentEnvelopeInView() Gets the current envelope in view.
String	getCurrentMetadataXmlInView() Gets the current metadata xml requested for view.
Envelope	getEnclosingEnvelope() Gets the enclosing envelope.
SearchResultRecords	getRecords() Returns records.
String	getRecordsAsJSON() Gets the record as JSON.
int	getRecordSize() Gets the record size.
double	getSearchTimeInSeconds() Gets the search time in seconds.
boolean	isSupportsContentTypeQuery() Checks if is supports content type query.
boolean	isSupportsSpatialDisplay() Checks if is supports spatial display.
void	setCurrentEnvelopeInView(Envelope currentEnvelopeInView) Sets the current envelope in view.
void	setCurrentMetadataXmlInView(String currentMetadataInView) Sets the current metadata xml requested view.
void	setPageCursor(PageCursor cursor) Sets the page cursor.
void	setSearchTimeInSeconds(double searchTimeInSeconds) Sets the search time in seconds.
void	setSupportsContentTypeQuery(boolean supportsContentTypeQuery) Sets the supports content type query.
void	setSupportsSpatialDisplay(boolean supportsSpatialDisplay) Sets the supports spatial display.

Methods inherited from class com.esri.gpt.framework.request.QueryResult

getHasRecords, getMaxQueryHits, getPageCursor, reset, setMaxQueryHits, setRecords

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResult

public SearchResult()

Method Detail

getCurrentMetadataXmlInView

public String getCurrentMetadataXmlInView()

Gets the current metadata xml requested for view.

Returns:

the current metadata xml in view (trimmed, never null)

setCurrentMetadataXmlInView

public void setCurrentMetadataXmlInView(String currentMetadataInView)

Sets the current metadata xml requested view.

Parameters:

currentMetadataInView - the new current metadata xml in view

getCurrentEnvelopeInView

public Envelope getCurrentEnvelopeInView()

Gets the current envelope in view.

Returns:

the current envelope in view (never null)

setCurrentEnvelopeInView

public void setCurrentEnvelopeInView(Envelope currentEnvelopeInView)

Sets the current envelope in view.

Parameters:

currentEnvelopeInView - the new current envelope in view

getEnclosingEnvelope

public Envelope getEnclosingEnvelope()

Gets the enclosing envelope.

Returns:

the enclosing envelope (never null)

getSearchTimeInSeconds

public double getSearchTimeInSeconds()

Gets the search time in seconds.

Returns:

the search time in seconds

setSearchTimeInSeconds

public void setSearchTimeInSeconds(double searchTimeInSeconds)

Sets the search time in seconds.

Parameters:

searchTimeInSeconds - the new search time in seconds

isSupportsContentTypeQuery

public boolean isSupportsContentTypeQuery()

Checks if is supports content type query.

Returns:

true, if is supports content type query

setSupportsContentTypeQuery

public void setSupportsContentTypeQuery(boolean supportsContentTypeQuery)

Sets the supports content type query.

Parameters:

supportsContentTypeQuery - the new supports content type query

isSupportsSpatialDisplay

public boolean isSupportsSpatialDisplay()

Checks if is supports spatial display.

Returns:

true, if is supports spatial display

setSupportsSpatialDisplay

public void setSupportsSpatialDisplay(boolean supportsSpatialDisplay)

Sets the supports spatial display.

Parameters:

supportsSpatialDisplay - the new supports spatial display

getRecords

public SearchResultRecords getRecords()

Returns records.

Overrides:

getRecords in class QueryResult<SearchResultRecords>

Returns:

SearchResultRecords (never null)

See Also:

QueryResult.getRecords()

getRecordSize

public int getRecordSize()

Gets the record size.

Returns:

the record size

setPageCursor

public void setPageCursor(PageCursor cursor)

Sets the page cursor.

Overrides:

setPageCursor in class QueryResult<SearchResultRecords>

Parameters:

cursor - the cursor

See Also:

QueryResult.setPageCursor(com.esri.gpt.framework.request.PageCursor)

getRecordsAsJSON

public String getRecordsAsJSON()

Gets the record as JSON. Will give envelopes & and contenttype

Returns:

the record envelopes as JSON (never null)

clear

public void clear()

Clear/Reset all instance variables.