Package org.mycore.impex

Class MCRTransferPackage

java.lang.Object

org.mycore.impex.MCRTransferPackage

public class MCRTransferPackage
extends Object

Basic transfer package containing a MCRObject, all its descendants, links, derivates (including their files) and referenced classifications.

To build a transfer package call build(), this initializes all required objects and checks if they are valid. Call getContent() to retrieve the content afterwards.

Author:

Silvio Hermann, Matthias Eichner

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLASS_PATH
protected Set<String>	classifications	Set of classifications.
static final String	CONTENT_PATH
protected List<MCRTransferPackageFileContainer>	fileContainers	List of transfer package file containers.
static final String	IMPORT_CONFIG_FILENAME
protected LinkedHashSet<MCRObject>	objects	Set of objects including the source, its descendants and all resolved links.
protected MCRObject	source

Constructor Summary

Constructors

Constructor	Description
MCRTransferPackage(MCRObject source)

Method Summary

Modifier and Type	Method	Description
void	build()	Builds the transfer package.
protected List<MCRTransferPackageFileContainer>	buildFileContainers(MCRObject object)	Builds a list of MCRTransferPackageFileContainer for all derivate's of the given object and all its descendants.
Document	buildImportConfiguration()	Generates an xml file, which contains import configuration.
Map<String,MCRContent>	getContent()	Returns the content for this transfer package.
MCRObject	getSource()	Returns the source of this transfer package.
protected void	resolveChildrenAndLinks(MCRObject object, LinkedHashMap<MCRObjectID,MCRObject> objectMap, Set<MCRCategoryID> categories)	Fills the given objectMap with all children and links of the object.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

IMPORT_CONFIG_FILENAME

public static final String IMPORT_CONFIG_FILENAME

See Also:

• Constant Field Values

CONTENT_PATH

public static final String CONTENT_PATH

See Also:

• Constant Field Values

CLASS_PATH

public static final String CLASS_PATH

See Also:

• Constant Field Values

source

protected MCRObject source

objects

protected LinkedHashSet<MCRObject> objects

Set of objects including the source, its descendants and all resolved links. Its linked because the import order matters.

fileContainers

protected List<MCRTransferPackageFileContainer> fileContainers

List of transfer package file containers.

classifications

protected Set<String> classifications

Set of classifications.

Constructor Details

MCRTransferPackage

public MCRTransferPackage(MCRObject source)

Method Details

build

public void build()
           throws MCRUsageException

Builds the transfer package.

Throws:

MCRUsageException - is thrown if some of the referenced objects or derivates couldn't be retrieved

resolveChildrenAndLinks

protected void resolveChildrenAndLinks(MCRObject object,
 LinkedHashMap<MCRObjectID,MCRObject> objectMap,
 Set<MCRCategoryID> categories)

Fills the given objectMap with all children and links of the object. The object itself is also added.

Parameters:

object - the source object

objectMap - the map which will be created

buildFileContainers

protected List<MCRTransferPackageFileContainer> buildFileContainers(MCRObject object)

Builds a list of MCRTransferPackageFileContainer for all derivate's of the given object and all its descendants.

TODO: derivates of linked objects are not added

Parameters:

object - the object

Returns:

list of transfer packages file container

buildImportConfiguration

public Document buildImportConfiguration()

Generates an xml file, which contains import configuration.

Returns:

import configuration document

getContent

public Map<String,MCRContent> getContent()
                                  throws IOException

Returns the content for this transfer package. You have to call build() before you can retrieve this data.

Returns:

a map where key = filename; value = MCRContent

Throws:

IOException

getSource

public MCRObject getSource()

Returns the source of this transfer package.

Returns:

the source

toString

public String toString()

Overrides:

toString in class Object