// CandyVocabulary.java // // senger@ebi.ac.uk // February 2001 // /* * BioJava development code * * This code may be freely distributed and modified under the * terms of the GNU Lesser General Public Licence. This should * be distributed with the code. If you do not have a copy, * see: * * http://www.gnu.org/copyleft/lesser.html * * Copyright for this code is held jointly by the individual * authors. These should be listed in @author doc comments. * * For more information on the BioJava project and its aims, * or to join the biojava-l mailing list, visit the home page * at: * * http://www.biojava.org/ * */ package org.biojava.utils.candy; import java.beans.PropertyChangeListener; import java.util.Enumeration; /** *
* This interface defines functionality of a controlled vocabulary. * The implementation is supposed to behave as a Java bean * (regarding accessing vocabulary properties). *
* ** Each vocabulary consists of (usually many) vocabulary entries * which are represented by {@link CandyEntry CandyEntries}. *
* * @version $Id: CandyVocabulary.java 2703 2003-06-01 08:42:29Z thomasd $ * @author Martin Senger * @author Matthew Pocock */ public interface CandyVocabulary extends PropertyChangeListener { /************************************************************************* * It checks if a given entry exists in this vocabulary. * * @param name of a vocabulary entry to be checked * @return true if the given entry exists in this vocabulary * @throws CandyException if the vocabulary is suddenly not available *************************************************************************/ boolean contains (String name) throws CandyException; /************************************************************************* * It returns a selected vocabulary entry. * * @see #getAllEntries getAllEntries * @param name a name of a vocabulary entry to be looked up * @return a vocabulary entry * @throws CandyException when the given vocabulary entry does not exist *************************************************************************/ CandyEntry getEntryByName (String name) throws CandyException; /************************************************************************* * It returns all available vocabulary entries. * * @see #getEntryByName getEntryByName * @return an Enumeration object containing all available entries * @throws CandyException if the vocabulary is suddenly not available *************************************************************************/ Enumeration getAllEntries() throws CandyException; /************************************************************************* * It return all names (entry identifiers) available in this vocabulary. * * @return an Enumeration object containing all available names * @throws CandyException if the vocabulary is suddenly not available *************************************************************************/ Enumeration getAllNames() throws CandyException; /************************************************************************* * It frees all resources related to this vocabulary. * * @throws CandyException if the vocabulary is suddenly not available *************************************************************************/ void destroy() throws CandyException; /************************************************************************* * * P r o p e r t i e s * *************************************************************************/ // // Property names // /** A property name. Its value is a name of this vocabulary. */ static final String PROP_VOCAB_NAME = "vocab_name"; /** A property name. Its value is a short description of the whole vocabulary. */ static final String PROP_VOCAB_DESC = "vocab_description"; /** A property name. Its value contains a version of this vocabulary. */ static final String PROP_VOCAB_VERSION = "vocab_version"; /** A property name. Its boolean value is true * if the vocabulary entries names should be considered as case-sensitive. */ static final String PROP_CASE_SENSITIVE = "vocab_case_sensitive"; /** A property name. Its value is a number of vocabulary entries * in this vocabulary. */ static final String PROP_ENTRY_COUNT = "entry_count"; /** A property name. Its type is {@link CandyVocabulary} and * it can be used to set an entire vocabulary. * An implementation may use it together with an empty * constructor. */ static final String PROP_VOCABULARY = "vocabulary"; // // Property access methods // /** It returns a name of this vocabulary. * The name should be unique within a {@link CandyFinder} * instance who delivers this vocabulary. */ String getName() throws CandyException; /** It returns a description of this vocabulary. */ String getDescription() throws CandyException; /** It returns a vesrion of this vocabulary. */ String getVersion() throws CandyException; /** It returns a number of entries contained in this vocabulary. */ int getCount() throws CandyException; /** It returns true if the vocabulary entries should * be considered as case-sensitive. */ boolean isCaseSensitive() throws CandyException; /** ** A property name. *
* ** An implementation may use this boolean property to make sure that * returned vocabulary entries are in the same order as they were * read from its original source. *
*/ static final String CANDIES_NOT_SORTED = "candies_not_sorted"; }