org.dspace.vocabulary

Class ControlledVocabulary

java.lang.Object

org.dspace.vocabulary.ControlledVocabulary

public class ControlledVocabulary
extends java.lang.Object

This class represents a single controlled vocabulary node It also contains references to its child nodes

Author:

Kevin Van de Velde (kevin at atmire dot com)

Constructor Summary

Constructors

Constructor and Description
ControlledVocabulary(java.lang.String id, java.lang.String label, java.lang.String value, java.util.List<ControlledVocabulary> childNodes)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<ControlledVocabulary>	getChildNodes()
java.lang.String	getId()
java.lang.String	getLabel()
java.lang.String	getValue()
static ControlledVocabulary	loadVocabulary(java.lang.String fileName) Load the vocabulary with the given filename, if no vocabulary is found null is returned The vocabulary file will need to located in the [dspace.dir]/config/controlled-vocabulary directory.
void	setChildNodes(java.util.List<ControlledVocabulary> childNodes)
void	setId(java.lang.String id)
void	setLabel(java.lang.String label)
void	setValue(java.lang.String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ControlledVocabulary

public ControlledVocabulary(java.lang.String id,
                    java.lang.String label,
                    java.lang.String value,
                    java.util.List<ControlledVocabulary> childNodes)

Method Detail

loadVocabulary

public static ControlledVocabulary loadVocabulary(java.lang.String fileName)
                                           throws java.io.IOException,
                                                  org.xml.sax.SAXException,
                                                  javax.xml.parsers.ParserConfigurationException,
                                                  javax.xml.transform.TransformerException

Load the vocabulary with the given filename, if no vocabulary is found null is returned The vocabulary file will need to located in the [dspace.dir]/config/controlled-vocabulary directory.

Parameters:

fileName - the name of the vocabulary file.

Returns:

a controlled vocabulary object

Throws:

java.io.IOException - Should something go wrong with reading the file

org.xml.sax.SAXException - Error during xml parsing

javax.xml.parsers.ParserConfigurationException - Error during xml parsing

javax.xml.transform.TransformerException - Error during xml parsing TODO: add some caching !

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getLabel

public java.lang.String getLabel()

setLabel

public void setLabel(java.lang.String label)

getChildNodes

public java.util.List<ControlledVocabulary> getChildNodes()

setChildNodes

public void setChildNodes(java.util.List<ControlledVocabulary> childNodes)

getValue

public java.lang.String getValue()

setValue

public void setValue(java.lang.String value)