Esri Geoportal Server
1.0

com.esri.gpt.catalog.search
Class SearchResultRecord

java.lang.Object
  extended by com.esri.gpt.framework.request.Record
      extended by com.esri.gpt.catalog.search.SearchResultRecord

public class SearchResultRecord
extends Record

The Class SearchResultRecord. Contains attributes describing a metadata record . Not thread safe.


Field Summary
static int ABSTRACT_MAXLENGTH
          The maximum length of the abstract *
static String CONTENTTYPE_PROPERTY_PREFIX
          Prefix where content type is appended to to come up with the readable content type title
 
Constructor Summary
SearchResultRecord()
           
 
Method Summary
 String getAbstract()
          Gets the abstract.
 String getContentType()
          Gets the content type.
 ResourceLink getContentTypeLink()
          Gets the content type link associated with the record.
 Envelope getEnvelope()
          Gets the bounding envelope.
 String getExternalId()
          Gets the external repository id.
 String getFileIdentifier()
          Gets the file identifier.
 Date getModfiedDate()
          Gets the modified date.
 Map<String,Object> getObjectMap()
          Gets the free form object map associated with this request.
 ResourceLinks getResourceLinks()
          Gets the resource links.
 String getResourceUrl()
          Gets primary resource URL.
 String getService()
          Gets the service name.
 String getServiceType()
          Gets the service type.
 ResourceLink getThumbnailLink()
          Gets the thumbnail link associated with the record.
 String getTitle()
          Gets the title.
 String getUuid()
          Gets the UUID.
 boolean isDefaultGeometry()
          Checks if is default geometry.
 boolean isExternal()
          Determines if the record is from an external repository.
 boolean isSupportsViewMetadata()
          Checks if is supports view metadata.
 void setAbstract(String abs)
          Sets the abstract.
 void setContentType(String contentType)
          Sets the content type.
 void setDefaultGeometry(boolean defaultGeometry)
          Sets the default geometry.
 void setEnvelope(Envelope envelope)
          Sets the bounding envelope.
 void setExternal(boolean external)
          Sets the flag indicating if the record is from an external repository.
 void setExternalId(String externalId)
          Sets the external repository id.
 void setFileIdentifier(String id)
          Sets the file identifier.
 void setModifiedDate(Date date)
          Sets the modified date.
protected  void setResourceLinks(ResourceLinks links)
          Sets the resource links.
 void setResourceUrl(String url)
          Sets primary resource URL.
 void setService(String service)
          Sets the service.
 void setServiceType(String serviceType)
          Sets the service type.
 void setSupportsViewMetadata(boolean supportsViewMetadata)
          Sets the supports view metadata.
 void setTitle(String title)
          Sets the title.
 void setUuid(String uuid)
          Sets the UUID.
 
Methods inherited from class com.esri.gpt.framework.request.Record
getIsSelected, setIsSelected
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ABSTRACT_MAXLENGTH

public static final int ABSTRACT_MAXLENGTH
The maximum length of the abstract *

See Also:
Constant Field Values

CONTENTTYPE_PROPERTY_PREFIX

public static final String CONTENTTYPE_PROPERTY_PREFIX
Prefix where content type is appended to to come up with the readable content type title

See Also:
Constant Field Values
Constructor Detail

SearchResultRecord

public SearchResultRecord()
Method Detail

getAbstract

public String getAbstract()
Gets the abstract.

Returns:
the abstract (trimmed, never null)

setAbstract

public void setAbstract(String abs)
Sets the abstract.

Parameters:
abs - the abstract

getContentType

public String getContentType()
Gets the content type.

Returns:
the content type (trimmed, never null)

setContentType

public void setContentType(String contentType)
Sets the content type.

Parameters:
contentType - the new content type

getContentTypeLink

public ResourceLink getContentTypeLink()
Gets the content type link associated with the record.
Convienence method for:
SearchResultRecord.getResourceLinks().getIcon();

Returns:
content type link

getEnvelope

public Envelope getEnvelope()
Gets the bounding envelope.

Returns:
the bounding envelope

setEnvelope

public void setEnvelope(Envelope envelope)
Sets the bounding envelope.

