edu.illinois.cs.cogcomp.core.utilities

Class StringTransformation

java.lang.Object

edu.illinois.cs.cogcomp.core.utilities.StringTransformation

All Implemented Interfaces:

Serializable

public class StringTransformation
extends Object
implements Serializable

Store a list of transformations applied to an original string to produce a new String. These transformations modify the character offsets of the remaining string (e.g. replacing xml-escaped characters with their ascii counterparts, without padding the replacement with whitespace). This could include deletion of markup, in which case information associated with the markup might be stored.

Author:

mssammon

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StringTransformation.EditType

Constructor Summary

Constructors

Constructor and Description
StringTransformation(String origText) Constructor.

Method Summary

Modifier and Type	Method and Description
void	applyPendingEdits() apply any pending edits, update the modified string
int	computeModifiedOffsetFromOriginal(int origOffset) given a character offset in the original string, find the corresponding offset in the modified string.
IntPair	getOriginalOffsets(int transformStart, int transformEnd) given a pair of offsets into the transformed text, retrieve the corresponding offsets in the original text.
String	getOrigText() get the original text, before all edits were applied.
String	getTransformedText() get the updated text, after edits are applied.
IntPair	transformString(int textStart, int textEnd, String newStr) Modify the current version of the transformed text (as returned by getTransformedText()) by replacing the string between character offsets textStart and textEnd with newStr.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringTransformation

public StringTransformation(String origText)

Constructor.

Parameters:

origText - the original form of the string whose modifications you want to track.

Method Detail

getOrigText

public String getOrigText()

get the original text, before all edits were applied.

Returns:

the original text.

getTransformedText

public String getTransformedText()

get the updated text, after edits are applied. Performs any pending edits first.

Returns:

the transformed text.

transformString

public IntPair transformString(int textStart,
                               int textEnd,
                               String newStr)

Modify the current version of the transformed text (as returned by getTransformedText()) by replacing the string between character offsets textStart and textEnd with newStr.

Parameters:

textStart - character offset start of edit in transformed text

textEnd - character offset end of edit in transformed text

newStr - string to replace specified character span

Returns:

the offsets in the current, internally transformed text corresponding to textStart and textEnd

applyPendingEdits

public void applyPendingEdits()

apply any pending edits, update the modified string

computeModifiedOffsetFromOriginal

public int computeModifiedOffsetFromOriginal(int origOffset)

given a character offset in the original string, find the corresponding offset in the modified string. Characters that were deleted are mapped to the next following non-deleted character offset.

Parameters:

origOffset - offset in original string

Returns:

offset in modified string

getOriginalOffsets

public IntPair getOriginalOffsets(int transformStart,
                                  int transformEnd)

given a pair of offsets into the transformed text, retrieve the corresponding offsets in the original text. This behavior treats the end offset differently from the start offset (accounts for changes after the end)

Parameters:

transformStart - start of transformed text substring

transformEnd - end of transformed text substring

Returns:

offsets in original text corresponding to the specified span in the transformed string