org.conqat.engine.commons.findings.location

Class ElementLocation

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

QualifiedNameLocation, TextRegionLocation

public class ElementLocation
extends java.lang.Object
implements java.io.Serializable

Base class for locations. Locations are immutable and thus return this at deep cloning.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	LOCATION_PROPERTY The name of the JSON property name for location.
protected static java.lang.String	UNIFORM_PATH_PROPERTY The name of the JSON property name for uniformPath.

Constructor Summary

Constructors

Constructor and Description
ElementLocation(java.lang.String uniformPath)
ElementLocation(java.lang.String location, java.lang.String uniformPath)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLocation() Get a string that identifies the location of the element, e.g.
java.lang.String	getUniformPath() Returns the uniform path.
java.lang.String	toLocationString() Returns a single line description of the location that is meaningful to the user.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOCATION_PROPERTY

protected static final java.lang.String LOCATION_PROPERTY

The name of the JSON property name for location.

See Also:

Constant Field Values

UNIFORM_PATH_PROPERTY

protected static final java.lang.String UNIFORM_PATH_PROPERTY

The name of the JSON property name for uniformPath.

See Also:

Constant Field Values

Constructor Detail

ElementLocation

public ElementLocation(java.lang.String location,
                       java.lang.String uniformPath)

ElementLocation

public ElementLocation(java.lang.String uniformPath)

Method Detail

getLocation

public java.lang.String getLocation()

Get a string that identifies the location of the element, e.g. a file system path. This location is specific to the running analysis, i.e. depends on time and the concrete machine ConQAT is running on.

getUniformPath

public java.lang.String getUniformPath()

Returns the uniform path. This is an artificial path that uniquely defines a resource across machine boundaries. This should be used for persisted information.

toLocationString

public java.lang.String toLocationString()

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object