com.esri.gpt.framework.search
Class SearchXslRecord

java.lang.Object
  com.esri.gpt.framework.request.Record
      com.esri.gpt.framework.search.SearchXslRecord

Direct Known Subclasses:

CswRecord

public class SearchXslRecord
extends Record

The Class CswRecord.

Field Summary

static String	DEFAULT_DATE_FORMAT
static String	KEY_LINK_INFO key goes into the objectMap in searchResultRecord
static String	KEY_REFERENCES
static String	KEY_TYPES

Constructor Summary

SearchXslRecord()
Instantiates a new csw record.

SearchXslRecord(String id)
Instantiates a new csw record.

SearchXslRecord(String id, String title, String sabstract)
The Constructor.

Method Summary

String	getAbstractData() Gets the abstract data.
String	getBriefMetadata() Gets the brief metadata.
Envelope	getEnvelope() Gets the bounding box.
String	getFullMetadata() Gets the full metadata.
String	getId() Gets the id.
SearchXslRecordLinks	getLinks() Gets the custom links.
String	getMetadataResourceURL() Gets the metadata resource URL.
String	getModifiedDate() Gets the modified date.
Date	getModifiedDateAsDateObject() Gets the modified date as date object.
Date	getModifiedDateAsDateObject(String format) Gets the modified date as date object.
DcList	getReferences() Gets the references.
String	getSummaryMetadata() Gets the summary metadata.
String	getTitle() Gets the title.
DcList	getTypes() Gets the types.
boolean	isDefaultGeometry() Checks if is default geometry.
boolean	isLiveDataOrMap() Checks if is live data or map.
SearchResultRecord	readAsSearchResult(ResourceLinkBuilder resourceLinkBuilder, boolean isExternal, String rid) Read as search result.
void	setAbstractData(String abstractData) Sets the abstract data.
void	setBriefMetadata(String briefMetadata) Sets the brief metadata.
void	setDefaultEnvelope(boolean isDefaultGeometry) Sets the default envelope.
void	setEnvelope(Envelope boundingBox) Sets the bounding box.
void	setFullMetadata(String fullMetadata) Sets the full metadata.
void	setId(String id) Sets the id.
void	setLiveDataOrMap(boolean isLiveDataOrMap) Sets the live data or map.
void	setMetadataResourceURL(String metadataResourceURL) Sets the metadata resource URL.
void	setModifiedDate(String modifiedDate) Sets the modified date.
void	setReference(String list) Sets the reference.
void	setReferences(DcList references) Sets the references.
void	setSummaryMetadata(String summaryMetadata) Sets the summary metadata.
void	setTitle(String title) Sets the title.
void	setTypes(DcList types) Sets the types.
void	setTypes(String list) Sets the types.

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

DEFAULT_DATE_FORMAT

public static final String DEFAULT_DATE_FORMAT

See Also:

Constant Field Values

KEY_LINK_INFO

public static final String KEY_LINK_INFO

key goes into the objectMap in searchResultRecord

See Also:

Constant Field Values

KEY_REFERENCES

public static final String KEY_REFERENCES

See Also:

Constant Field Values

KEY_TYPES

public static final String KEY_TYPES

See Also:

Constant Field Values

Constructor Detail

SearchXslRecord

public SearchXslRecord()

Instantiates a new csw record.

SearchXslRecord

public SearchXslRecord(String id)

Instantiates a new csw record.

Parameters:

id - the id

SearchXslRecord

public SearchXslRecord(String id,
                       String title,
                       String sabstract)

The Constructor.

Parameters:

sabstract - the sabstract

id - the id

title - the title

Method Detail

getModifiedDate

public String getModifiedDate()

Gets the modified date.

Returns:

the modified date (possibly null)

setModifiedDate

public void setModifiedDate(String modifiedDate)

Sets the modified date.

Parameters:

modifiedDate - the new modified date

getReferences

public DcList getReferences()

Gets the references.

Returns:

the references (never null)

setReferences

public void setReferences(DcList references)

Sets the references.

Parameters:

references - the new references

setReference

public void setReference(String list)

Sets the reference.

Parameters:

list - the new reference

