de.nava.informa.core
Interface ChannelIF

All Superinterfaces:

ChannelObservableIF, Serializable, WithCategoriesMIF, WithCreatorMIF, WithDescriptionMIF, WithElementsAndAttributesMIF, WithIdMIF, WithLocationMIF, WithSiteMIF, WithTitleMIF

All Known Implementing Classes:

Channel, Channel, Channel

public interface ChannelIF
extends WithIdMIF, WithTitleMIF, WithElementsAndAttributesMIF, WithLocationMIF, WithCreatorMIF, WithCategoriesMIF, WithDescriptionMIF, WithSiteMIF, ChannelObservableIF

This interface is implemented by objects representing channels in the news channel object model.

Author:

Niko Schmuck (niko@nava.de)

Method Summary

void	addItem(ItemIF item)
CloudIF	getCloud()
String	getDocs()
ChannelFormat	getFormat() Gets the syntax format used by the channel.
String	getGenerator()
ImageIF	getImage() Retrieves the Image associated with this feed.
ItemIF	getItem(long id) Returns the news item as specified by the item identifier (WithIdMIF.getId()).
Set<ItemIF>	getItems()
String	getLanguage()
Date	getLastBuildDate()
Date	getLastUpdated() Returns that date and time at which the feed was parsed and the channel object was updated (or created) from feed XML content
Date	getPubDate()
String	getPublisher()
String	getRating()
TextInputIF	getTextInput()
int	getTtl()
Date	getUpdateBase() Accesses data provided by the Syndication module (will apply only to RSS 1.0+).
int	getUpdateFrequency() Accesses data provided by the Syndication module (will apply only to RSS 1.0+).
ChannelUpdatePeriod	getUpdatePeriod() Accesses data provided by the Syndication module (will apply only to RSS 1.0+).
void	removeItem(ItemIF item)
void	setCloud(CloudIF cloud)
void	setDocs(String docs)
void	setFormat(ChannelFormat format)
void	setGenerator(String generator)
void	setImage(ImageIF image) Sets the image for this feed
void	setLanguage(String language)
void	setLastBuildDate(Date lastBuild)
void	setLastUpdated(Date lastUpdated) see getLastUpdated()
void	setPubDate(Date pubDate)
void	setPublisher(String publisher)
void	setRating(String rating)
void	setTextInput(TextInputIF textInput)
void	setTtl(int ttl)
void	setUpdateBase(Date updateBase) Sets the base time against which update times should be calculated
void	setUpdateFrequency(int updateFrequency) Sets the number of times during updatePeriod that the feed should be updated
void	setUpdatePeriod(ChannelUpdatePeriod updatePeriod) Sets the update frequency for the feed.

Methods inherited from interface de.nava.informa.core.WithIdMIF

getId, setId

Methods inherited from interface de.nava.informa.core.WithTitleMIF

getTitle, setTitle

Methods inherited from interface de.nava.informa.core.WithElementsAndAttributesMIF

getAttributeValue, getAttributeValues, getElementValue, getElementValues

Methods inherited from interface de.nava.informa.core.WithLocationMIF

getLocation, setLocation

Methods inherited from interface de.nava.informa.core.WithCreatorMIF

getCreator, setCreator

Methods inherited from interface de.nava.informa.core.WithCategoriesMIF

addCategory, getCategories, removeCategory, setCategories

Methods inherited from interface de.nava.informa.core.WithDescriptionMIF

getDescription, setDescription

Methods inherited from interface de.nava.informa.core.WithSiteMIF

getCopyright, getSite, setCopyright, setSite

Methods inherited from interface de.nava.informa.core.ChannelObservableIF

addObserver, removeObserver

Method Detail

getLanguage

String getLanguage()

setLanguage

void setLanguage(String language)

getPublisher

String getPublisher()

setPublisher

void setPublisher(String publisher)

getRating

String getRating()

setRating

void setRating(String rating)

getGenerator

String getGenerator()

setGenerator

void setGenerator(String generator)

getDocs

String getDocs()

setDocs

void setDocs(String docs)

getTtl

int getTtl()

setTtl

void setTtl(int ttl)

getFormat

ChannelFormat getFormat()

Gets the syntax format used by the channel.

Returns:

The format of the channel as specified by the constants in ChannelFormat.

setFormat

void setFormat(ChannelFormat format)

getItems

Set<ItemIF> getItems()

Returns:

An set of ItemIF objects.

addItem

void addItem(ItemIF item)

removeItem

void removeItem(ItemIF item)

getItem

ItemIF getItem(long id)

Returns the news item as specified by the item identifier (WithIdMIF.getId()).

Parameters:

id - the Item's id.

Returns:

the Item

getImage

ImageIF getImage()

Retrieves the Image associated with this feed. Optional

Returns:

An ImageIF representing the image associated with this feed

setImage

void setImage(ImageIF image)

Sets the image for this feed

Parameters:

image - The image

getTextInput

TextInputIF getTextInput()

setTextInput

void setTextInput(TextInputIF textInput)

getLastUpdated

Date getLastUpdated()

Returns that date and time at which the feed was parsed and the channel object was updated (or created) from feed XML content

setLastUpdated

void setLastUpdated(Date lastUpdated)

see getLastUpdated()

getLastBuildDate

Date getLastBuildDate()

setLastBuildDate

void setLastBuildDate(Date lastBuild)

getPubDate

Date getPubDate()

setPubDate

void setPubDate(Date pubDate)

getCloud

CloudIF getCloud()

setCloud

void setCloud(CloudIF cloud)

getUpdatePeriod

ChannelUpdatePeriod getUpdatePeriod()

Accesses data provided by the Syndication module (will apply only to RSS 1.0+). The return type will be one of:

• ChannelUpdatePeriod.UPDATE_HOURLY
• ChannelUpdatePeriod.UPDATE_DAILY
• ChannelUpdatePeriod.UPDATE_WEEKLY
• ChannelUpdatePeriod.UPDATE_MONTHLY
• ChannelUpdatePeriod.UPDATE_YEARLY
• ChannelUpdatePeriod.UNDEFINED - if tag not present in the RSS file

Returns:

see above

setUpdatePeriod

void setUpdatePeriod(ChannelUpdatePeriod updatePeriod)

Sets the update frequency for the feed. This information will be stored according to the Syndication Module tags. updateFrequency should be one of:

• UPDATE_HOURLY
• UPDATE_DAILY
• UPDATE_WEEKLY
• UPDATE_MONTHLY
• UPDATE_YEARLY
• Null if tag not present in the RSS file

Parameters:

updatePeriod - See above

getUpdateFrequency

int getUpdateFrequency()

Accesses data provided by the Syndication module (will apply only to RSS 1.0+). Returns the number of times during the updatePeriod that a feed should be updated

Returns:

The number of times during updatePeriod to update the feed

See Also:

setUpdatePeriod(de.nava.informa.core.ChannelUpdatePeriod), getUpdatePeriod()

setUpdateFrequency

void setUpdateFrequency(int updateFrequency)

Sets the number of times during updatePeriod that the feed should be updated

Parameters:

updateFrequency - number of times during updatePeriod to update the feed

getUpdateBase

Date getUpdateBase()

Accesses data provided by the Syndication module (will apply only to RSS 1.0+). Provides the base date against which to determine the next time to update the feed.

Returns:

The date from which the next update times should be calculated

setUpdateBase

void setUpdateBase(Date updateBase)

Sets the base time against which update times should be calculated

Parameters:

updateBase - The base date for updates