org.corpus_tools.peppermodules.mergingModules

Class Merger

java.lang.Object

org.corpus_tools.pepper.impl.PepperModuleImpl

org.corpus_tools.pepper.impl.PepperManipulatorImpl

org.corpus_tools.peppermodules.mergingModules.Merger

All Implemented Interfaces:

Thread.UncaughtExceptionHandler, org.corpus_tools.pepper.modules.PepperManipulator, org.corpus_tools.pepper.modules.PepperModule

public class Merger
extends org.corpus_tools.pepper.impl.PepperManipulatorImpl
implements org.corpus_tools.pepper.modules.PepperManipulator

Version:

1.0

Author:

Florian Zipser

Field Summary

Fields

Modifier and Type	Field and Description
protected org.corpus_tools.peppermodules.mergingModules.Merger.Multimap	mappingTable a map containing all mapping partners (SCorpus and SDocument nodes) corresponding to their sId.
static String	MODULE_NAME

Fields inherited from class org.corpus_tools.pepper.impl.PepperModuleImpl

isMultithreaded, moduleController, resources, saltProject, sCorpusGraph, symbolicName, temproraries

Fields inherited from interface org.corpus_tools.pepper.modules.PepperModule

ENDING_ALL_FILES, ENDING_FOLDER, ENDING_LEAF_FOLDER, ENDING_TAB, ENDING_TXT, ENDING_XML

Constructor Summary

Constructors

Constructor and Description
Merger()

Method Summary

Modifier and Type	Method and Description
protected void	createMapping() Creates a table of type Multimap, which contains a slot of matching elements as value.
org.corpus_tools.pepper.modules.PepperMapper	createPepperMapper(org.corpus_tools.salt.graph.Identifier sElementId) Creates a PepperMapper of type MergerMapper.
void	end() Removes all corpus-structures except the base corpus-structure
org.corpus_tools.salt.common.SCorpusGraph	getBaseCorpusStructure() Returns the SCorpusGraph is the base corpus graph, in which everything has to be merged in.
boolean	isReadyToStart()
List<org.corpus_tools.salt.graph.Identifier>	proposeImportOrder(org.corpus_tools.salt.common.SCorpusGraph sCorpusGraph) Creates an import order for each SCorpusGraph object.
void	releaseMergerMapper() Reduces the internal count of active mappers by one.
void	setBaseCorpusStructure(org.corpus_tools.salt.common.SCorpusGraph baseCorpusStructure) Sets the SCorpusGraph is the base corpus graph, in which everything has to be merged in.
void	start() Overrides parent method, to enable the parallel working in more than one DocumentController objects at a time.

Methods inherited from class org.corpus_tools.pepper.impl.PepperModuleImpl

activate, done, done, getComponentContext, getCorpusGraph, getDesc, getDocumentId2DC, getFingerprint, getMapperControllers, getMapperThreadGroup, getModuleController, getModuleType, getName, getProgress, getProgress, getProperties, getResources, getSaltProject, getSelfTestDesc, getStartProblems, getSupplierContact, getSupplierHomepage, getSymbolicName, getTemproraries, getVersion, isMultithreaded, setCorpusGraph, setDesc, setIsMultithreaded, setMapperThreadGroup, setName, setPepperModuleController_basic, setPepperModuleController, setProperties, setResources, setSaltProject, setSupplierContact, setSupplierHomepage, setSymbolicName, setTemproraries, setVersion, start, toString, uncaughtException

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.corpus_tools.pepper.modules.PepperModule

done, done, getComponentContext, getCorpusGraph, getDesc, getFingerprint, getModuleController, getModuleType, getName, getProgress, getProgress, getProperties, getResources, getSaltProject, getSelfTestDesc, getStartProblems, getSupplierContact, getSupplierHomepage, getSymbolicName, getTemproraries, getVersion, isMultithreaded, setCorpusGraph, setDesc, setIsMultithreaded, setPepperModuleController_basic, setPepperModuleController, setProperties, setResources, setSaltProject, setSupplierContact, setSupplierHomepage, setSymbolicName, setTemproraries, setVersion, start

Field Detail

MODULE_NAME

public static final String MODULE_NAME

See Also:

Constant Field Values

mappingTable

protected org.corpus_tools.peppermodules.mergingModules.Merger.Multimap mappingTable

a map containing all mapping partners (SCorpus and SDocument nodes) corresponding to their sId.

Constructor Detail

Merger

public Merger()

Method Detail

isReadyToStart

public boolean isReadyToStart()

Specified by:

isReadyToStart in interface org.corpus_tools.pepper.modules.PepperModule

Overrides:

isReadyToStart in class org.corpus_tools.pepper.impl.PepperModuleImpl

getBaseCorpusStructure

public org.corpus_tools.salt.common.SCorpusGraph getBaseCorpusStructure()

Returns the SCorpusGraph is the base corpus graph, in which everything has to be merged in.

Returns:

setBaseCorpusStructure

public void setBaseCorpusStructure(org.corpus_tools.salt.common.SCorpusGraph baseCorpusStructure)

Sets the SCorpusGraph is the base corpus graph, in which everything has to be merged in.

Parameters:

baseCorpusStructure -

createMapping

protected void createMapping()

Creates a table of type Multimap, which contains a slot of matching elements as value. The key is the Identifier. Only real existing elements are contained in table.

proposeImportOrder

public List<org.corpus_tools.salt.graph.Identifier> proposeImportOrder(org.corpus_tools.salt.common.SCorpusGraph sCorpusGraph)

Creates an import order for each SCorpusGraph object. The order for given SCorpusGraph objects is very similar or equal, in case they contain the same SDocuments (the ones to be merged).

Specified by:

proposeImportOrder in interface org.corpus_tools.pepper.modules.PepperModule

Overrides:

proposeImportOrder in class org.corpus_tools.pepper.impl.PepperModuleImpl

releaseMergerMapper

public void releaseMergerMapper()

Reduces the internal count of active mappers by one.

See Also:

waitForMergerMapper()

start

public void start()
           throws org.corpus_tools.pepper.modules.exceptions.PepperModuleException

Overrides parent method, to enable the parallel working in more than one DocumentController objects at a time.

Specified by:

start in interface org.corpus_tools.pepper.modules.PepperModule

Overrides:

start in class org.corpus_tools.pepper.impl.PepperModuleImpl

Throws:

org.corpus_tools.pepper.modules.exceptions.PepperModuleException

end

public void end()
         throws org.corpus_tools.pepper.modules.exceptions.PepperModuleException

Removes all corpus-structures except the base corpus-structure

Specified by:

end in interface org.corpus_tools.pepper.modules.PepperModule

Overrides:

end in class org.corpus_tools.pepper.impl.PepperModuleImpl

Throws:

org.corpus_tools.pepper.modules.exceptions.PepperModuleException

createPepperMapper

public org.corpus_tools.pepper.modules.PepperMapper createPepperMapper(org.corpus_tools.salt.graph.Identifier sElementId)

Creates a PepperMapper of type MergerMapper. Therefore the table givenSlots must contain an entry for the given Identifier. The create methods passes all documents and corpora given in the entire slot to the MergerMapper.

Specified by:

createPepperMapper in interface org.corpus_tools.pepper.modules.PepperModule

Overrides:

createPepperMapper in class org.corpus_tools.pepper.impl.PepperModuleImpl