org.corpus_tools.peppermodules.mergingModules

Class MergerMapper

java.lang.Object

org.corpus_tools.pepper.impl.PepperMapperImpl

org.corpus_tools.peppermodules.mergingModules.MergerMapper

All Implemented Interfaces:

org.corpus_tools.pepper.modules.PepperMapper

public class MergerMapper
extends org.corpus_tools.pepper.impl.PepperMapperImpl
implements org.corpus_tools.pepper.modules.PepperMapper

This class does the real merging, the main task is to merge a set of document graphs.

Author:

Mario Frank, Jakob Schmoling, Florian Zipser

Field Summary

Fields

Modifier and Type	Field and Description
protected TokenMergeContainer	container the TokenMergeContainer instance
protected boolean	isTestMode

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

controller, progress, props

Constructor Summary

Constructors

Constructor and Description
MergerMapper()

Method Summary

Modifier and Type	Method and Description
protected boolean	alignTexts(org.corpus_tools.salt.common.STextualDS baseText, org.corpus_tools.salt.common.STextualDS otherText, Set<org.corpus_tools.salt.common.SToken> nonEquivalentTokenInOtherTexts, Map<org.corpus_tools.salt.core.SNode,org.corpus_tools.salt.core.SNode> equivalenceMap) This method aligns the normalized texts of the given STextualDS objects and also aligns the SToken including the creation of equivalent SToken information.
protected org.corpus_tools.pepper.modules.MappingSubject	chooseBaseDocument() Chooses the base SDocument in which all nodes, relations etc.
protected List<Integer>	createBaseTextNormOriginalMapping(org.corpus_tools.salt.common.STextualDS sTextualDS) This method creates a reverse mapping list for the given Text.
org.corpus_tools.salt.common.SCorpusGraph	getBaseCorpusStructure() Returns the SCorpusGraph is the base corpus graph, in which everything has to be merged in.
org.corpus_tools.salt.common.SDocument	getBaseDocument()
TokenMergeContainer	getContainer()
Merger	getMerger()
protected int	indexOfOmitChars(String stringToSearchIn, String stringToSearchFor, boolean useIndexOf, Set<Character> omitChars) This method searches for the first occurence of the stringToSearchFor in the stringToSearchIn and ommits all chars in the omitCharArray.
protected void	initialize() This method initializes the mapping.
org.corpus_tools.pepper.common.DOCUMENT_STATUS	mapSCorpus()
org.corpus_tools.pepper.common.DOCUMENT_STATUS	mapSDocument() This method is called by the Pepper framework and merges a set of given SDocumentGraph objects.
void	mergeDocumentStructures(org.corpus_tools.pepper.modules.MappingSubject baseSubject) Merges all document-structures pairwise by calling mergeDocumentStructures(SDocument, SDocument).
protected void	mergeTokens(org.corpus_tools.salt.common.STextualDS baseText, org.corpus_tools.salt.common.STextualDS otherText, Map<org.corpus_tools.salt.core.SNode,org.corpus_tools.salt.core.SNode> equivalenceMap)
protected void	normalizePrimaryTexts(org.corpus_tools.salt.common.SDocument sDocument) Normalizes all primary texts of the given SDocument.
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	setBaseDocument(org.corpus_tools.salt.common.SDocument baseDocument)
void	setMerger(Merger merger)

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

addProgress, getCorpus, getDocument, getMappingResult, getMappingSubjects, getPepperMapperController, getProgress, getProperties, getResourceURI, readXMLResource, setCorpus, setDocument, setMappingResult, setPepperMapperController, setProgress, setProperties, setResourceURI

Methods inherited from class java.lang.Object

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

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

addProgress, getCorpus, getDocument, getMappingResult, getMappingSubjects, getPepperMapperController, getProgress, getProperties, getResourceURI, setCorpus, setDocument, setMappingResult, setPepperMapperController, setProgress, setProperties, setResourceURI

Field Detail

isTestMode

protected boolean isTestMode

container

protected TokenMergeContainer container

the TokenMergeContainer instance

Constructor Detail

MergerMapper

public MergerMapper()

Method Detail

getMerger

public Merger getMerger()

Returns:

A reference to the Merger object which has invoked this mapper.

setMerger

public void setMerger(Merger merger)

Parameters:

merger - A reference to the Merger object which has invoked this mapper.

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 -

initialize

protected void initialize()

This method initializes the mapping.

Overrides:

initialize in class org.corpus_tools.pepper.impl.PepperMapperImpl

mapSCorpus

public org.corpus_tools.pepper.common.DOCUMENT_STATUS mapSCorpus()

Specified by:

