001    package jigcell.compare;
002    
003    /**
004     * This interface is implemented by classes that wish to store data for the comparator.
005     * 
006     * <p>
007     * This code is licensed under the DARPA BioCOMP Open Source License.  See LICENSE for more details.
008     * </p>
009     *
010     * @author Nicholas Allen
011     */
012    
013    public interface IEditableDataGenerator extends IDataGenerator, IWriteableDataSource {
014    
015       /**
016        * Nulls out the stored element.
017        */
018    
019       void clear ();
020    
021       /**
022        * Sets the displayable description.
023        *
024        * @param displayableComment Description
025        */
026    
027       void setComment (String displayableComment);
028    
029       /**
030        * Sets whether this generator takes its name from the generator it was copied from.  This does nothing if this generator was not copied from
031        * another.
032        *
033        * @param copyName Linked
034        */
035    
036       void setCopyName (boolean copyName);
037    
038       /**
039        * Sets the associated data element.
040        *
041        * @param element Element
042        */
043    
044       void setElement (IDataElement element);
045    
046       /**
047        * Sets the generator name.
048        *
049        * @param name Name
050        */
051    
052       void setName (String name);
053    }