nz.ac.waikato.mcennis.rat.parser
Interface Parser

All Known Implementing Classes:

AbstractParser, BaseHTMLParser, ISMIRBibtexParser, LastFmBasicArtistParser, LinkTest, NullParser, ToFileParser, XMLParser

public interface Parser

This interface decsribes classes that transforms a data stream into objects.

Method Summary

boolean	check(Parameter parameter)
boolean	check(Properties parameters)
Parser	duplicate() Create an exact copy of this object
ParsedObject	get() Get the object created by this parser
java.lang.String	getName()
Properties	getParameter()
Parameter	getParameter(java.lang.String parameter)
void	init(Properties parameters)
void	parse(java.io.InputStream data, Crawler crawler, Properties properties) Parse an input stream into its components, spidering using the given crawler
void	parse(java.io.InputStream data, Properties properties) Parse an input stream into its components
void	set(ParsedObject o) Set the parsed object to be loaded
void	setName(java.lang.String name) Give this parser an id that should be globally unique

Method Detail

parse

void parse(java.io.InputStream data,
           Properties properties)
           throws java.lang.Exception

Parse an input stream into its components

Parameters:

data - data stream to be read

Throws:

java.lang.Exception

parse

void parse(java.io.InputStream data,
           Crawler crawler,
           Properties properties)
           throws java.lang.Exception

Parse an input stream into its components, spidering using the given crawler

Parameters:

data -

crawler -

Throws:

java.lang.Exception

duplicate

Parser duplicate()

Create an exact copy of this object

Returns:

new Parser object

get

ParsedObject get()

Get the object created by this parser

Returns:

parsed object

set

void set(ParsedObject o)

Set the parsed object to be loaded

Parameters:

o - object to be loaded

setName

void setName(java.lang.String name)

Give this parser an id that should be globally unique

Parameters:

name - id for this parser

getName

java.lang.String getName()

init

void init(Properties parameters)

getParameter

Properties getParameter()

getParameter

Parameter getParameter(java.lang.String parameter)

check

boolean check(Properties parameters)

check

boolean check(Parameter parameter)