org.nuiton.rss
Class RSSGenerator

java.lang.Object
  org.nuiton.rss.RSSGenerator

public class RSSGenerator
extends java.lang.Object

generator of rss feeds to be stored in a file

Author:

tony

Field Summary

static java.text.DateFormat	DATE_PARSER date formater use to save date in feed and entries
protected java.util.EnumMap<Field,java.lang.String>	feedProperties dictonnary of field <-> property for feed
protected FeedType	format feed format to use
protected java.io.File	generatorDirectory directory where feeds are stored
protected java.util.EnumMap<Field,java.lang.String>	itemProperties dictonnary of field <-> property for entry
protected int	nbItems number of feed to use by default

Constructor Summary

protected	RSSGenerator()
protected	RSSGenerator(java.util.EnumMap<Field,java.lang.String> feedProperties, java.util.EnumMap<Field,java.lang.String> itemProperties, java.io.File generatorDirectory, FeedType format, int nbItems)
protected	RSSGenerator(java.io.File generatorDirectory)

Method Summary

protected java.nio.channels.FileLock	acquireLock(java.io.File f)
void	addItemToFeedFile(java.net.URL url, int nbEntries, java.util.Map<Field,java.lang.Object> values) Add a item to an existing feed file.
void	createFeedFile(java.net.URL url, FeedType type, java.util.Map<Field,java.lang.Object> values)
void	deleteFeedFile(java.net.URL toURL)
java.io.File	getFeedFile(java.lang.String name)
protected java.io.File	getFile(java.net.URL url) Obtain the file from his url location.
FeedType	getFormat()
java.io.File	getGeneratorDirectory()
int	getNbItems()
protected java.io.File	getWriteFileLock(java.io.File f)
static RSSGenerator	newDefaultInstance()
protected void	releaseLock(java.io.File f, java.nio.channels.FileLock lock)
java.util.EnumSet<Field>	updateFeedFile(java.net.URL url, java.util.Map<Field,java.lang.Object> values)

Methods inherited from class java.lang.Object

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

Field Detail

DATE_PARSER

public static final java.text.DateFormat DATE_PARSER

date formater use to save date in feed and entries

feedProperties

protected final java.util.EnumMap<Field,java.lang.String> feedProperties

dictonnary of field <-> property for feed

itemProperties

protected final java.util.EnumMap<Field,java.lang.String> itemProperties

dictonnary of field <-> property for entry

generatorDirectory

protected final java.io.File generatorDirectory

directory where feeds are stored

format

protected final FeedType format

feed format to use

nbItems

protected final int nbItems

number of feed to use by default

Constructor Detail

RSSGenerator

protected RSSGenerator()

RSSGenerator

protected RSSGenerator(java.util.EnumMap<Field,java.lang.String> feedProperties,
                       java.util.EnumMap<Field,java.lang.String> itemProperties,
                       java.io.File generatorDirectory,
                       FeedType format,
                       int nbItems)

RSSGenerator

protected RSSGenerator(java.io.File generatorDirectory)

Method Detail

newDefaultInstance

public static RSSGenerator newDefaultInstance()
                                       throws java.lang.Exception

Returns:

une nouvelle instance de RssHelper en utilisant les implantations definies dans RSSGeneratorConfig.

Throws:

java.lang.Exception - pour tout pb lors de l'instanciation des objects

createFeedFile

public void createFeedFile(java.net.URL url,
                           FeedType type,
                           java.util.Map<Field,java.lang.Object> values)
                    throws java.io.IOException,
                           com.sun.syndication.io.FeedException,
                           java.text.ParseException

Parameters:

url - location where to create the file

type - fromat of feed to create

values - properties of the feed

Throws:

java.text.ParseException - if pb while parsing date

java.io.IOException - if io pb

com.sun.syndication.io.FeedException - if pb while creating feed

addItemToFeedFile

public void addItemToFeedFile(java.net.URL url,
                              int nbEntries,
                              java.util.Map<Field,java.lang.Object> values)
                       throws java.io.IOException,
                              com.sun.syndication.io.FeedException,
                              java.text.ParseException

Add a item to an existing feed file.

Parameters:

url - location of feed to used

nbEntries - number of maximum entries to be written in feed file

values - dictionnary of properties to write

Throws:

com.sun.syndication.io.FeedException - if feed pb

java.io.IOException - if io pb

java.text.ParseException - if dateparser pb

deleteFeedFile

public void deleteFeedFile(java.net.URL toURL)

updateFeedFile

public java.util.EnumSet<Field> updateFeedFile(java.net.URL url,
                                               java.util.Map<Field,java.lang.Object> values)
                                        throws java.io.IOException,
                                               com.sun.syndication.io.FeedException,
                                               java.text.ParseException

Parameters:

url -

values -

Returns:

the set of modified fields.

Throws:

java.io.IOException

com.sun.syndication.io.FeedException

java.text.ParseException

getFormat

public FeedType getFormat()

getFeedFile

public java.io.File getFeedFile(java.lang.String name)

getNbItems

public int getNbItems()

getFile

protected java.io.File getFile(java.net.URL url)
                        throws java.lang.IllegalStateException

Obtain the file from his url location.

Parameters:

url - location of the file

Returns:

the file

Throws:

java.lang.IllegalStateException - if uri is not sytax valid

acquireLock

protected java.nio.channels.FileLock acquireLock(java.io.File f)
                                          throws java.io.IOException

Throws:

java.io.IOException

getWriteFileLock

protected java.io.File getWriteFileLock(java.io.File f)

releaseLock

protected void releaseLock(java.io.File f,
                           java.nio.channels.FileLock lock)
                    throws java.io.IOException

Throws:

java.io.IOException

getGeneratorDirectory

public java.io.File getGeneratorDirectory()