001package org.biopax.paxtools.model.level3;
002
003import org.biopax.paxtools.model.BioPAXElement;
004
005import java.util.Set;
006
007/**
008 * A Level 3 specific element. Instances of this class maps to an OWL Individual.
009 */
010public interface Level3Element extends BioPAXElement
011{
012        /**
013         * A textual comment about this individual. This property should be used instead of the OWL documentation
014         * elements (rdfs:comment) for instances because information in 'comment' is data to be exchanged,
015         * whereas the rdfs:comment field is used for metadata about the structure of the BioPAX ontology.
016         * Contents of this set should not be modified. Use Add/Remove instead.
017         * @return A textual comment about this individual.
018         */
019        public Set<String> getComment();
020
021
022        /**
023         * A textual comment about this individual. This property should be used instead of the OWL documentation
024         * elements (rdfs:comment) for instances because information in 'comment' is data to be exchanged,
025         * whereas the rdfs:comment field is used for metadata about the structure of the BioPAX ontology.
026         * Contents of this set should not be modified. Use Add/Remove instead.
027         * @param comment A textual comment about this individual.
028         */
029        public void addComment(String comment);
030
031        /**
032         * A textual comment about this individual. This property should be used instead of the OWL documentation
033         * elements (rdfs:comment) for instances because information in 'comment' is data to be exchanged,
034         * whereas the rdfs:comment field is used for metadata about the structure of the BioPAX ontology.
035         * Contents of this set should not be modified. Use Add/Remove instead.
036         * @param comment A textual comment about this individual.
037         */
038        public void removeComment(String comment);
039}