Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.codelist
Interface CodeList

All Known Implementing Classes:
XmlCodeList

public interface CodeList

Author:
Simon Templer
Partner:
01 / Fraunhofer Institute for Computer Graphics Research

Nested Class Summary
static class CodeList.CodeEntry
          Represents a code list entry
 
Method Summary
 String getDescription()
          Get the description
 Collection<CodeList.CodeEntry> getEntries()
          Get the code list entries
 CodeList.CodeEntry getEntryByIdentifier(String identifier)
          Get the entry with the given identifier
 CodeList.CodeEntry getEntryByName(String name)
          Get the entry with the given name
 String getIdentifier()
          Get the identifier
 URI getLocation()
          Get the code list location
 String getNamespace()
          Get the namespace
 

Method Detail

getEntries

Collection<CodeList.CodeEntry> getEntries()
Get the code list entries

Returns:
the code list entries, changes to the returned collection will not be reflected in the code list

getNamespace

String getNamespace()
Get the namespace

Returns:
the namespace

getIdentifier

String getIdentifier()
Get the identifier

Returns:
the identifier

getDescription

String getDescription()
Get the description

Returns:
the description

getEntryByName

CodeList.CodeEntry getEntryByName(String name)
Get the entry with the given name

Parameters:
name - the entry name
Returns:
the entry or null

getEntryByIdentifier

CodeList.CodeEntry getEntryByIdentifier(String identifier)
Get the entry with the given identifier

Parameters:
identifier - the entry identifier
Returns:
the entry or null

getLocation

URI getLocation()
Get the code list location

Returns:
the code list location

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d