mapSCorpus in interface org.corpus_tools.pepper.modules.PepperMapper

Overrides:

mapSCorpus in class org.corpus_tools.pepper.impl.PepperMapperImpl

getBaseDocument

public org.corpus_tools.salt.common.SDocument getBaseDocument()

Returns:

the SDocument which is the base document. That means, that all document-structures are merged into this document.

setBaseDocument

public void setBaseDocument(org.corpus_tools.salt.common.SDocument baseDocument)

Parameters:

baseDocument - the SDocument which is the base document. That means, that all document-structures are merged into this document.

mapSDocument

public org.corpus_tools.pepper.common.DOCUMENT_STATUS mapSDocument()

This method is called by the Pepper framework and merges a set of given SDocumentGraph objects.

Specified by:

mapSDocument in interface org.corpus_tools.pepper.modules.PepperMapper

Overrides:

mapSDocument in class org.corpus_tools.pepper.impl.PepperMapperImpl

mergeDocumentStructures

public void mergeDocumentStructures(org.corpus_tools.pepper.modules.MappingSubject baseSubject)

Merges all document-structures pairwise by calling mergeDocumentStructures(SDocument, SDocument).

getContainer

public TokenMergeContainer getContainer()

chooseBaseDocument

protected org.corpus_tools.pepper.modules.MappingSubject chooseBaseDocument()

Chooses the base SDocument in which all nodes, relations etc. have to be merged in in further processing.
The base document is the one which is the one contained in the base corpus structure or if the corpus structure is not set, the one having the most nodes and relations.

Returns:

The base MappingSubject containing the base document

normalizePrimaryTexts

protected void normalizePrimaryTexts(org.corpus_tools.salt.common.SDocument sDocument)

Normalizes all primary texts of the given SDocument. The normalized text corresponding to its original is added to the TokenMergeContainer. Also each token corresponding to its start and end position in the normalized text is added to the TokenMergeContainer.
Note: only the normalization is done. The equivalent SToken are not determined in any way. For this functionality, you need to use alignDocuments.

Parameters:

sDocument - the SDocument for which the textual layer should be normalized.

createBaseTextNormOriginalMapping

protected List<Integer> createBaseTextNormOriginalMapping(org.corpus_tools.salt.common.STextualDS sTextualDS)

This method creates a reverse mapping list for the given Text. If the given text is normalized including the removal of whitespaces, the position of characters is changed. But if the position of a character in the original text is needed, we need more information. This method generates the needed information.

Parameters:

sTextualDS - The STextualDS

Returns:

A list of integers. The integer at index i specifies the position of the i'th character of the normalized text in the original text. Example: Let c be the second character in the original text and a whitespace the first character in the original text. Since the whitespace is removed, c is the first character in the normalized text. The first element of the returned list will contain the number 2 since c was the second char, originally.

alignTexts

protected boolean alignTexts(org.corpus_tools.salt.common.STextualDS baseText,
                             org.corpus_tools.salt.common.STextualDS otherText,
                             Set<org.corpus_tools.salt.common.SToken> nonEquivalentTokenInOtherTexts,
                             Map<org.corpus_tools.salt.core.SNode,org.corpus_tools.salt.core.SNode> equivalenceMap)

This method aligns the normalized texts of the given STextualDS objects and also aligns the SToken including the creation of equivalent SToken information. If a SToken has an equivalent SToken in the base text, it is removed from the nonEquivalentTokenInOtherTexts set.

Parameters:

baseText - the base STextualDS

otherText - the other STextualDS

nonEquivalentTokenInOtherTexts - A HashSet which contains all tokens which do not have an equivalent in the base text

equivalenceMap - A map of tokens in the other text with their equivalent token in the base text as value

Returns:

true on success and false on failure

indexOfOmitChars

protected int indexOfOmitChars(String stringToSearchIn,
                               String stringToSearchFor,
                               boolean useIndexOf,
                               Set<Character> omitChars)

This method searches for the first occurence of the stringToSearchFor in the stringToSearchIn and ommits all chars in the omitCharArray. The index of the first occurence is returned.

Parameters:

stringToSearchIn - String in which is searched

stringToSearchFor - String which is to search

useIndexof - If this flag is set, all omit chars are removed from both provided strings and a normal indexOf is used

omitCharArray -

Returns:

the index on success and -1 on failure

mergeTokens

protected void mergeTokens(org.corpus_tools.salt.common.STextualDS baseText,
                           org.corpus_tools.salt.common.STextualDS otherText,
                           Map<org.corpus_tools.salt.core.SNode,org.corpus_tools.salt.core.SNode> equivalenceMap)

Parameters:

baseText -

otherText -

equivalenceMap -