org.duracloud.manifest

Interface ManifestFormatter

All Known Implementing Classes:

BagitManifestFormatter, ManifestFormatterBase, TsvManifestFormatter

public interface ManifestFormatter

This class defines the contract for Manifest Formatters.

Author:

Andrew Woods Date: 3/29/12

Method Summary

Modifier and Type	Method and Description
String	formatLine(org.duracloud.mill.db.model.ManifestItem item) Formats a manifest item into an appropriate line.
String	getHeader() Returns the header if there is one, otherwise null.
org.duracloud.mill.db.model.ManifestItem	parseLine(String line) Parses a line into a ManifestItem
void	writeEventsToOutput(Collection<ContentMessage> events, OutputStream output) This method writes the arg events to the arg output stream.
void	writeManifestItemToOutput(org.duracloud.mill.db.model.ManifestItem item, OutputStream outputStream)

Method Detail

writeEventsToOutput

void writeEventsToOutput(Collection<ContentMessage> events,
                         OutputStream output)

This method writes the arg events to the arg output stream.

Parameters:

events - to write

output - destination of formatted events

writeManifestItemToOutput

void writeManifestItemToOutput(org.duracloud.mill.db.model.ManifestItem item,
                               OutputStream outputStream)

Parameters:

item - to write

outputStream - destination of formatted items. Null manifest items are ignored.

getHeader

String getHeader()

Returns the header if there is one, otherwise null.

Returns:

parseLine

org.duracloud.mill.db.model.ManifestItem parseLine(String line)
                                            throws ParseException

Parses a line into a ManifestItem

Parameters:

line -

Returns:

Throws:

ParseException

formatLine

String formatLine(org.duracloud.mill.db.model.ManifestItem item)

Formats a manifest item into an appropriate line.

Parameters:

item -

Returns: