ChannelStorage

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> fm >> [ rss overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.fm.rss
Interface ChannelStorage

All Known Implementing Classes:: fsChannelStorage

public interface ChannelStorage

Defines interface required from the channel storage.

ChannelStorage interface also defines the way storage parameters should be set. This should be done through setParamVaslue and getParamVaslue. All parameters names and values are storage implementation specific except for two names: SOURCE and DESTINATION. These names are reserved to be a names for a channel's source and destination params name respectively.

Field Summary

static java.lang.String DESTINATION
          Name for the storage destination parameter value

static java.lang.String OUTPUT_FILTER
          Name for output filter parameter value

static java.lang.String SOURCE
          Name for the storage source parameter value

Method Summary

java.util.Map getCategories()
          Return list of the channel categories

java.lang.Object getDefaultSource()
          Return implementation specific default source.

java.lang.Object getParamValue(java.lang.String param)
          Return value of the configuration param.

void load()
          Loads current state from the source

void save()
          Saves current state to destination (destination depends on implementation)

void setCategories(java.util.Map newCats)
          Set list of the existing categories to a given value

void setParamValue(java.lang.String param, java.lang.Object value)
          Set configuration param.

Field Detail

SOURCE

public static final java.lang.String SOURCE

Name for the storage source parameter value

See Also:: Constant Field Values

DESTINATION

public static final java.lang.String DESTINATION

Name for the storage destination parameter value

See Also:: Constant Field Values

OUTPUT_FILTER

public static final java.lang.String OUTPUT_FILTER

Name for output filter parameter value

See Also:: Constant Field Values

Method Detail

getCategories

public java.util.Map getCategories()

Return list of the channel categories

setCategories

public void setCategories(java.util.Map newCats)

Set list of the existing categories to a given value

save

public void save()
          throws java.io.IOException

Saves current state to destination (destination depends on implementation)

load

public void load()
          throws java.io.IOException,
                 rssParseException

Loads current state from the source

setParamValue

public void setParamValue(java.lang.String param,
                          java.lang.Object value)

Set configuration param. All unrecognized params are ignored.

getParamValue

public java.lang.Object getParamValue(java.lang.String param)

Return value of the configuration param. The null will be returned if specified param doesn't exist.

getDefaultSource

public java.lang.Object getDefaultSource()

Return implementation specific default source.

Each storage type may define its own default source. For example file system storage may use string with the default name of file from which contents will be loaded.