wt.ixb.handlers.netmarkets
Class TemplateDocumentIXHandler

java.lang.Object
  wt.ixb.publicforhandlers.ClassExporterImporterTemplateGeneral
      wt.ixb.publicforhandlers.ClassExporterImporterTemplate
          wt.ixb.handlers.netmarkets.TemplateDocumentIXHandler

All Implemented Interfaces:

ClassExporter, ClassExporterImporter, ElementImporter

public class TemplateDocumentIXHandler

extends ClassExporterImporterTemplate

Nested Class Summary

Nested classes inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplate

ClassExporterImporterTemplate.ContentHolderCommitListener

Field Summary

private static String	_rb
private static Object[]	DEF_PARAMS
private static NMProjectConstants.TemplateDocInfo	docTags

Fields inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplate

Fields inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplateGeneral

CONFLICT_RESOURCE

Constructor Summary

TemplateDocumentIXHandler()

Method Summary

Object	createObject(IxbElement elem, Importer imp) Creates new instance of Windchill object.
void	exportObject(Object obj, Exporter exp) Exports the specified object in context given by parameter exporter.
static void	exportTemplateDocument(WTDocument doc, IxbElement elem, Exporter exp)
Object	finalizeImportObject(boolean isNew, Object obj, IxbElement elem, Importer imp) Some actions in the end of the import process.
int	getImportPriority() Return the import priority of the object type represented by this import handler.
static String	getLocalId(IxbElement topElem, Importer imp)
void	outputLog(Object obj, Importer imp) Output log for imported object.
Object	storeObject(Object obj, IxbElement elem, Importer imp) That is the general template how to store object.

Methods inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplate

createFileXMLOnExport, exportAttributes, findAmongExistingObjects, getRootTag, importElement, importObjectAttributes, importObjectAttributesAfterStore, isObjectIgnored, isObjectNew, rememberNewObInfo, setObjectIgnored, setObjectIsNew, storeAdditionalInfo, storeElement

Methods inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplateGeneral

checkConflicts, finalizeCheckConflicts, finalizeExport, finalizeImport, getAdditionalImportPriority, getObjectDisplayID, prepareForCheckConflicts, prepareForImport, previewElement

Methods inherited from class java.lang.Object

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

Field Detail

_rb

private static final String _rb

docTags

private static final NMProjectConstants.TemplateDocInfo docTags

DEF_PARAMS

private static Object[] DEF_PARAMS

Constructor Detail

TemplateDocumentIXHandler

public TemplateDocumentIXHandler()

Method Detail

exportObject

public void exportObject(Object obj,
                         Exporter exp)
                  throws WTException

Description copied from class: ClassExporterImporterTemplate

Exports the specified object in context given by parameter exporter.
The implementation of this method is partitioned into several protected methods. Individual class handlers can override the following protected methods:

• createFileXMLOnExport(Exporter exporter), which create an IxbDocument with the root tag. See getRootTag();
• exportAttributes (Object object, IxbElement fileXML, Exporter exporter) which will export the attributes according to the DTD. The parameter fileXML is the returned vlue from createFileXMLOnExport(Exporter exporter).
• storeElement(Object object, IxbElement fileXML, Exporter exporter) which will store the fileXML into an xml-file.

Also, export actions from either client or system registry will be performed. Specifically, the two methods wt.ixb.tuner.ExportActionHelper.performPreExportAction () and wt.ixb.tuner.ExportActionHelper.performPostExportAction () will be called before and after th above three protected methods, respectively.

Supported API: true

Specified by:

exportObject in interface ClassExporter

Overrides:

exportObject in class ClassExporterImporterTemplate

Parameters:

obj -

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

Throws:

WTException

exportTemplateDocument

public static void exportTemplateDocument(WTDocument doc,
                                          IxbElement elem,
                                          Exporter exp)
                                   throws WTException

Throws:

WTException

createObject

public Object createObject(IxbElement elem,
                           Importer imp)
                    throws WTException

Description copied from class: ClassExporterImporterTemplate

Creates new instance of Windchill object. Every class requires its own method to create object of this class. So, this method must be overriden by any class specific import handler

Supported API: true

Specified by:

createObject in class ClassExporterImporterTemplate

Parameters:

elem -

imp -

Returns:

Object

Throws:

WTException

getImportPriority

public int getImportPriority()
                      throws WTException

Description copied from class: ClassExporterImporterTemplateGeneral

Return the import priority of the object type represented by this import handler.
Import priority defines the order in which objects will be imported. This method does not carry parameters in the signature. The return value can not be negative. Those XML files will have a higher import priority for smaller returned values.

Supported API: true

Specified by:

getImportPriority in interface ElementImporter

Specified by:

getImportPriority in class ClassExporterImporterTemplateGeneral

Returns:

int

Throws:

WTException

outputLog

public void outputLog(Object obj,
                      Importer imp)
               throws WTException

Description copied from class: ClassExporterImporterTemplateGeneral

Output log for imported object.

Supported API: true

Specified by:

outputLog in interface ElementImporter

Overrides:

outputLog in class ClassExporterImporterTemplate

Throws:

WTException

finalizeImportObject

public Object finalizeImportObject(boolean isNew,
                                   Object obj,
                                   IxbElement elem,
                                   Importer imp)
                            throws WTException

Description copied from class: ClassExporterImporterTemplate

Some actions in the end of the import process. This method is called even if there were no real import - i.e. if existing object was found, that represents object to be imported

Supported API: true

Overrides:

finalizeImportObject in class ClassExporterImporterTemplate

Throws:

WTException

getLocalId

public static String getLocalId(IxbElement topElem,
                                Importer imp)
                         throws WTException

Throws:

WTException

storeObject

public Object storeObject(Object obj,
                          IxbElement elem,
                          Importer imp)
                   throws WTException

Description copied from class: ClassExporterImporterTemplate

That is the general template how to store object. It looks like it will be good for many classes. If for some class it is not good then it can be override this method

Supported API: true

Overrides:

storeObject in class ClassExporterImporterTemplate

Parameters:

obj -

elem -

imp -

Returns:

Object

Throws:

WTException