Package com.luciad.opensearch.model

Class TLcdOpenSearchAtomFeed

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.format.metadata.atom.model.TLcdAtomFeed

com.luciad.opensearch.model.TLcdOpenSearchAtomFeed

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdOpenSearchAtomFeed
extends TLcdAtomFeed

ATOM feed with OpenSearch elements.

Since:

2017.0

Field Summary

Fields inherited from class com.luciad.format.metadata.atom.model.TLcdAtomFeed

ANY_PROPERTY, AUTHORS_PROPERTY, BASE_PROPERTY, CATEGORIES_PROPERTY, CONTRIBUTORS_PROPERTY, ENTRIES_PROPERTY, GENERATORS_PROPERTY, ICONS_PROPERTY, IDS_PROPERTY, LANGUAGE_PROPERTY, LINKS_PROPERTY, LOGOS_PROPERTY, RIGHTS_PROPERTY, SUBTITLES_PROPERTY, TITLES_PROPERTY, UPDATED_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TLcdOpenSearchAtomFeed()

Method Summary

Modifier and Type	Method	Description
long	getItemsPerPage()	Returns the maximum amount of items contained in this feed.
TLcdOpenSearchQuery	getQuery()	Returns the query triggering creation of this feed.
long	getStartIndex()	Returns the index of the first entry in this feed, respective to the total amount of matched results.
long	getTotalResults()	Returns the total number of the results for the associated query.
void	setItemsPerPage(long aValue)	Sets the maximum amount of items contained in this feed.
void	setQuery(TLcdOpenSearchQuery aQuery)	Sets the query triggering creation of this feed.
void	setStartIndex(long aValue)	Sets the index of the first entry in this feed, respective to the total amount of matched results.
void	setTotalResults(long aValue)	Sets the total number of the results for the associated query.

Methods inherited from class com.luciad.format.metadata.atom.model.TLcdAtomFeed

getAny, getAuthors, getBase, getCategories, getContributors, getEntries, getGenerators, getIcons, getIds, getLanguage, getLinks, getLogos, getRights, getSubtitles, getTitles, getUpdated, setBase, setLanguage

Methods inherited from class com.luciad.datamodel.TLcdDataObject

clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString

Methods inherited from class java.lang.Object

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

Constructor Details

TLcdOpenSearchAtomFeed

public TLcdOpenSearchAtomFeed()

Method Details

getQuery

public TLcdOpenSearchQuery getQuery()

Returns the query triggering creation of this feed.

Returns:

the associated query

setQuery

public void setQuery(TLcdOpenSearchQuery aQuery)

Sets the query triggering creation of this feed.

Parameters:

aQuery - the associated query

getTotalResults

public long getTotalResults()

Returns the total number of the results for the associated query.

Returns:

the total results

setTotalResults

public void setTotalResults(long aValue)

Sets the total number of the results for the associated query.

Parameters:

aValue - the total number of results

getStartIndex

public long getStartIndex()

Returns the index of the first entry in this feed, respective to the total amount of matched results.

Returns:

the record index, with 1 meaning the first record

setStartIndex

public void setStartIndex(long aValue)

Sets the index of the first entry in this feed, respective to the total amount of matched results.

Parameters:

aValue - the record index, with 1 meaning the first record

getItemsPerPage

public long getItemsPerPage()

Returns the maximum amount of items contained in this feed.

Returns:

the amount of items, less than or equal to the total amount of matched results

setItemsPerPage

public void setItemsPerPage(long aValue)

Sets the maximum amount of items contained in this feed.

Parameters:

aValue - the amount of items, less than or equal to the total amount of matched results