Parameters:
envelope - the bounding envelope

isExternal

public boolean isExternal()
Determines if the record is from an external repository.

Returns:
true if external

setExternal

public void setExternal(boolean external)
Sets the flag indicating if the record is from an external repository.

Parameters:
external - true if external

getExternalId

public String getExternalId()
Gets the external repository id.

Returns:
the external id (trimmed, never-null)

setExternalId

public void setExternalId(String externalId)
Sets the external repository id.

Parameters:
externalId - the new external id

getFileIdentifier

public String getFileIdentifier()
Gets the file identifier.
The file identifier is typically associated with ISO-19139 documents.

Returns:
the file identifier (trimmed, never null)

setFileIdentifier

public void setFileIdentifier(String id)
Sets the file identifier.
The file identifier is typically associated with ISO-19139 documents.

Parameters:
id - the file identifier

getModfiedDate

public Date getModfiedDate()
Gets the modified date.

Returns:
the modfied date (possibly null)

setModifiedDate

public void setModifiedDate(Date date)
Sets the modified date.

Parameters:
date - the new modified date

getObjectMap

public Map<String,Object> getObjectMap()
Gets the free form object map associated with this request.
This map can be used in a manner similar to the attributes of a ServletRequest.

Returns:
the free form object map

getResourceLinks

public ResourceLinks getResourceLinks()
Gets the resource links.

Returns:
the links

setResourceLinks

protected void setResourceLinks(ResourceLinks links)
Sets the resource links.

Parameters:
links - the resource links

getResourceUrl

public String getResourceUrl()
Gets primary resource URL.
The primary resource URL is associated with the resource that the metadata record describes.

Returns:
the URL

setResourceUrl

public void setResourceUrl(String url)
Sets primary resource URL.
The primary resource URL is associated with the resource that the metadata record describes.

Parameters:
url - the URL

getService

public String getService()
Gets the service name.
This is rarely used, mostly applicable to ArcIMS service names.

Returns:
the service name (never null, trimmed)

setService

public void setService(String service)
Sets the service.
This is rarely used, mostly applicable to ArcIMS service names.

Parameters:
service - the new service name

getServiceType

public String getServiceType()
Gets the service type. Currently service type values in ags, wms, wcs,wfs, aims, kml, csw, sos, ArcGIS:nmf, ArcGIS:lyr,ArcGIS:mxd ags - ArcGIS Server Service aims - ArcIMS Image Service wms - Web Map Service wcs - Web Coverage Service wfs - Web Feature Service kml - Keyhole Markup Language csw - Catalogue Web Service sos - Sensor Observation Service ArcGIS:nmf - ArcGIS Explorer Document ArcGIS:lyr - ArcMap Layer File ArcGIS:mxd - ArcMap Map Document

Returns:
the service type (never null, trimmed)

setServiceType

public void setServiceType(String serviceType)
Sets the service type.

Parameters:
serviceType - the new service type

getThumbnailLink

public ResourceLink getThumbnailLink()
Gets the thumbnail link associated with the record.
Convienence method for:
SearchResultRecord.getResourceLinks().getThumbnail();

Returns:
thumbnail link

getTitle

public String getTitle()
Gets the title.

Returns:
the title (trimmed, never null)

setTitle

public void setTitle(String title)
Sets the title.

Parameters:
title - the title

getUuid

public String getUuid()
Gets the UUID.

Returns:
the UUID (trimmed, never null)

setUuid

public void setUuid(String uuid)
Sets the UUID.

Parameters:
uuid - the UUID

isSupportsViewMetadata

public boolean isSupportsViewMetadata()
Checks if is supports view metadata.

Returns:
true, if is supports view metadata

setSupportsViewMetadata

public void setSupportsViewMetadata(boolean supportsViewMetadata)
Sets the supports view metadata.

Parameters:
supportsViewMetadata - the new supports view metadata

isDefaultGeometry

public boolean isDefaultGeometry()
Checks if is default geometry.

Returns:
true, if is default geometry

setDefaultGeometry

public void setDefaultGeometry(boolean defaultGeometry)
Sets the default geometry.

Parameters:
defaultGeometry - the new default geometry

Esri Geoportal Server
1.0

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