Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> fm >> [ transform overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.fm.transform
Interface Transformer  

All Known Implementing Classes:

htmlTransformer

---

public interface Transformer

Abstract class, which defines common behavior for item transformators.

It is desirable to read channel items in various text formats, for example reading item's text from the UNIX CLI in the HTML format doesn't look pleasant. So item transformators transform the RSS channel items into appropriate text format (e.g. HTML, plain text, DocBook).

Nevertheless the output format isn't required to be text, it also may be fmTransofrmer interface defines common behavior for all transformers.

---

Method Summary
com.fm.rss.filter.RssItemFilter	getItemFilter()           Return current item filter
java.lang.Object	getParamValue(java.lang.String param_name)           Get value of the transformer's parameter
void	setItemFilter(com.fm.rss.filter.RssItemFilter f)           Set item filter
void	setParamValue(java.lang.String param_name, java.lang.Object value)           Set value of the transformer's parameter
void	setSourceChannel(com.fm.rss.rssChannel ch)           Set specified RSS channel object as the source for further transformations
java.lang.Object	transform()           Transform prevously specified channel into output format
java.lang.Object	transform(com.fm.rss.rssChannel ch)           Transform specified channel into output format
java.lang.Object	transform(com.fm.rss.rssItem ch)           Transform specified into into output format

 

Method Detail

setSourceChannel

public void setSourceChannel(com.fm.rss.rssChannel ch)

Set specified RSS channel object as the source for further transformations

---

getParamValue

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

Get value of the transformer's parameter

---

setParamValue

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

Set value of the transformer's parameter

---

transform

public java.lang.Object transform()
                           throws fmTransformException

Transform prevously specified channel into output format

---

transform

public java.lang.Object transform(com.fm.rss.rssChannel ch)
                           throws fmTransformException

Transform specified channel into output format

---

transform

public java.lang.Object transform(com.fm.rss.rssItem ch)
                           throws fmTransformException

Transform specified into into output format

---

setItemFilter

public void setItemFilter(com.fm.rss.filter.RssItemFilter f)

Set item filter

---

getItemFilter

public com.fm.rss.filter.RssItemFilter getItemFilter()

Return current item filter

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> fm >> [ transform overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---