|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
.
Field Summary | |
static java.lang.String |
CANDIES_NOT_SORTED
A property name. |
static java.lang.String |
PROP_CASE_SENSITIVE
A property name. |
static java.lang.String |
PROP_ENTRY_COUNT
A property name. |
static java.lang.String |
PROP_VOCAB_DESC
A property name. |
static java.lang.String |
PROP_VOCAB_NAME
A property name. |
static java.lang.String |
PROP_VOCAB_VERSION
A property name. |
static java.lang.String |
PROP_VOCABULARY
A property name. |
Method Summary | |
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 |
Field Detail |
public static final java.lang.String PROP_VOCAB_NAME
public static final java.lang.String PROP_VOCAB_DESC
public static final java.lang.String PROP_VOCAB_VERSION
public static final java.lang.String PROP_CASE_SENSITIVE
public static final java.lang.String PROP_ENTRY_COUNT
public static final java.lang.String PROP_VOCABULARY
CandyVocabulary
and
it can be used to set an entire vocabulary.
An implementation may use it together with an empty
constructor.
public static final java.lang.String 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.
Method Detail |
public boolean contains(java.lang.String name) throws NestedException
name
- of a vocabulary entry to be checked
NestedException
- if the vocabulary is suddenly not availablepublic CandyEntry getEntryByName(java.lang.String name) throws NestedException
name
- a name of a vocabulary entry to be looked up
NestedException
- when the given vocabulary entry does not existgetAllEntries
public java.util.Enumeration getAllEntries() throws NestedException
NestedException
- if the vocabulary is suddenly not availablegetEntryByName
public java.util.Enumeration getAllNames() throws NestedException
NestedException
- if the vocabulary is suddenly not availablepublic void destroy() throws NestedException
NestedException
- if the vocabulary is suddenly not availablepublic java.lang.String getName() throws NestedException
CandyFinder
instance who delivers this vocabulary.
NestedException
public java.lang.String getDescription() throws NestedException
NestedException
public java.lang.String getVersion() throws NestedException
NestedException
public int getCount() throws NestedException
NestedException
public boolean isCaseSensitive() throws NestedException
NestedException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |