uk.ac.ebi.arrayexpress2.magetab.datamodel.layout

Interface Layout<T>

All Known Implementing Classes:

ADFLayout, IDFLayout, SDRFLayout

public interface Layout<T>

An object that describes the relationship between a datamodel object and the serialized version of it. This is useful for tracking the Location of data items from their "original" location in a parsed text file (given by line number and column), or for plotting or customizing a layout prior to writing out the given datamodel object to a file.

Author:

Tony Burdett

Method Summary

Methods

Modifier and Type	Method and Description
void	calculateLocations(T datamodel) A factory method for fully calculates the layout of the given datamodel object, using Limpopo's own MAGE-TAB printing algorithms.
void	calculateUnassignedLocations(T datamodel) A factory method for calculating the locations of any data items not already assigned.
boolean	containsUnassignedElements(T datamodel) Returns true if the supplied datamodel has elements with no assigned location in this layout.
boolean	isCompletelyUnassigned() Returns true if there is no layout information contained within this layout

Method Detail

containsUnassignedElements

boolean containsUnassignedElements(T datamodel)

Returns true if the supplied datamodel has elements with no assigned location in this layout.

Returns:

true if there are unassigned elements, false otherwise

isCompletelyUnassigned

boolean isCompletelyUnassigned()

Returns true if there is no layout information contained within this layout

Returns:

true if there is no layout information for this datamodel at all

calculateUnassignedLocations

void calculateUnassignedLocations(T datamodel)

A factory method for calculating the locations of any data items not already assigned. Locations can be assigned during parsing or during any calculation step. If data is subsequently added after calculating locations, it will have an unassigned location. To ensure the layout is changed minimally after adding data, use this method.

Parameters:

datamodel - the datamodel for which to assign layout data for anything that hasn't been laid out previously

calculateLocations

void calculateLocations(T datamodel)

A factory method for fully calculates the layout of the given datamodel object, using Limpopo's own MAGE-TAB printing algorithms. Any previous location information may become invalid. So, if you use this method to calculate locations on a parsed document, the location information will not be the same as that in the original file.

Parameters:

datamodel - the datamodel to layout