nz.ac.waikato.mcennis.rat.crawler.filter
Class CrawlerFilterFactory

java.lang.Object
  nz.ac.waikato.mcennis.rat.AbstractFactory<CrawlerFilter>
      nz.ac.waikato.mcennis.rat.crawler.filter.CrawlerFilterFactory

public class CrawlerFilterFactory
extends AbstractFactory<CrawlerFilter>

Factory class for classes implementing the CrawlerFilter interface.

• Parameter Name:
  • Human readable descrpition of this class of object
  • String Object
  • max: 1
  • min: 1
  • Preset to 'Crawler Filter Factory'
• Parameter CrawlerFilterClass:
  • Default filter class whe constructing objects
  • String Object
  • max: 1
  • min: 1
  • Preset to 'Null Filter'

Field Summary

static CrawlerFilterFactory	instance
static boolean	isInitialized

Fields inherited from class nz.ac.waikato.mcennis.rat.AbstractFactory

map, properties

Method Summary

CrawlerFilter	create(Properties props) Create the given object using the settings in the Properties object.
CrawlerFilter	create(java.lang.String filterName) FIXME: Implement CrawlerFilterFactory.create()
CrawlerFilter	create(java.lang.String filterName, Properties props)
Parameter	getClassParameter() Return the parameter containing the name of the default type produced by this object.
static void	initialization() Perform the initialization of this factory.
static CrawlerFilterFactory	newInstance() Get an instance of CrawlerFilterFactory, creating and initializing it as necessary.

Methods inherited from class nz.ac.waikato.mcennis.rat.AbstractFactory

addDefaultProperty, addType, check, check, getKnownTypes, getParameter, getParameter, setDefaultProperty

Methods inherited from class java.lang.Object

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

Field Detail

instance

public static CrawlerFilterFactory instance

isInitialized

public static boolean isInitialized

Method Detail

initialization

public static void initialization()

Perform the initialization of this factory. May be called by other factories with dependencies on this factory.

newInstance

public static CrawlerFilterFactory newInstance()

Get an instance of CrawlerFilterFactory, creating and initializing it as necessary.

Returns:

singleton factory for CrawlerFilters

create

public CrawlerFilter create(Properties props)

Description copied from class: AbstractFactory

Create the given object using the settings in the Properties object. This function is the only global creation object, but each factory should also define a more user-friendly version consisting of a set of commonly used creation parameters as well as a version combining commonly used features with a Properties object. The property may be null. if the creation fails, the factory should log to the Logger the explanation and return null. If at all possible, the factory should provide a reasonable fail-over value rather than return null.

Specified by:

create in class AbstractFactory<CrawlerFilter>

Parameters:

props - parameters used to control the factory.

Returns:

newly created object or null

create

public CrawlerFilter create(java.lang.String filterName)

FIXME: Implement CrawlerFilterFactory.create()

Parameters:

filterName -

Returns:

create

public CrawlerFilter create(java.lang.String filterName,
                            Properties props)

Parameters:

filterName -

props -

Returns:

getClassParameter

public Parameter getClassParameter()

Description copied from class: AbstractFactory

Return the parameter containing the name of the default type produced by this object. The parameter will have exactly one value of type String. The type name of this parameter is the type that controls which class of object is produced.

Specified by:

getClassParameter in class AbstractFactory<CrawlerFilter>

Returns:

parameter containing the default type.