cz.cuni.mff.ksi.jinfer.twostep.cleaning.chained
Class ChainedFactory

java.lang.Object
  cz.cuni.mff.ksi.jinfer.twostep.cleaning.chained.ChainedFactory

All Implemented Interfaces:

Capabilities, NamedModule, UserModuleDescription, RegularExpressionCleanerFactory

public class ChainedFactory
extends Object
implements RegularExpressionCleanerFactory

Factory for Chained.

Field Summary

static String	DISPLAY_NAME Name presented to user.
static String	NAME Canonical name.
static String	PROPERTIES_CLEANER_DEFAULT Default cleaner to use in chain when none are selected.
static String	PROPERTIES_COUNT Property name for count of cleaners user selected in a chain.
static String	PROPERTIES_PREFIX Property name prefix for cleaners selected.

Constructor Summary

ChainedFactory()

Method Summary

<T> RegularExpressionCleaner<T>	create() Create cleaner of Regexp.
List<String>	getCapabilities() Returns the list of capabilities (strings) of this module.
String	getDisplayName() Returns a user friendly name of the module.
String	getModuleDescription() Returns the information about this module's inner workings.
String	getName() Returns a user friendly yet unique name of the module.
String	getUserModuleDescription() Text to be displayed to user in properties panel as a moderate description of module.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Canonical name.

See Also:

Constant Field Values

DISPLAY_NAME

public static final String DISPLAY_NAME

Name presented to user.

See Also:

Constant Field Values

PROPERTIES_PREFIX

public static final String PROPERTIES_PREFIX

Property name prefix for cleaners selected.

See Also:

Constant Field Values

PROPERTIES_CLEANER_DEFAULT

public static final String PROPERTIES_CLEANER_DEFAULT

Default cleaner to use in chain when none are selected.

See Also:

Constant Field Values

PROPERTIES_COUNT

public static final String PROPERTIES_COUNT

Property name for count of cleaners user selected in a chain.

See Also:

Constant Field Values

Constructor Detail

ChainedFactory

public ChainedFactory()

Method Detail

create

public <T> RegularExpressionCleaner<T> create()

Description copied from interface: RegularExpressionCleanerFactory

Create cleaner of Regexp.

Specified by:

create in interface RegularExpressionCleanerFactory

Type Parameters:

T - type of symbol around which are regexpes build.

Returns:

cleaner instance

getName

public String getName()

Description copied from interface: NamedModule

Returns a user friendly yet unique name of the module.

Specified by:

getName in interface NamedModule

Returns:

Unique module name.

getModuleDescription

public String getModuleDescription()

Description copied from interface: NamedModule

Returns the information about this module's inner workings. Most of the time will be equal to a call to NamedModule.getDisplayName(), but if the module for example consists of more sub-modules, their names should be listed here.

Specified by:

getModuleDescription in interface NamedModule

Returns:

String describing inner structure of the module.

getCapabilities

public List<String> getCapabilities()

Description copied from interface: Capabilities

Returns the list of capabilities (strings) of this module.

Specified by:

getCapabilities in interface Capabilities

Returns:

List of capability names.

getUserModuleDescription

public String getUserModuleDescription()

Description copied from interface: UserModuleDescription

Text to be displayed to user in properties panel as a moderate description of module. 10-20 lines.

Specified by:

getUserModuleDescription in interface UserModuleDescription

Returns:

getDisplayName

public String getDisplayName()

Description copied from interface: NamedModule

Returns a user friendly name of the module. This name is not neccessary unique.

Specified by:

getDisplayName in interface NamedModule

Returns:

Displayable module name.