Package psidev.psi.mi.jami.xml.model.extension

Class AbstractNamesContainer

java.lang.Object

psidev.psi.mi.jami.xml.model.extension.AbstractNamesContainer

All Implemented Interfaces:

com.sun.xml.bind.Locatable, FileSourceContext

Direct Known Subclasses:

NamesContainer, NamesContainer, NamesContainer

public abstract class AbstractNamesContainer
extends Object
implements FileSourceContext, com.sun.xml.bind.Locatable

A container for aliases, shortname and fullname The JAXB binding is designed to be read-only and is not designed for writing

Since:

19/07/13

Version:

$Id$

Author:

Marine Dumousseau (marine@ebi.ac.uk)

Constructor Summary

Constructors

Constructor	Description
AbstractNamesContainer()

Method Summary

Modifier and Type	Method	Description
List<Alias>	getAliases()	Gets the value of the alias property.
String	getFullName()	Gets the value of the fullName property.
String	getShortLabel()	Gets the value of the shortLabel property.
FileSourceLocator	getSourceLocator()	Getter for the field sourceLocator.
protected void	initialiseAliases()	initialiseAliases.
protected void	initialiseAliasesWith(List<Alias> aliases)	initialiseAliasesWith.
boolean	isEmpty()	isEmpty.
void	setFullName(String value)	Sets the value of the fullName property.
void	setShortLabel(String value)	Sets the value of the shortLabel property.
void	setSourceLocator(FileSourceLocator sourceLocator)	Sets the source locator
Locator	sourceLocation()
String	toString()	toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNamesContainer

public AbstractNamesContainer()

Method Detail

getShortLabel

public String getShortLabel()

Gets the value of the shortLabel property.

Returns:

a String object.

setShortLabel

public void setShortLabel(String value)

Sets the value of the shortLabel property.

Parameters:

value - allowed object is String

getFullName

public String getFullName()

Gets the value of the fullName property.

Returns:

a String object.

setFullName

public void setFullName(String value)

Sets the value of the fullName property.

Parameters:

value - allowed object is String

getAliases

public List<Alias> getAliases()

Gets the value of the alias property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the alias property.

For example, to add a new item, do as follows:

    getAlias().add(newItem);
 

Returns:

a List object.

sourceLocation

public Locator sourceLocation()

Specified by:

sourceLocation in interface com.sun.xml.bind.Locatable

getSourceLocator

public FileSourceLocator getSourceLocator()

Getter for the field sourceLocator.

Specified by:

getSourceLocator in interface FileSourceContext

Returns:

a FileSourceLocator object.

setSourceLocator

public void setSourceLocator(FileSourceLocator sourceLocator)

Sets the source locator

Specified by:

setSourceLocator in interface FileSourceContext

Parameters:

sourceLocator - : the file locator

isEmpty

public boolean isEmpty()

isEmpty.

Returns:

a boolean.

toString

public String toString()

toString

Specified by:

toString in interface FileSourceContext

Overrides:

toString in class Object

Returns:

the file source context as a String. If the source locator is not null, it should give the source locator properties

initialiseAliases

protected void initialiseAliases()

initialiseAliases.

initialiseAliasesWith

protected void initialiseAliasesWith(List<Alias> aliases)

initialiseAliasesWith.

Parameters:

aliases - a List object.