eteg.sinon.core
Class Catalog

java.lang.Object
  eteg.sinon.core.Catalog

public class Catalog
extends java.lang.Object

Class that represents a catalog in Sinon. In other words, a catalog is a definition of how the extraction of some data is made in some Web site.

Version:

$Revision: 1.2 $

Author:

Thiago H. de Paula Figueiredo, Last modified by $Author: thiagohp $

Constructor Summary

Catalog()
Contructors with no parameters.

Method Summary

void	addDataExtraction(DataExtraction dataExtraction) Adds a global DataExtraction to this catalog.
void	addPage(Page page) Adds a Page to this catalog.
void	addParameterSet(ParameterSet parameterSet) Adds a ParameterSet to this catalog.
void	addStartPage(StartPage startPage) Adds a StartPage to this catalog.
CollectorConfiguration	getConfiguration() Returns the value of the configuration property.
DataExtraction	getDataExtraction(java.lang.String id) Returns the DataExtraction whose identifier is id.
DataExtraction[]	getDataExtractions() Returns the value of the dataExtractions property.
java.lang.String	getId() Returns the value of the id property.
Page	getPage(java.lang.String id) Returns the Page whose identifier is id.
Page[]	getPages() Returns the value of the pages property.
ParameterSet	getParameterSet(java.lang.String id) Returns the ParameterSet whose identifier is id.
ParameterSet[]	getParameterSets() Returns the value of the parameterSets property.
java.util.Properties	getProperties() Returns the value of the properties property.
StartPage[]	getStartPages() Returns the value of the startPages property.
void	removeDataExtraction(DataExtraction dataExtraction) Removes a global DataExtraction from this catalog.
void	removePage(Page page) Removes a Page from this catalog.
void	removeParameterSet(ParameterSet parameterSet) Removes a ParameterSet from this catalog.
void	removeStartPage(StartPage startPage) Removes a StartPage from this catalog.
void	setConfiguration(CollectorConfiguration configuration) Sets the value of the configuration property.
void	setId(java.lang.String id) Sets the value of the id property.

Methods inherited from class java.lang.Object

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

Constructor Detail

Catalog

public Catalog()

Contructors with no parameters.

Method Detail

getId

public java.lang.String getId()

Returns the value of the id property.

Returns:

a String.

setId

public void setId(java.lang.String id)

Sets the value of the id property.

Parameters:

id - the new id value.

getConfiguration

public CollectorConfiguration getConfiguration()

Returns the value of the configuration property.

Returns:

a CollectorConfiguration.

setConfiguration

public void setConfiguration(CollectorConfiguration configuration)

Sets the value of the configuration property.

Parameters:

configuration - the new CollectorConfiguration value.

addParameterSet

public void addParameterSet(ParameterSet parameterSet)

Adds a ParameterSet to this catalog.

Parameters:

parameterSet - a ParameterSet instance.

removeParameterSet

public void removeParameterSet(ParameterSet parameterSet)

Removes a ParameterSet from this catalog.

Parameters:

parameterSet - a ParameterSet instance.

getParameterSets

public ParameterSet[] getParameterSets()

Returns the value of the parameterSets property.

Returns:

a ParameterSet array.

getParameterSet

public ParameterSet getParameterSet(java.lang.String id)

Returns the ParameterSet whose identifier is id.

Parameters:

id - a String.

Returns:

a ParameterSet instance or null if there is no ParameterSet whose identifier is id.

Throws:

java.lang.IllegalArgumentException - if id is null.

addPage

public void addPage(Page page)

Adds a Page to this catalog.

Parameters:

page - a Page instance.

removePage

public void removePage(Page page)

Removes a Page from this catalog.

Parameters:

page - a Page instance.

getPages

public Page[] getPages()

Returns the value of the pages property.

Returns:

a String.

getPage

public Page getPage(java.lang.String id)

Returns the Page whose identifier is id.

Parameters:

id - a String.

Returns:

a Page instance or null if there is no Page whose identifier is id.

Throws:

java.lang.IllegalArgumentException - if id is null.

addStartPage

public void addStartPage(StartPage startPage)

Adds a StartPage to this catalog.

Parameters:

startPage - a StartPage instance.

removeStartPage

public void removeStartPage(StartPage startPage)

Removes a StartPage from this catalog.

Parameters:

startPage - a StartPage instance.

getStartPages

public StartPage[] getStartPages()

Returns the value of the startPages property.

Returns:

a String.

addDataExtraction

public void addDataExtraction(DataExtraction dataExtraction)

Adds a global DataExtraction to this catalog.

Parameters:

dataExtraction - a DataExtraction instance..

removeDataExtraction

public void removeDataExtraction(DataExtraction dataExtraction)

Removes a global DataExtraction from this catalog.

Parameters:

dataExtraction - a DataExtraction instance..

getDataExtraction

public DataExtraction getDataExtraction(java.lang.String id)

Returns the DataExtraction whose identifier is id.

Parameters:

id - a String.

Returns:

a DataExtraction instance or null if there is no DataExtraction whose identifier is id.

Throws:

java.lang.IllegalArgumentException - if id is null.

getDataExtractions

public DataExtraction[] getDataExtractions()

Returns the value of the dataExtractions property.

Returns:

a DataExtraction array.

getProperties

public java.util.Properties getProperties()

Returns the value of the properties property.

Returns:

a Properties instance.