Package wt.ixb.publicforhandlers

Class AttributeExporterImporterTemplate

java.lang.Object

wt.ixb.publicforhandlers.AttributeExporterImporterTemplate

All Implemented Interfaces:

AttributeExporterImporter

Direct Known Subclasses:

wt.ixb.handlers.forattributes._ExpImpForContentAttr, wt.access.ixb.handlers.forattributes._ExpImpForSecurityLabelsAttr, wt.ixb.handlers.forclasses.attr._ExpImpForWTDocumentDependencyLinkAttr, wt.ixb.handlers.forclasses.attr._ExpImpForWTDocumentUsageLinkAttr

public abstract class AttributeExporterImporterTemplate
extends Object
implements AttributeExporterImporter

General template for attribute handlers which defines trivial implementation.
It defines some abstract methods that individual attribute handlers must implement.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
void	checkConflictForAttribute(Object existingOb, IxbElement fileXML, Importer importer)	Checks conflicts that can arise while import process for the given attribute and object.
void	exportAttribute(Object ob, IxbElement fileXML, Exporter exporter)	Supported API: true
void	finalizeCheckConflicts(Importer importer)	Called in the end of conflict check process.
void	finalizeExport(Exporter exporter)	This method will be called by the application handler after all objects have been exported.
void	finalizeImport(Importer importer)	Called in the end of the whole ipport process to execute any import process finalization.
Object	importAttribute(Object ob, IxbElement fileXML, Importer importer)	Supported API: true
void	prepareForCheckConflicts(List<IxbElement> ixbElementLst, Importer importer)	Called in the beginning of conflict check process prior to the real import or preview.
void	prepareForImport(List<IxbElement> ixbElementLst, Importer importer)	Called in the end of conflict check process and prior to the real import process.

Methods inherited from class java.lang.Object

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

Method Details

exportAttribute

public void exportAttribute(Object ob,
 IxbElement fileXML,
 Exporter exporter)
                     throws WTException

Supported API: true

Specified by:

exportAttribute in interface AttributeExporterImporter

Parameters:

ob -

fileXML -

exporter -

Throws:

WTException

importAttribute

public Object importAttribute(Object ob,
 IxbElement fileXML,
 Importer importer)
                       throws WTException

Supported API: true

Specified by:

importAttribute in interface AttributeExporterImporter

Parameters:

ob -

fileXML -

importer -

Returns:

Object

Throws:

WTException

finalizeExport

public void finalizeExport(Exporter exporter)
                    throws WTException

This method will be called by the application handler after all objects have been exported.

Supported API: true

Specified by:

finalizeExport in interface AttributeExporterImporter

Parameters:

exporter - The Exporter instance that represents the context of the export operation.

Throws:

WTException

prepareForCheckConflicts

public void prepareForCheckConflicts(List<IxbElement> ixbElementLst,
 Importer importer)
                              throws WTException

Called in the beginning of conflict check process prior to the real import or preview.

Supported API: true

Specified by:

prepareForCheckConflicts in interface AttributeExporterImporter

Parameters:

ixbElementLst - List of IxbElements

importer - The Importer instance that represents the context of the import operation

Throws:

WTException

checkConflictForAttribute

public void checkConflictForAttribute(Object existingOb,
 IxbElement fileXML,
 Importer importer)
                               throws WTException

Checks conflicts that can arise while import process for the given attribute and object.

Supported API: true

Specified by:

checkConflictForAttribute in interface AttributeExporterImporter

Parameters:

existingOb -

fileXML - the IxbElement of the XML file to be imported.

importer - The Importer instance that represents the context of the import operation.

Throws:

WTException

finalizeCheckConflicts

public void finalizeCheckConflicts(Importer importer)
                            throws WTException

Called in the end of conflict check process.

Supported API: true

Specified by:

finalizeCheckConflicts in interface AttributeExporterImporter

Parameters:

importer - The Importer instance that represents the context of the import operation.

Throws:

WTException

prepareForImport

public void prepareForImport(List<IxbElement> ixbElementLst,
 Importer importer)
                      throws WTException

Called in the end of conflict check process and prior to the real import process.

Supported API: true

Specified by:

prepareForImport in interface AttributeExporterImporter

Parameters:

ixbElementLst - The list of ixb documents which will be imported.

importer - The Importer instance that represents the context of the import operation.

Throws:

WTException

finalizeImport

public void finalizeImport(Importer importer)
                    throws WTException

Called in the end of the whole ipport process to execute any import process finalization.

Supported API: true

Specified by:

finalizeImport in interface AttributeExporterImporter

Parameters:

importer - The Importer instance that represents the context of the import operation.

Throws:

WTException