cz.cuni.mff.ksi.jinfer.twostep.processing.passrepresentant
Class PassRepresentantFactory

java.lang.Object
  cz.cuni.mff.ksi.jinfer.twostep.processing.passrepresentant.PassRepresentantFactory

All Implemented Interfaces:

Capabilities, NamedModule, UserModuleDescription, ClusterProcessorFactory

public class PassRepresentantFactory
extends Object
implements ClusterProcessorFactory

Factory class for PassRepresentant.

Field Summary

static String	DISPLAY_NAME Name presented to user.
static String	NAME Canonical name.

Constructor Summary

PassRepresentantFactory()

Method Summary

ClusterProcessor<AbstractStructuralNode>	create() Creates new worker instance.
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

Constructor Detail

PassRepresentantFactory

public PassRepresentantFactory()

Method Detail

create

public ClusterProcessor<AbstractStructuralNode> create()

Description copied from interface: ClusterProcessorFactory

Creates new worker instance.

Specified by:

create in interface ClusterProcessorFactory

Returns:

cluster processor worker 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.

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:

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.

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.