Package org.biojava.utils.candy
Interface CandyVocabulary
- All Superinterfaces:
EventListener
,PropertyChangeListener
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 CandyEntries
.
- Version:
- $Id$
- Author:
- Martin Senger, Matthew Pocock
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionboolean
It checks if a given entry exists in this vocabulary.void
destroy()
It frees all resources related to this vocabulary.It returns all available vocabulary entries.It return all names (entry identifiers) available in this vocabulary.int
getCount()
It returns a number of entries contained in this vocabulary.It returns a description of this vocabulary.getEntryByName
(String name) It returns a selected vocabulary entry.getName()
It returns a name of this vocabulary.It returns a vesrion of this vocabulary.boolean
It returns true if the vocabulary entries should be considered as case-sensitive.Methods inherited from interface java.beans.PropertyChangeListener
propertyChange
-
Field Details
-
PROP_VOCAB_NAME
A property name. Its value is a name of this vocabulary.- See Also:
-
PROP_VOCAB_DESC
A property name. Its value is a short description of the whole vocabulary.- See Also:
-
PROP_VOCAB_VERSION
A property name. Its value contains a version of this vocabulary.- See Also:
-
PROP_CASE_SENSITIVE
A property name. Its boolean value is true if the vocabulary entries names should be considered as case-sensitive.- See Also:
-
PROP_ENTRY_COUNT
A property name. Its value is a number of vocabulary entries in this vocabulary.- See Also:
-
PROP_VOCABULARY
A property name. Its type isCandyVocabulary
and it can be used to set an entire vocabulary. An implementation may use it together with an empty constructor.- See Also:
-
CANDIES_NOT_SORTED
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.
- See Also:
-
-
Method Details
-
contains
It checks if a given entry exists in this vocabulary.- Parameters:
name
- of a vocabulary entry to be checked- Returns:
- true if the given entry exists in this vocabulary
- Throws:
CandyException
- if the vocabulary is suddenly not available
-
getEntryByName
It returns a selected vocabulary entry.- Parameters:
name
- a name of a vocabulary entry to be looked up- Returns:
- a vocabulary entry
- Throws:
CandyException
- when the given vocabulary entry does not exist- See Also:
-
getAllEntries
It returns all available vocabulary entries.- Returns:
- an Enumeration object containing all available entries
- Throws:
CandyException
- if the vocabulary is suddenly not available- See Also:
-
getAllNames
It return all names (entry identifiers) available in this vocabulary.- Returns:
- an Enumeration object containing all available names
- Throws:
CandyException
- if the vocabulary is suddenly not available
-
destroy
It frees all resources related to this vocabulary.- Throws:
CandyException
- if the vocabulary is suddenly not available
-
getName
It returns a name of this vocabulary. The name should be unique within aCandyFinder
instance who delivers this vocabulary.- Throws:
CandyException
-
getDescription
It returns a description of this vocabulary.- Throws:
CandyException
-
getVersion
It returns a vesrion of this vocabulary.- Throws:
CandyException
-
getCount
It returns a number of entries contained in this vocabulary.- Throws:
CandyException
-
isCaseSensitive
It returns true if the vocabulary entries should be considered as case-sensitive.- Throws:
CandyException
-