de.nava.informa.core
Interface ChannelBuilderIF

All Known Implementing Classes:

ChannelBuilder, ChannelBuilder

public interface ChannelBuilderIF

This interface allows the channel generators (like a parser) to create the channel object model independent from which implementation is used (in-memory or persistent store).

Author:

Niko Schmuck (niko@nava.de)

Method Summary

void	beginTransaction()
void	close() Closes the builder.
CategoryIF	createCategory(CategoryIF parent, String title)
ChannelIF	createChannel(org.jdom.Element channelElement, String title)
ChannelIF	createChannel(org.jdom.Element channelElement, String title, String location)
ChannelIF	createChannel(String title)
ChannelIF	createChannel(String title, String location)
ChannelGroupIF	createChannelGroup(String title)
CloudIF	createCloud(String domain, int port, String path, String registerProcedure, String protocol)
ImageIF	createImage(String title, URL location, URL link)
ItemIF	createItem(ChannelIF channel, ItemIF item)
ItemIF	createItem(ChannelIF channel, String title, String description, URL link) Creates a news item and assign it to the given channel.
ItemIF	createItem(org.jdom.Element itemElement, ChannelIF channel, String title, String description, URL link)
ItemEnclosureIF	createItemEnclosure(ItemIF item, URL location, String type, int length)
ItemGuidIF	createItemGuid(ItemIF item, String location, boolean permaLink)
ItemSourceIF	createItemSource(ItemIF item, String name, String location, Date timestamp)
TextInputIF	createTextInput(String title, String description, String name, URL link)
void	endTransaction()
void	init(Properties props) Sets the runtime properties defined for this channel builder.
void	update(Object o)

Method Detail

init

void init(Properties props)
          throws ChannelBuilderException

Sets the runtime properties defined for this channel builder. This method will be invoked by the ChannelBuilderFactory when the ChannelBuilder is first created.

Parameters:

props - The parsed set of properties which may be applied to this object.

Throws:

ChannelBuilderException - If the initialisation fails for some reason.

createChannelGroup

ChannelGroupIF createChannelGroup(String title)

createChannel

ChannelIF createChannel(String title)

createChannel

ChannelIF createChannel(String title,
                        String location)

createChannel

ChannelIF createChannel(org.jdom.Element channelElement,
                        String title)

createChannel

ChannelIF createChannel(org.jdom.Element channelElement,
                        String title,
                        String location)

createItem

ItemIF createItem(ChannelIF channel,
                  String title,
                  String description,
                  URL link)

Creates a news item and assign it to the given channel.

createItem

ItemIF createItem(org.jdom.Element itemElement,
                  ChannelIF channel,
                  String title,
                  String description,
                  URL link)

createItem

ItemIF createItem(ChannelIF channel,
                  ItemIF item)

createImage

ImageIF createImage(String title,
                    URL location,
                    URL link)

createTextInput

TextInputIF createTextInput(String title,
                            String description,
                            String name,
                            URL link)

createItemSource

ItemSourceIF createItemSource(ItemIF item,
                              String name,
                              String location,
                              Date timestamp)

createItemEnclosure

ItemEnclosureIF createItemEnclosure(ItemIF item,
                                    URL location,
                                    String type,
                                    int length)

createItemGuid

ItemGuidIF createItemGuid(ItemIF item,
                          String location,
                          boolean permaLink)

createCloud

CloudIF createCloud(String domain,
                    int port,
                    String path,
                    String registerProcedure,
                    String protocol)

createCategory

CategoryIF createCategory(CategoryIF parent,
                          String title)

close

void close()
           throws ChannelBuilderException

Closes the builder. After this call, all references to any channel objects provided by this ChannelBuilder are invalidated. If the ChannelBuilder has a connection to a persistant store such as a database, connections may be closed.

Throws:

ChannelBuilderException

beginTransaction

void beginTransaction()
                      throws ChannelBuilderException

Throws:

ChannelBuilderException

endTransaction

void endTransaction()
                    throws ChannelBuilderException

Throws:

ChannelBuilderException

update

void update(Object o)
            throws ChannelBuilderException

Throws:

ChannelBuilderException