ca.cbc.sportwire.feed
Interface SportwireFeed

All Known Implementing Classes:

ESPNFeed, ESPNXMLFeed, AFPFeed, TSNFeed

public interface SportwireFeed

SportwireFeed is the generic interface for all stream inputs. The feed must break a continuous feed into a sequence of XML documents. The feed is also asked to give a tag name for the last document delivered (used for log tracing) Created: Mon Nov 12 16:18:00 2001

Version:

$Id: SportwireFeed.java,v 1.8 2002/04/19 20:38:04 garym Exp $

Author:

Gary Lawrence Murphy

Method Summary

java.lang.String	getLastTag() getLastTag returns a meaningful name of the last story read through the Reader
java.lang.String	getStatus() getStatus: return a status string reporting on the state of the feed parser; used by the XMLRPC status monitor
void	skipToNext() Method: 'skipToNext' moves the feed forward to just beyond the next sync-point; after this call, we are ready to read XML docs using the storyReader method
java.io.Reader	storyReader() Method: 'storyReader' returns a Reader over the next story

Method Detail

getStatus

public java.lang.String getStatus()

getStatus: return a status string reporting on the state of the feed parser; used by the XMLRPC status monitor

Returns:

a String value

skipToNext

public void skipToNext()
                throws java.io.IOException

Method: 'skipToNext' moves the feed forward to just beyond the next sync-point; after this call, we are ready to read XML docs using the storyReader method

Throws:

java.io.IOException - if an error occurs

storyReader

public java.io.Reader storyReader()
                           throws java.io.IOException

Method: 'storyReader' returns a Reader over the next story

Returns:

'Reader' value

Throws:

java.io.IOException - if an error occurs

getLastTag

public java.lang.String getLastTag()

getLastTag returns a meaningful name of the last story read through the Reader

Returns:

a String value