org.corpus_tools.peppermodules.mergingModules

Class TokenMergeContainer

java.lang.Object

org.corpus_tools.peppermodules.mergingModules.TokenMergeContainer

public class TokenMergeContainer
extends Object

Author:

eladrion

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TokenMergeContainer.AlignedTokensMap This class contains all tokens which were aligned and allows a search for specific SToken objects by their start position.

Constructor Summary

Constructors

Constructor and Description
TokenMergeContainer()

Method Summary

Modifier and Type	Method and Description
void	addAlignedToken(org.corpus_tools.salt.common.STextualDS text, org.corpus_tools.salt.common.SToken tok, int left, int right) This method adds the given SToken which is contained in the given STextualDS at the normalized left and right position.
void	addNormalizedText(org.corpus_tools.salt.common.SDocument doc, org.corpus_tools.salt.common.STextualDS sTextualDS, String normalizedText) This method adds the normalized text, specified by the parameter, for the specified STextualDS of the specified SDocument object.
void	addTokenMapping(org.corpus_tools.salt.common.SToken baseTextToken, org.corpus_tools.salt.common.SToken otherTextToken, org.corpus_tools.salt.common.STextualDS otherSText) This method adds an equivalence mapping for the given SToken of the base text to the given SToken in some other STextualDS which is specified as parameter
void	finishDocument(org.corpus_tools.salt.common.SDocument document) This method frees the memory used by the specified in the TokenMergeContainer.
org.corpus_tools.salt.common.SToken	getAlignedTokenByStart(org.corpus_tools.salt.common.STextualDS sTextualDS, int start) This method returns the SToken object which is located in the given normalized STextualDS at the given start position.
int	getAlignedTokenLength(org.corpus_tools.salt.common.STextualDS sTextualDS, org.corpus_tools.salt.common.SToken sToken) This method returns the length for the given SToken object in the normalized version of the given STextualDS.
TokenMergeContainer.AlignedTokensMap	getAlignedTokens(org.corpus_tools.salt.common.STextualDS text) This method returns the map of aligned SToken objects for the specified STextualDS.
int	getAlignedTokenStart(org.corpus_tools.salt.common.STextualDS sTextualDS, org.corpus_tools.salt.common.SToken sToken) This method returns the start for the given SToken object in the normalized version of the given STextualDS.
org.corpus_tools.salt.common.SDocument	getBaseDocument() This method returns the base SDocument object.
int	getBaseTextPositionByNormalizedTextPosition(org.corpus_tools.salt.common.STextualDS sTextualDS, int position) This method returns the position of a character in the original text, specified by the given STextualDS and the given position in the normalized text.
Map<org.corpus_tools.salt.common.SToken,Map<org.corpus_tools.salt.common.STextualDS,org.corpus_tools.salt.common.SToken>>	getEquivalenceMap() This method returns the map of equivalences for the base text tokens.
String	getNormalizedText(org.corpus_tools.salt.common.STextualDS sTextualDS) This method searches the normalized text for the given STextualDS .
org.corpus_tools.salt.common.SToken	getTokenMapping(org.corpus_tools.salt.common.SToken baseTextToken, org.corpus_tools.salt.common.STextualDS otherSText) This method gives access to the TokenMergeContainer and returns the equivalent SToken in the specified STextualDS for the specified SToken in the base text/document.
void	setBaseDocument(org.corpus_tools.salt.common.SDocument sDocument) This method sets the base SDocument.
void	setBaseTextPositionByNormalizedTextPosition(org.corpus_tools.salt.common.STextualDS sTextualDS, List<Integer> posMapping) This method sets the specified mapping from normalized text to the original text for the specified STextualDS object.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenMergeContainer

public TokenMergeContainer()

Method Detail

setBaseDocument

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

This method sets the base SDocument.

Parameters:

sDocument - The SDocument to set as base.

getBaseDocument

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

This method returns the base SDocument object.

Returns:

The base SDocument or null, if there is no base SDocument

setBaseTextPositionByNormalizedTextPosition

public void setBaseTextPositionByNormalizedTextPosition(org.corpus_tools.salt.common.STextualDS sTextualDS,
                                                        List<Integer> posMapping)

This method sets the specified mapping from normalized text to the original text for the specified STextualDS object.

Parameters:

sTextualDS - The STextualDS object

posMapping - The mapping list

getBaseTextPositionByNormalizedTextPosition

public int getBaseTextPositionByNormalizedTextPosition(org.corpus_tools.salt.common.STextualDS sTextualDS,
                                                       int position)

This method returns the position of a character in the original text, specified by the given STextualDS and the given position in the normalized text.

Parameters:

sTextualDS - The STextualDS object

position - The position of a character in the normalized text

Returns:

