net.sf.bioutils.proteomics.sample.SampleModifiable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of proteomics Show documentation

Lightweight framework for handling biological and bioinformatical data related to proteomics.

There is a newer version: 3.1.6

/*******************************************************************************
 * Copyright 2011-2014 Alexander Kerner. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package net.sf.bioutils.proteomics.sample;

import java.util.Collection;

import net.sf.bioutils.proteomics.User;
import net.sf.bioutils.proteomics.peak.Peak;

/**
 *
 * {@code SampleModifiable} extends {@link Sample} by modifiability.
 *
 * 
 * Example:

 *
 * 
 * 
 *
 * 
 * TODO example
 * 
 *
 * 
 * 
 * last reviewed: 2013-09-23
 * 
 *
 * @author Alexander Kerner
 *
 *
 */
public interface SampleModifiable extends Sample {

    void addPeak(Peak peak);

    void addPeaks(Collection peak);

    void removePeak(Peak peak);

    void removePeaks(Collection peak);

    /**
     *
     * @param name
     *            new name for this {@code Sample}
     */
    void setName(String name);

    void setNameBase(String baseName);

    /**
     *
     * @param user
     *            new {@link User} for this {@code Sample}
     */
    void setUser(User user);

}