info.bioinfweb.libralign.dataarea

Class DataAreaLocation

java.lang.Object

info.bioinfweb.libralign.dataarea.DataAreaLocation

public class DataAreaLocation
extends java.lang.Object

Specified the location of a DataArea. That is either above or below the alignment or attached to a certain sequence.

Since:

0.0.0

Author:

Ben Stöver

Constructor Summary

Constructors

Constructor and Description
DataAreaLocation(DataAreaListType listType) Creates a new instance of this class specifying locations above or underneath the alignment.
DataAreaLocation(java.lang.String sequenceID) Creates a new instance of this class specifying a location attached to one sequence of the alignment.

Method Summary

Modifier and Type	Method and Description
DataAreaListType	getListType()
java.lang.String	getSequenceID()
void	setListType(DataAreaListType listType) Changes the list type.
void	setSequenceID(java.lang.String sequenceID) Can be used to update the sequence name, if a sequence was renamed or data area is moved.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataAreaLocation

public DataAreaLocation(DataAreaListType listType)

Creates a new instance of this class specifying locations above or underneath the alignment.

Parameters:

listType - specifies if list represents data areas displayed above or underneath the alignment

Throws:

java.lang.IllegalArgumentException - if DataAreaListType.SEQUENCE is specified as listType

DataAreaLocation

public DataAreaLocation(java.lang.String sequenceID)

Creates a new instance of this class specifying a location attached to one sequence of the alignment.

The list type is automatically set to DataAreaListType.SEQUENCE.

Parameters:

sequenceID - the unique identifier of the sequence the contained data areas will be attached to

Method Detail

getSequenceID

public java.lang.String getSequenceID()

setSequenceID

public void setSequenceID(java.lang.String sequenceID)

Can be used to update the sequence name, if a sequence was renamed or data area is moved. The list type is automatically set to DataAreaListType.SEQUENCE if an non-null ID is specified.

Parameters:

sequenceID - the unique identifier of the associated sequence

getListType

public DataAreaListType getListType()

setListType

public void setListType(DataAreaListType listType)

Changes the list type. If a value different from DataAreaListType.SEQUENCE is specified, the sequence name is automatically set to null.

Parameters:

listType - the new list type