org.conqat.engine.commons.findings.location

Class LocationAdjuster

java.lang.Object

org.conqat.engine.commons.findings.location.LocationAdjuster

All Implemented Interfaces:

ILineAdjuster

public class LocationAdjuster
extends java.lang.Object
implements ILineAdjuster

This class is used for adjusting the offsets used in locations (i.e. subclasses of ElementLocation for text that is slightly modified. The main use-case is the update of locations where the local (adjusted) text has different line ending, different content due to keyword expansion, or minor local modifications compared to the text on which the analysis was executed (original text). Both the original and adjusted text may have arbitrary line endings. The implementation is based on a token diff, which can lead to minor deviations for offsets that are not aligned with token boundaries. A character diff would be more precise, but is too performance and memory intensive for large files.

Constructor Summary

Constructors

Constructor and Description
LocationAdjuster(java.lang.String originalText, java.lang.String adjustedText) Constructor.
LocationAdjuster(java.lang.String originalText, java.lang.String adjustedText, java.lang.String adjustedUniformPath) Constructor.

Method Summary

Modifier and Type	Method and Description
LineBasedRegion	adjustLine(int line, java.util.Set<java.lang.Integer> invalidLines) Adjusts the location of a single line.
ElementLocation	adjustLocation(ElementLocation location) Returns a new location with adjusted offsets (if necessary).
TextRegionLocation	adjustLocation(TextRegionLocation location) Returns a new location with adjusted offsets (if necessary).
Region	getAdjustedRegion(int originalStartOffset, int originalEndOffset) Maps a zero-based offset range (both inclusive) to the adjusted string.
int	getOriginalLineCount() Returns the line count of the original text

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationAdjuster

public LocationAdjuster(java.lang.String originalText,
                        java.lang.String adjustedText,
                        java.lang.String adjustedUniformPath)

Constructor. WARNING: Creating a location adjuster is very expensive and should only be done once per file. In case originalText and adjustedText is identical take a look at SimpleValidLinesFilter.

Parameters:

originalText - the text for which the input locations have been created, i.e. the text from the analysis. May be null, in which case no adjustment is performed.

adjustedText - the text for which the locations should be adjusted, i.e. the local text.

adjustedUniformPath - the adjusted uniform path for adjusted findings.

LocationAdjuster

public LocationAdjuster(java.lang.String originalText,
                        java.lang.String adjustedText)

Constructor.

Parameters:

originalText - the text for which the input locations have been created, i.e. the text from the analysis.

adjustedText - the text for which the locations should be adjusted, i.e. the local text.

Method Detail

getAdjustedRegion

public Region getAdjustedRegion(int originalStartOffset,
                                int originalEndOffset)

Maps a zero-based offset range (both inclusive) to the adjusted string. Returns null if the region could not be approximately mapped.

adjustLocation

public ElementLocation adjustLocation(ElementLocation location)

Returns a new location with adjusted offsets (if necessary). Returns null if the location cannot be mapped to the adjusted text.

adjustLocation

public TextRegionLocation adjustLocation(TextRegionLocation location)

Returns a new location with adjusted offsets (if necessary). Returns null if the cannot be mapped to the adjusted text.

adjustLine

public LineBasedRegion adjustLine(int line,
                                  java.util.Set<java.lang.Integer> invalidLines)

Adjusts the location of a single line. This only respects the token part of a line, i.e. leading and trailing whitespace of a line will be ignored. This method is robust w.r.t lines numbers that are out of the range of the original text. In case of such an invalid line, the line is logged as error to the given logger and null is returned.

Specified by:

adjustLine in interface ILineAdjuster

Parameters:

line - the one-based line number of be adjusted.

invalidLines - used for collecting invalid lines.

Returns:

the one-based lines encoded as a region, as a line may map to multiple lines after changing. This may also return null, if no non-empty lines could be found that correspond to the input line after adjustment.

getOriginalLineCount

public int getOriginalLineCount()

Returns the line count of the original text

Specified by:

getOriginalLineCount in interface ILineAdjuster