org.sakaiproject.importer.impl

Class IMSFileParser

java.lang.Object

org.sakaiproject.importer.impl.ZipFileParser

org.sakaiproject.importer.impl.IMSFileParser

All Implemented Interfaces:

org.sakaiproject.importer.api.ImportFileParser

public abstract class IMSFileParser
extends ZipFileParser

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	IMSFileParser.FileHelper
protected static class	IMSFileParser.ItemHelper
protected static class	IMSFileParser.ManifestHelper
protected static class	IMSFileParser.ResourceHelper

Field Summary

Fields

Modifier and Type	Field and Description
protected Document	archiveManifest
protected Map	dependencies
protected IMSFileParser.FileHelper	fileHelper
protected IMSFileParser.ItemHelper	itemHelper
protected IMSFileParser.ManifestHelper	manifestHelper
protected IMSFileParser.ResourceHelper	resourceHelper
protected Map<String,Node>	resourceMap
protected Map<String,org.sakaiproject.importer.api.IMSResourceTranslator>	translatorMap

Fields inherited from class org.sakaiproject.importer.impl.ZipFileParser

localArchiveLocation, mimeTypes, pathToData

Constructor Summary

Constructors

Constructor and Description
IMSFileParser()

Method Summary

Methods

Modifier and Type	Method and Description
void	addResourceTranslator(org.sakaiproject.importer.api.IMSResourceTranslator t)
protected void	awakeFromUnzip(String pathToData)
protected abstract Collection	getCategoriesFromArchive(String pathToData)
protected abstract org.sakaiproject.importer.api.Importable	getCompanionForCompoundDocument(Document resourceForId, Folder folder)
protected String	getDescriptionForNode(Node node)
protected Collection	getImportableItemsFromArchive(String pathToData)
protected String	getTitleForNode(Node node)
protected abstract boolean	isCompoundDocument(Node node, Document resourceDescriptor)
boolean	isValidArchive(InputStream fileData)
void	setTranslatorMap(Map translatorMap)
protected Collection	translateFromNodeToImportables(Node node, String contextPath, int priority, org.sakaiproject.importer.api.Importable parent)
protected abstract boolean	wantsCompanionForCompoundDocument()

Methods inherited from class org.sakaiproject.importer.impl.ZipFileParser

extractFileAsDOM, fileExistsInArchive, getBytesFromFile, parse, unzipArchive

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sakaiproject.importer.api.ImportFileParser

newParser

Field Detail

resourceMap

protected Map<String,Node> resourceMap

translatorMap

protected Map<String,org.sakaiproject.importer.api.IMSResourceTranslator> translatorMap

dependencies

protected Map dependencies

archiveManifest

protected Document archiveManifest

resourceHelper

protected IMSFileParser.ResourceHelper resourceHelper

itemHelper

protected IMSFileParser.ItemHelper itemHelper

fileHelper

protected IMSFileParser.FileHelper fileHelper

manifestHelper

protected IMSFileParser.ManifestHelper manifestHelper

Constructor Detail

IMSFileParser

public IMSFileParser()

Method Detail

awakeFromUnzip

protected void awakeFromUnzip(String pathToData)

Specified by:

awakeFromUnzip in class ZipFileParser

setTranslatorMap

public void setTranslatorMap(Map translatorMap)

isValidArchive

public boolean isValidArchive(InputStream fileData)

Specified by:

isValidArchive in interface org.sakaiproject.importer.api.ImportFileParser

Overrides:

isValidArchive in class ZipFileParser

getCategoriesFromArchive

protected abstract Collection getCategoriesFromArchive(String pathToData)

Specified by:

getCategoriesFromArchive in class ZipFileParser

getImportableItemsFromArchive

protected Collection getImportableItemsFromArchive(String pathToData)

Specified by:

getImportableItemsFromArchive in class ZipFileParser

translateFromNodeToImportables

protected Collection translateFromNodeToImportables(Node node,
                                        String contextPath,
                                        int priority,
                                        org.sakaiproject.importer.api.Importable parent)

getCompanionForCompoundDocument

protected abstract org.sakaiproject.importer.api.Importable getCompanionForCompoundDocument(Document resourceForId,
                                                                       Folder folder)

wantsCompanionForCompoundDocument

protected abstract boolean wantsCompanionForCompoundDocument()

getTitleForNode

protected String getTitleForNode(Node node)

getDescriptionForNode

protected String getDescriptionForNode(Node node)

isCompoundDocument

protected abstract boolean isCompoundDocument(Node node,
                         Document resourceDescriptor)

addResourceTranslator

public void addResourceTranslator(org.sakaiproject.importer.api.IMSResourceTranslator t)