atg.adapter.gsa.sqlimport

Interface ImportManifest

public interface ImportManifest

An object which is used to pass out information gathered by a parser from a repository import file.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
void	commitNewIds() Once import has finished this method can be called to commit any new ids created during the import.
void	flush() Flush any caches associated with this manifest
java.util.Collection<java.lang.String>	getAffectedItemDescriptors(java.lang.String pRepositoryPath) Get the names of the item descriptors which are affected by this import for the repositroy at the given path.
java.util.Collection<java.lang.String>	getAffectedRepositories() Get the Nucleus paths for repositories affected by the import
java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>	getAffectedRepositoryIDs(java.lang.String pRepositoryPath) Get the IDs of items in the given repository keyed by item descriptor names.
java.util.Collection<java.lang.String>	getAffectedRepositoryIDs(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName) Get the IDs of items in the given repository and item descriptor.
java.lang.String	getDefaultRepositoryPath() The path for the default repository for the import.
atg.adapter.gsa.sqlimport.IndependentImportUnit	getSQL(atg.adapter.gsa.sqlimport.ParsedRepositoryItem pParsedItem, atg.adapter.gsa.sqlimport.OperationType pOpType) Generate SQLs for the given parsed item.
int	getTotalOperationCount() Number of operations in this manifest
Workspace	getWorkspace() Get the mutable development line used for this import
void	reserveId(GSAItemDescriptor pGsaItemDescriptor, atg.repository.CompositeKey pNewId) Reserve the given id with the id generator of the give item descriptor
void	setWorkspace(Workspace pWorkspace) Set the mutable development line to be used for the import

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getAffectedRepositories

java.util.Collection<java.lang.String> getAffectedRepositories()

Get the Nucleus paths for repositories affected by the import

Returns:

a collection of Nucleus paths

getAffectedItemDescriptors

java.util.Collection<java.lang.String> getAffectedItemDescriptors(java.lang.String pRepositoryPath)

Get the names of the item descriptors which are affected by this import for the repositroy at the given path.

Parameters:

pRepositoryPath -

Returns:

getAffectedRepositoryIDs

java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getAffectedRepositoryIDs(java.lang.String pRepositoryPath)

Get the IDs of items in the given repository keyed by item descriptor names.

Parameters:

pRepositoryPath -

Returns:

collection of IDs without the asset_version

getAffectedRepositoryIDs

java.util.Collection<java.lang.String> getAffectedRepositoryIDs(java.lang.String pRepositoryPath,
                                                                java.lang.String pItemDescriptorName)

Get the IDs of items in the given repository and item descriptor.

Parameters:

pRepositoryPath -

pItemDescriptorName -

Returns:

collection of IDs without the asset_version

getDefaultRepositoryPath

java.lang.String getDefaultRepositoryPath()

The path for the default repository for the import.

Returns:

Could be null

getWorkspace

Workspace getWorkspace()

Get the mutable development line used for this import

Returns:

getTotalOperationCount

int getTotalOperationCount()

Number of operations in this manifest

Returns:

setWorkspace

void setWorkspace(Workspace pWorkspace)

Set the mutable development line to be used for the import

Parameters:

pWorkspace -

commitNewIds

void commitNewIds()
           throws atg.adapter.gsa.sqlimport.ImportException

Once import has finished this method can be called to commit any new ids created during the import.

Throws:

ImportException

reserveId

void reserveId(GSAItemDescriptor pGsaItemDescriptor,
               atg.repository.CompositeKey pNewId)
        throws atg.adapter.gsa.sqlimport.ImportException

Reserve the given id with the id generator of the give item descriptor

Parameters:

pGsaItemDescriptor -

pNewId -

Throws:

atg.adapter.gsa.sqlimport.ImportException

getSQL

atg.adapter.gsa.sqlimport.IndependentImportUnit getSQL(atg.adapter.gsa.sqlimport.ParsedRepositoryItem pParsedItem,
                                                       atg.adapter.gsa.sqlimport.OperationType pOpType)
                                                throws atg.adapter.gsa.sqlimport.ImportException

Generate SQLs for the given parsed item.

Parameters:

pParsedItem -

pOpType -

Returns:

Throws:

ImportException

flush

void flush()

Flush any caches associated with this manifest