modules

Class AbstractModule

java.lang.Object

modules.AbstractModule

Direct Known Subclasses:

AbstractDaemonModule, AbstractEnvironmentModule, AbstractFileDependentModule

public abstract class AbstractModule
extends java.lang.Object

The abstract base class for all attribute extraction modules. The extractors are calling these modules to extract the attributes.

See Also:

Extractor

Field Summary

Fields

Modifier and Type	Field and Description
ModuleConfiguration	config
java.lang.String	moduleName
java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
AbstractModule()

Method Summary

Modifier and Type	Method and Description
ModuleConfiguration	getConfig()
java.lang.String	getHash()
abstract java.lang.String	getModuleDescription()
boolean	isSelected()
void	setConfig(ModuleConfiguration config)
abstract void	setModuleName() By implementing this abstract method the name of the module is specified.
void	setSelected(boolean selected) Change the selection state of this module.
abstract void	setVersion()
boolean	supportsThisOS() The given operating system specifies the kind of external application call and return value parsing.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

config

public ModuleConfiguration config

moduleName

public java.lang.String moduleName

version

public java.lang.String version

Constructor Detail

AbstractModule

public AbstractModule()

Method Detail

getConfig

public ModuleConfiguration getConfig()

setConfig

public void setConfig(ModuleConfiguration config)

setModuleName

public abstract void setModuleName()

By implementing this abstract method the name of the module is specified. Write a method body like {this.moduleName = "NAME";}.

setVersion

public abstract void setVersion()

getModuleDescription

public abstract java.lang.String getModuleDescription()

isSelected

public final boolean isSelected()

Returns:

If the module will be called at the extraction process. Unselected modules are inactive until they are reselected.

setSelected

public void setSelected(boolean selected)

Change the selection state of this module.

Parameters:

selected - setSelected(true) will enable the extraction of this module.

supportsThisOS

public boolean supportsThisOS()

The given operating system specifies the kind of external application call and return value parsing. Returns true, if this algorithm is available for the given operating system. Default is OperatingSystem.OsName.SYSTEM_INDEPENDENT.

Returns:

True, if the module works at the used operating system.

getHash

public java.lang.String getHash()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object