org.dlese.dpc.index.reader
Class XMLDocReader.VocabUiLabelsCollection

java.lang.Object
  java.util.AbstractCollection
      org.dlese.dpc.index.reader.XMLDocReader.VocabUiLabelsCollection

All Implemented Interfaces:

Iterable, Collection

Enclosing class:

XMLDocReader

public final class XMLDocReader.VocabUiLabelsCollection
extends AbstractCollection

A collection of user interface labels derived from vocabulary field/value IDs.

Author:

John Weatherley

Nested Class Summary

class

XMLDocReader.VocabUiLabelsCollection.VocabUiLabelsIterator The Iterator

Constructor Summary

XMLDocReader.VocabUiLabelsCollection(String fieldId, String[] valueIds, String metadataFormat)
Constructor for the VocabUiLabelsCollection object

Method Summary

Iterator	iterator() The iterator over the UI labels
int	size() The number of items in this collection

Methods inherited from class java.util.AbstractCollection

add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode

Constructor Detail

XMLDocReader.VocabUiLabelsCollection

public XMLDocReader.VocabUiLabelsCollection(String fieldId,
                                            String[] valueIds,
                                            String metadataFormat)

Constructor for the VocabUiLabelsCollection object

Parameters:

fieldId - A vocab field ID, for example 'gr'

valueIds - Vocab value IDs, for example 07, 04, 05

metadataFormat - The metadata format, for example 'adn'

Method Detail

iterator

public Iterator iterator()

The iterator over the UI labels

Specified by:

iterator in interface Iterable

Specified by:

iterator in interface Collection

Specified by:

iterator in class AbstractCollection

Returns:

The iterator over the UI labels

size

public int size()

The number of items in this collection

Specified by:

size in interface Collection

Specified by:

size in class AbstractCollection

Returns:

Number of items in this collection