ExposedEntity.java

/*
 * 
 */
package uk.ac.ebi.fg.myequivalents.managers.interfaces;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;

import uk.ac.ebi.fg.myequivalents.model.Entity;
import uk.ac.ebi.fg.myequivalents.model.Service;

/**
 * This is used to return {@link Entity} results via interfaces like the web service. 
 * 
 * This is necessary, because serviceName is a read-only and shortcut getter in the superclass. If we want it to become 
 * a changeable property, we need to use this extension for XML-loading purposes only.
 * 
 * Moreover, this redefines {@link #getURI()}/{@link #setURI(String)}, since the Service is not here after XML 
 * de-serialisation and hence we allow JAXB to store the calculated URI as physical value.
 *
 * You should not use this class directly, it is automatically picked by the myequivalents managers.
 * 
 * <dl><dt>date</dt><dd>Oct 3, 2012</dd></dl>
 * @author Marco Brandizi
 *
 */
@XmlRootElement ( name = "entity" )
@XmlAccessorType ( XmlAccessType.NONE )
public class ExposedEntity extends Entity
{
	private static final long serialVersionUID = 1964502702735603174L;

	private String serviceName, uri;

	protected ExposedEntity () {
		super ();
	}

	public ExposedEntity ( Service service, String accession ) {
		super ( service, accession );
	}
	
	
	@Override
	public String getServiceName () {
		return this.serviceName;
	}

	@Override
	protected void setServiceName ( String serviceName )
	{
		this.serviceName = serviceName;
	}

	@Override
	public String getURI ()
	{
		if ( this.uri != null ) return this.uri;
		if ( this.getAccession () == null || this.getService () == null ) return null; 
		
		return super.getURI ();
	}

	@Override
	protected void setURI ( String uri )
	{
		this.uri = uri;
	}
}