org.xiruss.repository.client.importers
Interface Importer

All Known Implementing Classes:
ImporterBase

public interface Importer


Method Summary
 void createBosOnSnapshot(BoundedObjectSet bos, Branch branch, MutableSnapshot snapshot)
          Given a fully-populated bounded object set, create a new snapshot with versions for each BOS member.
 Version doCompoundDocumentImport(java.io.File compoundDocRoot, Branch branch, MutableSnapshot snapshot, User user, java.lang.String cdMemberKey, java.lang.String cdMemberName, SourceToVersionMap so2verMap)
          Process in the input document to calculate its BOS, then create resources and initial versions for each BOS member.
 Version doCompoundDocumentImport(java.net.URL rootSoUrl, Branch branch, User user, java.lang.String docKey, java.lang.String docName, java.lang.Object object)
          Imports a compound document rooted at a URL-accessible location.
 

Method Detail

doCompoundDocumentImport

Version doCompoundDocumentImport(java.io.File compoundDocRoot,
                                 Branch branch,
                                 MutableSnapshot snapshot,
                                 User user,
                                 java.lang.String cdMemberKey,
                                 java.lang.String cdMemberName,
                                 SourceToVersionMap so2verMap)
                                 throws ImporterException,
                                        VersionCommitException,
                                        NoSuchPolicyTypeException,
                                        NoSuchDependencyTypeException,
                                        RepositoryException,
                                        VersionMutationException
Process in the input document to calculate its BOS, then create resources and initial versions for each BOS member. For each member, establish a dependency relationship from it to its child members.

Parameters:
compoundDocRoot - The file system file that is the root of a compound document to be imported.
branch - The SnapCM branch the compound document is to be imported onto.
user - The user who is performing the import. Will be set as the owner and creator of the all the newly-created resources, versions, and storage objects.
cdName - The name to use in the repository for the compound document.
Returns:
The version created as the root of the compound document.
Throws:
ImporterException
VersionCommitException
NoSuchPolicyTypeException
NoSuchDependencyTypeException
RepositoryException
VersionMutationException

createBosOnSnapshot

void createBosOnSnapshot(BoundedObjectSet bos,
                         Branch branch,
                         MutableSnapshot snapshot)
                         throws NoSuchPolicyTypeException,
                                NoSuchDependencyTypeException,
                                RepositoryException,
                                VersionMutationException,
                                DomException,
                                java.io.IOException,
                                ImporterException,
                                SnapCMException
Given a fully-populated bounded object set, create a new snapshot with versions for each BOS member. Then create dependency relationships among the BOS members reflecting the BOS tree.

Parameters:
bos - Bounded object set
branch - The branch to create the new snapshot on.
Throws:
VersionException
SnapshotException
NoSuchPolicyTypeException
NoSuchDependencyTypeException
RepositoryException
VersionMutationException
DomException
java.io.IOException
ImporterException
SnapCMException

doCompoundDocumentImport

Version doCompoundDocumentImport(java.net.URL rootSoUrl,
                                 Branch branch,
                                 User user,
                                 java.lang.String docKey,
                                 java.lang.String docName,
                                 java.lang.Object object)
Imports a compound document rooted at a URL-accessible location.

Parameters:
rootSoUrl -
branch -
user -
docKey -
docName -
object -
Returns: