org.opencastproject.metadata.dublincore

Class DublinCoreCatalogList

java.lang.Object

org.opencastproject.metadata.dublincore.DublinCoreCatalogList

public class DublinCoreCatalogList
extends Object

Simple class that enables storage of DublinCoreCatalog list and serializing into xml or json string.

Constructor Summary

Constructors

Constructor and Description
DublinCoreCatalogList(List<DublinCoreCatalog> catalogs, long totalCount) Initialize with the given catalog list.

Method Summary

Modifier and Type	Method and Description
List<DublinCoreCatalog>	getCatalogList() Returns list of Dublin Core currently stored
String	getResultsAsJson() Serializes list to JSON array string.
String	getResultsAsXML() Serializes list to XML.
long	getTotalCount() Get the total number of catalogs matching the creating query.
static DublinCoreCatalogList	parse(String dcString) Parses an XML or JSON string to an dublin core catalog list.
long	size() Return the number of contained catalogs.

Methods inherited from class java.lang.Object

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

Constructor Detail

DublinCoreCatalogList

public DublinCoreCatalogList(List<DublinCoreCatalog> catalogs,
                             long totalCount)

Initialize with the given catalog list.

Parameters:

catalogs - the catalogs to initialize this list with.

totalCount - the total count of catalogs that match the creating query of this list must be >= catalogs.size

Method Detail

getCatalogList

public List<DublinCoreCatalog> getCatalogList()

Returns list of Dublin Core currently stored

Returns:

List of DublinCoreCatalogs

getTotalCount

public long getTotalCount()

Get the total number of catalogs matching the creating query. Is >= size().

Returns:

int totalCatalogCount

size

public long size()

Return the number of contained catalogs.

getResultsAsXML

public String getResultsAsXML()
                       throws IOException

Serializes list to XML.

Returns:

serialized array as XML string

Throws:

IOException - if serialization cannot be properly performed

parse

public static DublinCoreCatalogList parse(String dcString)
                                   throws IOException

Parses an XML or JSON string to an dublin core catalog list.

Parameters:

dcString - the XML or JSON string

Throws:

IOException - if there is a problem parsing the XML or JSON

getResultsAsJson

public String getResultsAsJson()

Serializes list to JSON array string.

Returns:

serialized array as json array string