Interface CandyVocabulary

  • All Superinterfaces:
    java.util.EventListener, java.beans.PropertyChangeListener

    public interface CandyVocabulary
    extends java.beans.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
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean contains​(java.lang.String name)
      It checks if a given entry exists in this vocabulary.
      void destroy()
      It frees all resources related to this vocabulary.
      java.util.Enumeration getAllEntries()
      It returns all available vocabulary entries.
      java.util.Enumeration getAllNames()
      It return all names (entry identifiers) available in this vocabulary.
      int getCount()
      It returns a number of entries contained in this vocabulary.
      java.lang.String getDescription()
      It returns a description of this vocabulary.
      CandyEntry getEntryByName​(java.lang.String name)
      It returns a selected vocabulary entry.
      java.lang.String getName()
      It returns a name of this vocabulary.
      java.lang.String getVersion()
      It returns a vesrion of this vocabulary.
      boolean isCaseSensitive()
      It returns true if the vocabulary entries should be considered as case-sensitive.
      • Methods inherited from interface java.beans.PropertyChangeListener

        propertyChange