com.canto.cumulus.utils

Class MetadataExchange

java.lang.Object

com.canto.cumulus.utils.MetadataExchange

public class MetadataExchange
extends java.lang.Object

This class provides import and export functionality for items.

Since:

8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetadataExchange.FieldFilter
static class	MetadataExchange.Format
static interface	MetadataExchange.ProgressListener

Constructor Summary

Constructors

Constructor and Description
MetadataExchange()

Method Summary

Methods

Modifier and Type	Method and Description
static void	exportItems(ItemCollection itemCollection, java.util.List<java.lang.Integer> itemIDs, java.io.OutputStream destination, MetadataExchange.Format format, MetadataExchange.FieldFilter fieldFilter, MetadataExchange.ProgressListener progress) Exports all items or the items with the specified IDs from the given ItemCollection into the output stream.
static void	exportItems(MultiItemCollection multiItemCollection, java.util.List<ItemIdentifier> itemIDs, java.io.OutputStream destination, MetadataExchange.Format format, MetadataExchange.FieldFilter fieldFilter, MetadataExchange.ProgressListener progress) Exports all items or the items with the specified IDs from the given MultiItemCollection into the output stream.
static void	importItems(java.io.InputStream source, long sourceLength, java.lang.String permissionTemplate, ItemCollection destination, MetadataExchange.Format format, MetadataExchange.FieldFilter fieldFilter, MetadataExchange.ProgressListener progress) Imports the given stream into new records.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataExchange

public MetadataExchange()

Method Detail

exportItems

public static void exportItems(ItemCollection itemCollection,
               java.util.List<java.lang.Integer> itemIDs,
               java.io.OutputStream destination,
               MetadataExchange.Format format,
               MetadataExchange.FieldFilter fieldFilter,
               MetadataExchange.ProgressListener progress)
                        throws java.io.IOException

Exports all items or the items with the specified IDs from the given ItemCollection into the output stream.

Parameters:

itemCollection - collection to read the items from

itemIDs - either the list of item IDs to export or null to export all items of the item collection

destination - output stream to write the export to

format - the wanted format of the export. Recommended is only the XML format as the other formats do not support all features of Cumulus

fieldFilter - Implementation that specifies which fields to export or null to export all fields. Only supported for XML format

progress - callback implementation to give the caller a chance to display a progress. You can pass null if you do not want to track the progress.

Throws:

java.io.IOException - on any error writing data to the stream

exportItems

public static void exportItems(MultiItemCollection multiItemCollection,
               java.util.List<ItemIdentifier> itemIDs,
               java.io.OutputStream destination,
               MetadataExchange.Format format,
               MetadataExchange.FieldFilter fieldFilter,
               MetadataExchange.ProgressListener progress)
                        throws java.io.IOException

Exports all items or the items with the specified IDs from the given MultiItemCollection into the output stream.

Parameters:

multiItemCollection - collection to read the items from

itemIDs - either the list of ItemIdentifier to export or null to export all items of the collection

destination - output stream to write the export to

format - the wanted format of the export. Recommended is only the XML format as the other formats do not support all features of Cumulus

fieldFilter - Implementation that specifies which fields to export or null to export all fields. Only supported for XML format

progress - callback implementation to give the caller a chance to display a progress. You can pass null if you do not want to track the progress.

Throws:

java.io.IOException - on any error writing data to the stream

importItems

public static void importItems(java.io.InputStream source,
               long sourceLength,
               java.lang.String permissionTemplate,
               ItemCollection destination,
               MetadataExchange.Format format,
               MetadataExchange.FieldFilter fieldFilter,
               MetadataExchange.ProgressListener progress)

Imports the given stream into new records.

Parameters:

source - stream to read the data from

sourceLength - number of bytes to read from the stream

permissionTemplate - permission template to use for new records

destination - ItemCollection where new records are added

format - Format of the given stream

fieldFilter - Implementation that specifies which fields to import or null to import all fields. Only supported for format XML.

progress - Progress listener that enables the caller to get information about the current progress. You can pass null if you do not want to track the progress.