/*
*------------------------------------------------------------------------------
* Copyright (C) 2006-2008 University of Dundee. All rights reserved.
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*------------------------------------------------------------------------------
*/
package omero.gateway.model;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.commons.lang.StringUtils;
import omero.model.Screen;
import omero.model.ScreenI;
import omero.model.ScreenPlateLink;
/**
* The data that makes up an <i>OME</i> Screen along with links to its
* contained Plates and the Experimenter that owns this Screen.
*
* @author Jean-Marie Burel <a
* href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
* @author Donald MacDonald <a
* href="mailto:donald@lifesci.dundee.ac.uk">donald@lifesci.dundee.ac.uk</a>
* @version 3.0
* @since 3.0-Beta3
*/
public class ScreenData extends DataObject {
/** Identifies the {@link ScreenI#NAME} field. */
public final static String NAME = ScreenI.NAME;
/** Identifies the {@link ScreenI#DESCRIPTION} field. */
public final static String DESCRIPTION = ScreenI.DESCRIPTION;
/** Identifies the {@link ScreenI#PLATELINKS} field. */
public final static String PLATE_LINKS = ScreenI.PLATELINKS;
/**
* All the Plates that are contained in this Screen. The elements of this
* set are {@link PlateData} objects. If this Screen does contained in any
* Plate, then this set will be empty — but never <code>null</code>.
*/
private Set<PlateData> plates;
/** Creates a new instance. */
public ScreenData() {
setDirty(true);
setValue(new ScreenI());
}
/**
* Creates a new instance.
*
* @param screen
* Back pointer to the {@link Screen} model object. Mustn't be
* <code>null</code>.
* @throws IllegalArgumentException
* If the object is <code>null</code>.
*/
public ScreenData(Screen screen) {
if (screen == null) {
throw new IllegalArgumentException("Object cannot null.");
}
setValue(screen);
}
/**
* Sets the name of the screen.
*
* @param name
* The name of the screen. Mustn't be <code>null</code>.
* @throws IllegalArgumentException
* If the name is <code>null</code>.
*/
public void setName(String name) {
if (name == null) {
throw new IllegalArgumentException("The name cannot be null.");
}
setDirty(true);
asScreen().setName(omero.rtypes.rstring(name));
}
/**
* Returns the name of the screen.
*
* @return See above.
*/
public String getName() {
omero.RString n = asScreen().getName();
if (n == null || n.getValue() == null) {
throw new IllegalStateException(
"The name should never have been null.");
}
return n.getValue();
}
/**
* Sets the description of the screen.
*
* @param description
* The description of the screen.
*/
public void setDescription(String description) {
setDirty(true);
asScreen().setDescription(omero.rtypes.rstring(description));
}
/**
* Returns the description of the screen.
*
* @return See above.
*/
public String getDescription() {
omero.RString d = asScreen().getDescription();
return d == null ? null : d.getValue();
}
/**
* Returns the number of annotations linked to the object, key: id of the
* user, value: number of annotation. The map may be <code>null</code> if
* no annotation.
*
* @return See above.
*/
public Map<Long, Long> getAnnotationsCounts() {
return asScreen().getAnnotationLinksCountPerOwner();
}
// Lazy loaded Links
/**
* Returns the plates contained in this screen.
*
* @return See above.
*/
public Set<PlateData> getPlates() {
if (plates == null && asScreen().sizeOfPlateLinks() >= 0) {
plates = new HashSet<PlateData>();
List<ScreenPlateLink> links = asScreen().copyPlateLinks();
for (ScreenPlateLink link : links) {
plates.add(new PlateData(link.getChild()));
}
}
return plates == null ? null : new HashSet<PlateData>(plates);
}
// Link mutations
/**
* Sets the plates contained in this screen.
*
* @param value
* The set of plates.
*/
public void setPlates(Set<PlateData> value) {
Set<PlateData> currentValue = getPlates();
SetMutator<PlateData> m = new SetMutator<PlateData>(currentValue, value);
while (m.moreDeletions()) {
setDirty(true);
asScreen().unlinkPlate(m.nextDeletion().asPlate());
}
while (m.moreAdditions()) {
setDirty(true);
asScreen().linkPlate(m.nextAddition().asPlate());
}
plates = new HashSet<PlateData>(m.result());
}
/**
* Returns the description of the protocol.
*
* @return See above.
*/
public String getProtocolDescription()
{
omero.RString d = asScreen().getProtocolDescription();
return d == null ? "" : d.getValue();
}
/**
* Sets the description of the protocol.
*
* @param value The value to set.
*/
public void setProtocolDescription(String value)
{
if (StringUtils.isNotBlank(value))
asScreen().setProtocolDescription(omero.rtypes.rstring(value));
}
/**
* Returns the identifier of the protocol.
*
* @return See above.
*/
public String getProtocolIdentifier()
{
omero.RString d = asScreen().getProtocolIdentifier();
return d == null ? "" : d.getValue();
}
/**
* Sets the identifier of the protocol.
*
* @param value The value to set.
*/
public void setProtocolIdentifier(String value)
{
if (StringUtils.isNotBlank(value))
asScreen().setProtocolIdentifier(omero.rtypes.rstring(value));
}
/**
* Returns the description of the reagent set.
*
* @return See above.
*/
public String getReagentSetDescripion()
{
omero.RString d = asScreen().getReagentSetDescription();
return d == null ? "" : d.getValue();
}
/**
* Sets the identifier of the reagent.
*
* @param value The value to set.
*/
public void setReagentSetDescripion(String value)
{
if (StringUtils.isNotBlank(value))
asScreen().setReagentSetDescription(omero.rtypes.rstring(value));
}
/**
* Returns the identifier of the Reagent set.
*
* @return See above.
*/
public String getReagentSetIdentifier()
{
omero.RString d = asScreen().getReagentSetIdentifier();
return d == null ? "" : d.getValue();
}
/**
* Sets the identifier of the reagent.
*
* @param value The value to set.
*/
public void setReagentSetIdentifier(String value)
{
if (StringUtils.isNotBlank(value))
asScreen().setReagentSetIdentifier(omero.rtypes.rstring(value));
}
}