de.tudarmstadt.ukp.dkpro.core.api.transform.alignment

Class AlignedString

java.lang.Object

de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString

All Implemented Interfaces:

Iterable<de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.DataSegment>

public class AlignedString
extends Object
implements Iterable<de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.DataSegment>

Allows to stack strings on top of each other and modifying each of them propagating changes up to the top while leaving lower levels unchanged. This class is not synchronized internally.

Field Summary

Fields

Modifier and Type	Field and Description
protected de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.AnchorSegment	_first
protected de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.AnchorSegment	_last

Constructor Summary

Constructors

Constructor and Description
AlignedString(AlignedString underlying)
AlignedString(String base)

Method Summary

Modifier and Type	Method and Description
String	dataSegmentsToString() Create a string representation of the segments.
void	delete(int start, int end) Deletes data.
void	fireChange()
String	get() Fetch data
String	get(int start, int end) Fetch data
de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.Anchor	getAnchor(int pos) Get an anchor at the specified position.
Collection<de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.Anchor>	getAnchors() Get all the anchors.
de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.AbstractDataSegment	getFirst()
de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.AbstractDataSegment	getLast()
de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.AbstractDataSegment	getSegmentAt(int position) Get data segment currently at the given position.
Collection<de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.DataSegment>	getSegments() Get all the segments.
void	insert(int pos, String s) Inserts s at given position.
ImmutableInterval	inverseResolve(ImmutableInterval i) For the given interval on the underlying data, get the corresponding interval on this level.
Iterator<de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.DataSegment>	iterator() Get an iterator over the internal data segments.
int	length() Gets total length of data.
void	replace(int start, int end, String d) Replaces data.
Interval	resolve(Interval i) For the given interval on the current data, get the corresponding interval in the wrapped data.
String	toString()
void	updateCaches()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

_first

protected final de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.AnchorSegment _first

_last

protected final de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.AnchorSegment _last

Constructor Detail

AlignedString

public AlignedString(String base)

AlignedString

public AlignedString(AlignedString underlying)

Method Detail

fireChange

public void fireChange()

resolve

public Interval resolve(Interval i)

For the given interval on the current data, get the corresponding interval in the wrapped data.

Parameters:

i - an interval.

Returns:

the resolved interval.

inverseResolve

public ImmutableInterval inverseResolve(ImmutableInterval i)

For the given interval on the underlying data, get the corresponding interval on this level. Example: 11 11 111 11 012 345 6789 01 23 456 78 AD |111|22ZZ2|3333|44|55|YYY|55| UL |111|XX|22|ZZ|2|XXXXX|3333|XX|44|XXXX|5555|XXXX| 012 34 56 78 9 11111 1111 12 22 2222 2223 3333 01234 5678 90 12 3456 7890 1234 As you can see there is a YYY inserted in the AD. Otherwise some parts of the UL (marked "X") have been removed in the AD. Also an ZZ part has been added to UL Calling this method with start=22 end=30 should return [12, 18] as this is the interval 5 from UL plus the "Y" that has been inserted in AD. Generally: - if the start is within a deleted region, then find the next oblique segment in AD to the right and return its start position. - if the end is within a deleted region, then find the next oblique segment in AD to the left and return its end position. Anchors are always in UL. They are referenced from the ObliqueSegments in AD.

Parameters:

i - the interval on the underlying data.

Returns:

the corresponding interval in the view.

getSegmentAt

public de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.AbstractDataSegment getSegmentAt(int position)

Get data segment currently at the given position. Anchors are never returned.

Parameters:

position - a position.

Returns:

the non-anchor segment at the given position.

getFirst

public de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.AbstractDataSegment getFirst()

getLast

public de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.AbstractDataSegment getLast()

iterator

public Iterator<de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.DataSegment> iterator()

Get an iterator over the internal data segments.

Specified by:

iterator in interface Iterable<de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.DataSegment>

length

public int length()

Gets total length of data.

Returns:

length of the data.

get

public String get()

Fetch data

Returns:

the data.

updateCaches

public void updateCaches()

get

public String get(int start,
                  int end)

Fetch data

Parameters:

start - the start offset.

end - the end offset.

Returns:

the data.

insert

public void insert(int pos,
                   String s)

Inserts s at given position.

Parameters:

pos - position at which to insert.

s - string to insert.

delete

public void delete(int start,
                   int end)

Deletes data.

Parameters:

start - the start offset.

end - the end offset+1.

replace

public void replace(int start,
                    int end,
                    String d)

Replaces data.

Parameters:

start - the start offset.

end - the end offset+1.

d - the data used to replace the current data.

getAnchor

public de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.Anchor getAnchor(int pos)

Get an anchor at the specified position. Breaks up the segment at the given point if necessary. If there already is an anchor, it is reused.

Parameters:

pos - a position.

Returns:

an anchor.

getAnchors

public Collection<de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.Anchor> getAnchors()

Get all the anchors.

Returns:

all the anchors.

getSegments

public Collection<de.tudarmstadt.ukp.dkpro.core.api.transform.alignment.AlignedString.DataSegment> getSegments()

Get all the segments.

Returns:

all the segments.

dataSegmentsToString

public String dataSegmentsToString()

Create a string representation of the segments. This is for debugging purposes.

Returns:

string representation of the segments.

toString

public String toString()

Overrides:

toString in class Object