The original position on success and -1 on failure

addNormalizedText

public void addNormalizedText(org.corpus_tools.salt.common.SDocument doc,
                              org.corpus_tools.salt.common.STextualDS sTextualDS,
                              String normalizedText)

This method adds the normalized text, specified by the parameter, for the specified STextualDS of the specified SDocument object.

Parameters:

doc - The SDocument object containing the given text

sTextualDS - The STextualDS for which a normalized text should be added

normalizedText - The normalized text for the given STextualDS

getNormalizedText

public String getNormalizedText(org.corpus_tools.salt.common.STextualDS sTextualDS)

This method searches the normalized text for the given STextualDS .

Parameters:

sTextualDS - The STextualDS to search the normalized text for.

Returns:

The normalized text or null, if there is no normalized text for the given STextualDS

getAlignedTokenByStart

public org.corpus_tools.salt.common.SToken getAlignedTokenByStart(org.corpus_tools.salt.common.STextualDS sTextualDS,
                                                                  int start)

This method returns the SToken object which is located in the given normalized STextualDS at the given start position.

Parameters:

sTextualDS - The STextualDS which contains the SToken at the start position

start - The start position of the SToken in the STextualDS.

Returns:

The SToken which is located at position start in the given STextualDS or null, if there is no such SToken.

getAlignedTokenStart

public int getAlignedTokenStart(org.corpus_tools.salt.common.STextualDS sTextualDS,
                                org.corpus_tools.salt.common.SToken sToken)

This method returns the start for the given SToken object in the normalized version of the given STextualDS.

Parameters:

sTextualDS - The STextualDS to search the start position of the given SToken for

sToken - The SToken to search the start position for

Returns:

The position of the SToken in the normalized version of the given STextualDS or -1, if the SToken has no position in the given STextualDS.

getAlignedTokenLength

public int getAlignedTokenLength(org.corpus_tools.salt.common.STextualDS sTextualDS,
                                 org.corpus_tools.salt.common.SToken sToken)

This method returns the length for the given SToken object in the normalized version of the given STextualDS.

Parameters:

sTextualDS - The STextualDS to search the length of the given SToken for

sToken - The SToken to search the length for

Returns:

The length of the SToken in the normalized version of the given STextualDS or -1, if the SToken has length in the given STextualDS.

getAlignedTokens

public TokenMergeContainer.AlignedTokensMap getAlignedTokens(org.corpus_tools.salt.common.STextualDS text)

This method returns the map of aligned SToken objects for the specified STextualDS.

Parameters:

text - The STextualDS to search the map of aligned tokens for.

Returns:

The TokenMergeContainer.AlignedTokensMap for the specified STextualDS or null if there is no such map.

addAlignedToken

public void addAlignedToken(org.corpus_tools.salt.common.STextualDS text,
                            org.corpus_tools.salt.common.SToken tok,
                            int left,
                            int right)

This method adds the given SToken which is contained in the given STextualDS at the normalized left and right position.

Parameters:

text - The STextualDS which contains the given SToken

tok - The SToken object to add

left - The start of the SToken in the normalized version of the STextualDS

right - The end of the SToken in the normalized version of the STextualDS

addTokenMapping

public void addTokenMapping(org.corpus_tools.salt.common.SToken baseTextToken,
                            org.corpus_tools.salt.common.SToken otherTextToken,
                            org.corpus_tools.salt.common.STextualDS otherSText)

This method adds an equivalence mapping for the given SToken of the base text to the given SToken in some other STextualDS which is specified as parameter

Parameters:

baseTextToken - The base SToken to add a mapping for.

otherTextToken - The SToken which is a mapping for the base SToken

otherSText - The STextualDS which is connected to the mapped SToken

getTokenMapping

public org.corpus_tools.salt.common.SToken getTokenMapping(org.corpus_tools.salt.common.SToken baseTextToken,
                                                           org.corpus_tools.salt.common.STextualDS otherSText)

This method gives access to the TokenMergeContainer and returns the equivalent SToken in the specified STextualDS for the specified SToken in the base text/document.

Parameters:

baseTextToken - the SToken for which an equivalent SToken shall be searched

otherSText - the STextualDS to search for an equivalent token

Returns:

the equivalent SToken if existent and null, else.

getEquivalenceMap

public Map<org.corpus_tools.salt.common.SToken,Map<org.corpus_tools.salt.common.STextualDS,org.corpus_tools.salt.common.SToken>> getEquivalenceMap()

This method returns the map of equivalences for the base text tokens.

Returns:

The equivalence map.

finishDocument

public void finishDocument(org.corpus_tools.salt.common.SDocument document)

This method frees the memory used by the specified in the TokenMergeContainer.

Parameters:

document - document whose elements should be removed from internal indexes