org.conqat.engine.commons.findings.location

Class TextRegionLocation

java.lang.Object

org.conqat.engine.commons.findings.location.ElementLocation

org.conqat.engine.commons.findings.location.TextRegionLocation

All Implemented Interfaces:

java.io.Serializable

public class TextRegionLocation
extends ElementLocation

This class denotes a region of text in an element. Context: Due to the way ConQAT deals with text, the class is a little bit more complex than expected. First, in ConQAT all text is normalized to use Unix style line endings (regardless of the line endings in the file). Second, ConQAT may apply filters, i.e. the internal (filtered) text representation may be different from the (raw) text in the file. Additionally, a location is best described by character offsets into the string, while a user typically expects line numbers. Conversion between all these representations is easy, as long as ConQAT internal representation is available. Without it, conversion is not possible. Rationale: When findings are reported to a user, the raw offsets and/or lines should be used, as these are more meaningful (visible in other editors as well). Also for persisting in a report, the raw positions are preferred, as the filtered ones depend on the ConQAT configuration, while raw offsets are independent of filter configuration. When working with findings within ConQAT, typically the filtered positions are needed, as most processors also work on the filtered representation. However, in such a case the corresponding element is typically available and thus conversion to the filtered representation is easy. Implementation: The finding (as well as the findings report) only stores raw positions. While the offsets would be sufficient, we also store line numbers to be able to provide meaningful user output. Filtered positions are not stored, but are made available via utility methods in the resource bundle. All fields are mandatory, i.e., it is not allowed to fill any position entry with invalid data (contrary to the old CodeRegionLocation, where -1 could be used to denote missing information).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNKNOWN_TEXT_REGION_OFFSET An unknown offset used to indicate, that the line information is to be used to calculate character offset from.

Fields inherited from class org.conqat.engine.commons.findings.location.ElementLocation

LOCATION_PROPERTY, UNIFORM_PATH_PROPERTY

Constructor Summary

Constructors

Constructor and Description
TextRegionLocation(java.lang.String location, java.lang.String uniformPath, int rawStartOffset, int rawEndOffset, int rawStartLine, int rawEndLine) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getRawEndLine() Returns the line corresponding to getRawEndOffset() (one-based, inclusive).
int	getRawEndOffset() Returns the absolute end position in the (raw) text (zero based, inclusive).
int	getRawStartLine() Returns the line corresponding to getRawStartOffset() (one-based, inclusive).
int	getRawStartOffset() Returns the absolute start position of the region in the (raw) text (zero based, inclusive).
java.lang.String	toLocationString() Returns a single line description of the location that is meaningful to the user.

Methods inherited from class org.conqat.engine.commons.findings.location.ElementLocation

getLocation, getUniformPath, toString

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_TEXT_REGION_OFFSET

public static final int UNKNOWN_TEXT_REGION_OFFSET

An unknown offset used to indicate, that the line information is to be used to calculate character offset from.

See Also:

Constant Field Values

Constructor Detail

TextRegionLocation

public TextRegionLocation(java.lang.String location,
                          java.lang.String uniformPath,
                          int rawStartOffset,
                          int rawEndOffset,
                          int rawStartLine,
                          int rawEndLine)

Constructor.

Method Detail

getRawStartOffset

public int getRawStartOffset()

Returns the absolute start position of the region in the (raw) text (zero based, inclusive).

getRawEndOffset

public int getRawEndOffset()

Returns the absolute end position in the (raw) text (zero based, inclusive).

getRawStartLine

public int getRawStartLine()

Returns the line corresponding to getRawStartOffset() (one-based, inclusive).

getRawEndLine

public int getRawEndLine()

Returns the line corresponding to getRawEndOffset() (one-based, inclusive).

toLocationString

public java.lang.String toLocationString()

Returns a single line description of the location that is meaningful to the user.

This includes the start and end line which is typically sufficient for debugging and showing to a user.

Overrides:

toLocationString in class ElementLocation