uk.ac.ebi.arrayexpress2.magetab.handler.visitor

Class LocationTracker

java.lang.Object

uk.ac.ebi.arrayexpress2.magetab.handler.visitor.LocationTracker

Deprecated.

since version 1.1, use Layout implementations instead

public class LocationTracker
extends Object

Tracks the locations of parsed IDF and SDRF data from the original source document. This class then allows lookup of IDF header tags, returning a line number, and SDRF Nodes (from the MAGETABInvestigation.SDRF graph model) returning a set of Points where this node may be found. This class is deprecated since version 1.1, as it has been replaced with a more integrated and efficient mechanism for preserving the layout of IDF, SDRF and ADF files.

Author:

Tony Burdett

See Also:

IDFLayout, SDRFLayout, ADFLayout

Constructor Summary

Constructors

Constructor and Description
LocationTracker(MAGETABInvestigation investigation) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
int	getIDFLocations(String idfTag) Deprecated. since version 1.1, use IDF.getLayout().getLineNumberForHeader() instead
Set<Point>	getSDRFLocations(SDRFNode sdrfNode) Deprecated. since version 1.1, use SDRF.getLayout().getLocationsForNode() instead
void	trackLocation(Handler handler, Point p) Deprecated. since version 1.1

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationTracker

public LocationTracker(MAGETABInvestigation investigation)

Deprecated.

Method Detail

trackLocation

@Deprecated
public void trackLocation(Handler handler,
                            Point p)

Deprecated. since version 1.1

Store the location of a handler. This maps the handler to the Point in the original source document where the given handler has taken it's data. Note that the point, p, contains x and y co-ordinates, where the x co-ordinate is the column number and the y co-ordinate the line number in the source document.

If handlers refer to an entire line or column, then the other co-ordinate will default to zero: so, for example, IDF handlers should always pass a location with a zero x co-ordinate and a y co-ordinate indicating the line.

Parameters:

handler - the handler to store

p - the point in the source document, where x = column and y = line

getIDFLocations

@Deprecated
public int getIDFLocations(String idfTag)

Deprecated. since version 1.1, use IDF.getLayout().getLineNumberForHeader() instead

Returns the line number representing the line in the original source document where this IDF tag can be found.

Parameters:

idfTag - the tag to find the line number for

Returns:

the line number where this IDF tag was located

getSDRFLocations

@Deprecated
public Set<Point> getSDRFLocations(SDRFNode sdrfNode)

Deprecated. since version 1.1, use SDRF.getLayout().getLocationsForNode() instead

Returns the set of points in an SDRF document where the supplied SDRFNodes can be found. Note that this returns a set, because a single SDRF node can be referenced in several locations in one SDRF document (whenever there are edges that either fork or merge). This means a single node cannot be tracked back to a single location in the graph.

Locations are returned as points, where the x co-ordinate represents the column and the y co-ordinate represents the row in which this node is found.

Parameters:

sdrfNode - the SDRFNode to identify locations for

Returns:

the point representing the location of this node