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

Class ADFLayout

java.lang.Object

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

All Implemented Interfaces:

Layout<ADF>

public class ADFLayout
extends Object
implements Layout<ADF>

Javadocs go here!

Author:

Tony Burdett

Constructor Summary

Constructors

Constructor and Description
ADFLayout()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttributeLocation(ADFAttribute attribute, Location location)
void	addNodeLocation(ADFNode node, Location location)
void	addPrimitiveLocation(String primitiveValue, String columnName, Location location)
void	calculateLocations(ADF adf) A factory method for fully calculates the layout of the given datamodel object, using Limpopo's own MAGE-TAB printing algorithms.
void	calculateUnassignedLocations(ADF adf) A factory method for calculating the locations of any data items not already assigned.
boolean	containsUnassignedElements(ADF adf) Returns true if the supplied datamodel has elements with no assigned location in this layout.
ADFAttribute	getAttribute(Location location)
String[]	getHeaders()
int	getLineCount()
protected org.slf4j.Logger	getLog()
ADFNode	getNode(Location location)
String	getPrimitive(Location location)
boolean	isCompletelyUnassigned() Returns true if there is no layout information contained within this layout

Methods inherited from class java.lang.Object

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

Constructor Detail

ADFLayout

public ADFLayout()

Method Detail

getLog

protected org.slf4j.Logger getLog()

addNodeLocation

public void addNodeLocation(ADFNode node,
                   Location location)

addAttributeLocation

public void addAttributeLocation(ADFAttribute attribute,
                        Location location)

addPrimitiveLocation

public void addPrimitiveLocation(String primitiveValue,
                        String columnName,
                        Location location)

getHeaders

public String[] getHeaders()

getNode

public ADFNode getNode(Location location)

getAttribute

public ADFAttribute getAttribute(Location location)

getPrimitive

public String getPrimitive(Location location)

getLineCount

public int getLineCount()

containsUnassignedElements

public boolean containsUnassignedElements(ADF adf)

Description copied from interface: Layout

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

Specified by:

containsUnassignedElements in interface Layout<ADF>

Returns:

true if there are unassigned elements, false otherwise

isCompletelyUnassigned

public boolean isCompletelyUnassigned()

Description copied from interface: Layout

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

Specified by:

isCompletelyUnassigned in interface Layout<ADF>

Returns:

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

calculateUnassignedLocations

public void calculateUnassignedLocations(ADF adf)

Description copied from interface: Layout

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.

Specified by:

calculateUnassignedLocations in interface Layout<ADF>

Parameters:

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

calculateLocations

public void calculateLocations(ADF adf)

Description copied from interface: Layout

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.

Specified by:

calculateLocations in interface Layout<ADF>

Parameters:

adf - the datamodel to layout