getTypes

public DcList getTypes()

Gets the types.

Returns:

the types (never null)

setTypes

public void setTypes(DcList types)

Sets the types.

Parameters:

types - the new types

setTypes

public void setTypes(String list)

Sets the types.

Parameters:

list - the new types

getEnvelope

public Envelope getEnvelope()

Gets the bounding box.

Returns:

the bounding box (possibly null)

setEnvelope

public void setEnvelope(Envelope boundingBox)

Sets the bounding box.

Parameters:

boundingBox - the new bounding box

getAbstractData

public String getAbstractData()

Gets the abstract data.

Returns:

the abstract data (possibly null)

setAbstractData

public void setAbstractData(String abstractData)

Sets the abstract data.

Parameters:

abstractData - the new abstract data

getBriefMetadata

public String getBriefMetadata()

Gets the brief metadata.

Returns:

the brief metadata (possibly null)

setBriefMetadata

public void setBriefMetadata(String briefMetadata)

Sets the brief metadata.

Parameters:

briefMetadata - the new brief metadata

getFullMetadata

public String getFullMetadata()

Gets the full metadata.

Returns:

the full metadata (possibly null)

setFullMetadata

public void setFullMetadata(String fullMetadata)

Sets the full metadata.

Parameters:

fullMetadata - the new full metadata

getId

public String getId()

Gets the id.

Returns:

the id (possibly null)

setId

public void setId(String id)

Sets the id.

Parameters:

id - the new id

isLiveDataOrMap

public boolean isLiveDataOrMap()

Checks if is live data or map.

Returns:

true, if is live data or map

setLiveDataOrMap

public void setLiveDataOrMap(boolean isLiveDataOrMap)

Sets the live data or map.

Parameters:

isLiveDataOrMap - the new live data or map

getMetadataResourceURL

public String getMetadataResourceURL()

Gets the metadata resource URL.

Returns:

the metadata resource URL (possibly null)

setMetadataResourceURL

public void setMetadataResourceURL(String metadataResourceURL)

Sets the metadata resource URL.

Parameters:

metadataResourceURL - the new metadata resource URL

getSummaryMetadata

public String getSummaryMetadata()

Gets the summary metadata.

Returns:

the summary metadata (possibly null)

setSummaryMetadata

public void setSummaryMetadata(String summaryMetadata)

Sets the summary metadata.

Parameters:

summaryMetadata - the new summary metadata

getTitle

public String getTitle()

Gets the title.

Returns:

the title (possibly null)

setTitle

public void setTitle(String title)

Sets the title.

Parameters:

title - the new title

getModifiedDateAsDateObject

public Date getModifiedDateAsDateObject()

Gets the modified date as date object. Uses the simple date format returned by arcIMS CSW. If error, exception thrown. Use this.getModifiedDate to get the String representation for self parsing i.e. yyyy-dd-MM HH:MM:SS e.g. 2008-02-12 13:06:04

Returns:

the modified date as date object

Throws:

ParseException - if modified date format could not be understood

getModifiedDateAsDateObject

public Date getModifiedDateAsDateObject(String format)

Gets the modified date as date object.

Parameters:

format - the date format. If null, default format used.

Returns:

the modified date as date object

getLinks

public SearchXslRecordLinks getLinks()

Gets the custom links.

Returns:

the custom links (never null)

isDefaultGeometry

public boolean isDefaultGeometry()

Checks if is default geometry. Tells us whether the record has a true envelope or whether just the default geometry is being used.

Returns:

true, if is default envelope

setDefaultEnvelope

public void setDefaultEnvelope(boolean isDefaultGeometry)

Sets the default envelope.

Parameters:

isDefaultGeometry - the new default envelope

readAsSearchResult

public SearchResultRecord readAsSearchResult(ResourceLinkBuilder resourceLinkBuilder,
                                             boolean isExternal,
                                             String rid)
                                      throws SearchException

Read as search result.

Parameters:

resourceLinkBuilder - the resource link builder

isExternal - the is external (if the resource is not the native search, set to true)

rid - the remote id of the site

Returns:

the search result record

Throws:

SearchException - the search exception