TLcdAtomFeed (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.datamodel.TLcdDataObject
- - com.luciad.format.metadata.atom.model.TLcdAtomFeed

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

Direct Known Subclasses:

TLcdOpenSearchAtomFeed
```
public class TLcdAtomFeed
extends TLcdDataObject
```
Models an Atom feed. A feed has some metadata (such as a title and icon), and one or more entries. For more information, refer to section 4.1.1 of the format spec.

Since:

2017.0

See Also:

TLcdAtomEntry

Field Summary

Fields
Modifier and Type	Field and Description
`static TLcdDataProperty`	`ANY_PROPERTY` Data any property.
`static TLcdDataProperty`	`AUTHORS_PROPERTY` Data property that maps to the `author` element.
`static TLcdDataProperty`	`BASE_PROPERTY` Data property that maps to the `base` attribute.
`static TLcdDataProperty`	`CATEGORIES_PROPERTY` Data property that maps to the `category` element.
`static TLcdDataProperty`	`CONTRIBUTORS_PROPERTY` Data property that maps to the `contributor` element.
`static TLcdDataProperty`	`ENTRIES_PROPERTY` Data property that maps to the `entry` element.
`static TLcdDataProperty`	`GENERATORS_PROPERTY` Data property that maps to the `generator` element.
`static TLcdDataProperty`	`ICONS_PROPERTY` Data property that maps to the `icon` element.
`static TLcdDataProperty`	`IDS_PROPERTY` Data property that maps to the `id` element.
`static TLcdDataProperty`	`LANGUAGE_PROPERTY` Data property that maps to the `lang` attribute.
`static TLcdDataProperty`	`LINKS_PROPERTY` Data property that maps to the `link` element.
`static TLcdDataProperty`	`LOGOS_PROPERTY` Data property that maps to the `logo` element.
`static TLcdDataProperty`	`RIGHTS_PROPERTY` Data property that maps to the `rights` element.
`static TLcdDataProperty`	`SUBTITLES_PROPERTY` Data property that maps to the `subtitle` element.
`static TLcdDataProperty`	`TITLES_PROPERTY` Data property that maps to the `title` element.
`static TLcdDataProperty`	`UPDATED_PROPERTY` Data property that maps to the `updated` element.

Constructor Summary

Constructors
Constructor and Description

TLcdAtomFeed()

TLcdAtomFeed(TLcdDataType aType)

Constructors
Constructor and Description
`TLcdAtomFeed()`
`TLcdAtomFeed(TLcdDataType aType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Object>`	`getAny()` Returns the value of the any property.
`List<TLcdAtomPerson>`	`getAuthors()` Returns the value of the property that maps to the `author` element.
`URI`	`getBase()` Returns the value of the property that maps to the `base` attribute.
`List<TLcdAtomCategory>`	`getCategories()` Returns the value of the property that maps to the `category` element.
`List<TLcdAtomPerson>`	`getContributors()` Returns the value of the property that maps to the `contributor` element.
`List<TLcdAtomEntry>`	`getEntries()` Returns the value of the property that maps to the `entry` element.
`List<TLcdAtomGenerator>`	`getGenerators()` Returns the value of the property that maps to the `generator` element.
`List<TLcdAtomIcon>`	`getIcons()` Returns the value of the property that maps to the `icon` element.
`List<TLcdAtomId>`	`getIds()` Returns the value of the property that maps to the `id` element.
`String`	`getLanguage()` Returns the value of the property that maps to the `lang` attribute.
`List<TLcdAtomLink>`	`getLinks()` Returns the value of the property that maps to the `link` element.
`List<TLcdAtomLogo>`	`getLogos()` Returns the value of the property that maps to the `logo` element.
`List<TLcdAtomText>`	`getRights()` Returns the value of the property that maps to the `rights` element.
`List<TLcdAtomText>`	`getSubtitles()` Returns the value of the property that maps to the `subtitle` element.
`List<TLcdAtomText>`	`getTitles()` Returns the value of the property that maps to the `title` element.
`List<TLcdAtomDateTime>`	`getUpdated()` Returns the value of the property that maps to the `updated` element.
`void`	`setBase(URI aValue)` Sets the value of the property that maps to the `base` attribute.
`void`	`setLanguage(String aValue)` Sets the value of the property that maps to the `lang` attribute.

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

- Field Detail
  - BASE_PROPERTY
```
public static final TLcdDataProperty BASE_PROPERTY
```
    Data property that maps to the base attribute. The possible values for this property are instances of URI.
  - LANGUAGE_PROPERTY
```
public static final TLcdDataProperty LANGUAGE_PROPERTY
```
    Data property that maps to the lang attribute. The possible values for this property are instances of String.
  - AUTHORS_PROPERTY
```
public static final TLcdDataProperty AUTHORS_PROPERTY
```
    Data property that maps to the author element. The possible values for this property are instances of List<TLcdAtomPerson>.
  - CATEGORIES_PROPERTY
```
public static final TLcdDataProperty CATEGORIES_PROPERTY
```
    Data property that maps to the category element. The possible values for this property are instances of List<TLcdAtomCategory>.
  - CONTRIBUTORS_PROPERTY
```
public static final TLcdDataProperty CONTRIBUTORS_PROPERTY
```
    Data property that maps to the contributor element. The possible values for this property are instances of List<TLcdAtomPerson>.
  - GENERATORS_PROPERTY
```
public static final TLcdDataProperty GENERATORS_PROPERTY
```
    Data property that maps to the generator element. The possible values for this property are instances of List<TLcdAtomGenerator>.
  - ICONS_PROPERTY
```
public static final TLcdDataProperty ICONS_PROPERTY
```
    Data property that maps to the icon element. The possible values for this property are instances of List<TLcdAtomIcon>.
  - IDS_PROPERTY
```
public static final TLcdDataProperty IDS_PROPERTY
```
    Data property that maps to the id element. The possible values for this property are instances of List<TLcdAtomId>.
  - LINKS_PROPERTY
```
public static final TLcdDataProperty LINKS_PROPERTY
```
    Data property that maps to the link element. The possible values for this property are instances of List<TLcdAtomLink>.
  - LOGOS_PROPERTY
```
public static final TLcdDataProperty LOGOS_PROPERTY
```
    Data property that maps to the logo element. The possible values for this property are instances of List<TLcdAtomLogo>.
  - RIGHTS_PROPERTY
```
public static final TLcdDataProperty RIGHTS_PROPERTY
```
    Data property that maps to the rights element. The possible values for this property are instances of List<TLcdAtomText>.
  - SUBTITLES_PROPERTY
```
public static final TLcdDataProperty SUBTITLES_PROPERTY
```
    Data property that maps to the subtitle element. The possible values for this property are instances of List<TLcdAtomText>.
  - TITLES_PROPERTY
```
public static final TLcdDataProperty TITLES_PROPERTY
```
    Data property that maps to the title element. The possible values for this property are instances of List<TLcdAtomText>.
  - UPDATED_PROPERTY
```
public static final TLcdDataProperty UPDATED_PROPERTY
```
    Data property that maps to the updated element. The possible values for this property are instances of List<TLcdAtomDateTime>.
  - ANY_PROPERTY
```
public static final TLcdDataProperty ANY_PROPERTY
```
    Data any property. The possible values for this property are instances of List<Object>.
  - ENTRIES_PROPERTY
```
public static final TLcdDataProperty ENTRIES_PROPERTY
```
    Data property that maps to the entry element. The possible values for this property are instances of List<TLcdAtomEntry>.
- Constructor Detail
  - TLcdAtomFeed
```
public TLcdAtomFeed()
```
  - TLcdAtomFeed
```
public TLcdAtomFeed(TLcdDataType aType)
```
- Method Detail
  - getBase
```
public URI getBase()
```
    Returns the value of the property that maps to the base attribute.
    
    Returns:
    
    the value of the BASE_PROPERTY property.
  - setBase
```
public void setBase(URI aValue)
```
    Sets the value of the property that maps to the base attribute.
    
    Parameters:
    
    aValue - the value to set for the BASE_PROPERTY property.
  - getLanguage
```
public String getLanguage()
```
    Returns the value of the property that maps to the lang attribute.
    
    Returns:
    
    the value of the LANGUAGE_PROPERTY property.
  - setLanguage
```
public void setLanguage(String aValue)
```
    Sets the value of the property that maps to the lang attribute.
    
    Parameters:
    
    aValue - the value to set for the LANGUAGE_PROPERTY property.
  - getAuthors
```
public List<TLcdAtomPerson> getAuthors()
```
    Returns the value of the property that maps to the author element.
    Names an author of the feed. A feed may have multiple author elements. A feed must contain at least one author element unless all of the entry elements contain at least one author element.
    
    Returns:
    
    the value of the AUTHORS_PROPERTY property.
  - getCategories
```
public List<TLcdAtomCategory> getCategories()
```
    Returns the value of the property that maps to the category element.
    Specifies a category that the feed belongs to. A feed may have multiple category elements.
    
    Returns:
    
    the value of the CATEGORIES_PROPERTY property.
  - getContributors
```
public List<TLcdAtomPerson> getContributors()
```
    Returns the value of the property that maps to the contributor element.
    
    Returns:
    
    the value of the CONTRIBUTORS_PROPERTY property.
  - getGenerators
```
public List<TLcdAtomGenerator> getGenerators()
```
    Returns the value of the property that maps to the generator element.
    Identifies the software used to generate the feed, for debugging and other purposes.
    
    Returns:
    
    the value of the GENERATORS_PROPERTY property.
  - getIcons
```
public List<TLcdAtomIcon> getIcons()
```
    Returns the value of the property that maps to the icon element.
    
    Returns:
    
    the value of the ICONS_PROPERTY property.
  - getIds
```
public List<TLcdAtomId> getIds()
```
    Returns the value of the property that maps to the id element.
    Identifies the feed using a universally unique and permanent URI. If you have a long-term, renewable lease on your Internet domain name, then you can feel free to use your website's address.
    
    Returns:
    
    the value of the IDS_PROPERTY property.
  - getLinks
```
public List<TLcdAtomLink> getLinks()
```
    Returns the value of the property that maps to the link element.
    
    Returns:
    
    the value of the LINKS_PROPERTY property.
  - getLogos
```
public List<TLcdAtomLogo> getLogos()
```
    Returns the value of the property that maps to the logo element.
    
    Returns:
    
    the value of the LOGOS_PROPERTY property.
  - getRights
```
public List<TLcdAtomText> getRights()
```
    Returns the value of the property that maps to the rights element.
    
    Returns:
    
    the value of the RIGHTS_PROPERTY property.
  - getSubtitles
```
public List<TLcdAtomText> getSubtitles()
```
    Returns the value of the property that maps to the subtitle element.
    
    Returns:
    
    the value of the SUBTITLES_PROPERTY property.
  - getTitles
```
public List<TLcdAtomText> getTitles()
```
    Returns the value of the property that maps to the title element.
    Contains a human readable title for the feed. Often the same as the title of the associated website.
    
    Returns:
    
    the value of the TITLES_PROPERTY property.
  - getUpdated
```
public List<TLcdAtomDateTime> getUpdated()
```
    Returns the value of the property that maps to the updated element.
    Indicates the last time the feed was modified in a significant way.
    
    Returns:
    
    the value of the UPDATED_PROPERTY property.
  - getAny
```
public List<Object> getAny()
```
    Returns the value of the any property.
    
    Returns:
    
    the value of the ANY_PROPERTY property.
  - getEntries
```
public List<TLcdAtomEntry> getEntries()
```
    Returns the value of the property that maps to the entry element.
    
    Returns:
    
    the value of the ENTRIES_PROPERTY property.

LuciadLightspeedClass TLcdAtomFeed

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Field Detail

BASE_PROPERTY

LANGUAGE_PROPERTY

AUTHORS_PROPERTY

CATEGORIES_PROPERTY

CONTRIBUTORS_PROPERTY

GENERATORS_PROPERTY

ICONS_PROPERTY

IDS_PROPERTY

LINKS_PROPERTY

LOGOS_PROPERTY

RIGHTS_PROPERTY

SUBTITLES_PROPERTY

TITLES_PROPERTY

UPDATED_PROPERTY

ANY_PROPERTY

ENTRIES_PROPERTY

Constructor Detail

TLcdAtomFeed

TLcdAtomFeed

Method Detail

getBase

setBase

getLanguage

setLanguage

getAuthors

getCategories

getContributors

getGenerators

getIcons

getIds

getLinks

getLogos

getRights

getSubtitles

getTitles

getUpdated

getAny

getEntries